diff --git a/_includes/autoclick.md b/_includes/autoclick.md index e03335f2f1..00810276b9 100644 --- a/_includes/autoclick.md +++ b/_includes/autoclick.md @@ -222,7 +222,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/checkout-v3-resource-models.md b/_includes/checkout-v3-resource-models.md index 8f85121660..846f466a95 100644 --- a/_includes/checkout-v3-resource-models.md +++ b/_includes/checkout-v3-resource-models.md @@ -302,7 +302,7 @@ api-supported-versions: 3.0, 3.1 { "paymentorder": "/psp/paymentorders/5adc265f-f87f-4313-577e-08d3dca1a26c", - "postpurchaseFailedAttempts": { + "postPurchaseFailedAttempts": { "id": "/psp/paymentorders/5adc265f-f87f-4313-577e-08d3dca1a26c/postpurchasefailedattempts", "postpurchaseFailedAttemptList": [ { diff --git a/_includes/checkoutv3-purchase.md b/_includes/checkoutv3-purchase.md index e2cc242bca..e8c6806b56 100644 --- a/_includes/checkoutv3-purchase.md +++ b/_includes/checkoutv3-purchase.md @@ -163,7 +163,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -331,7 +331,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f payments %} | `string` | The URL to the `payments` resource where information about all underlying payments can be retrieved. | diff --git a/_includes/corporate-limited-menu.md b/_includes/corporate-limited-menu.md index 3d0026571a..6f319c7d8e 100644 --- a/_includes/corporate-limited-menu.md +++ b/_includes/corporate-limited-menu.md @@ -65,7 +65,7 @@ Content-Type: application/json | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | {% endcapture %} diff --git a/_includes/one-click-payments.md b/_includes/one-click-payments.md index a2012b74ac..18786a20f1 100644 --- a/_includes/one-click-payments.md +++ b/_includes/one-click-payments.md @@ -27,10 +27,10 @@ these details for every purchase." %} {% if documentation_section contains "checkout-v3" %} -For card and invoice payments, the payment flow and implementation varies from -your default only being the use of a `paymentToken`. The details in this section -describe explicitly the parameters that must be set to enable one-click -purchases. +For card, Trustly and invoice payments, the payment flow and implementation +varies from your default only being the use of a `paymentToken`. The details in +this section describe explicitly the parameters that must be set to enable +one-click purchases. {% else %} @@ -108,7 +108,9 @@ payment resource with the `payerReference` included. ```http GET /psp/paymentorders/payerownedtokens/{{ page.payment_token }} HTTP/1.1 +Host: {{ page.api_host }} Authorization: Bearer +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 ``` You can also perform a GET request towards the `id` of a Payment Order and find @@ -119,7 +121,9 @@ the paymentToken in its linked [`paid` resource][paid-resource]. ```http GET /psp/paymentorders/{{ page.payment_id }}/paid HTTP/1.1 +Host: {{ page.api_host }} Authorization: Bearer +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 ``` {% endif %} @@ -197,12 +201,11 @@ generated by Swedbank Pay, but a reference set by you to identify your customer and their returning payments. An example could be to use internal customer numbers. -Using `payerReference` and `generatePaymentToken: true` will display all (max 3) -cards connected to the payerReference. - -If you wish to display one specific card only, you can remove -`generatePaymentToken` and add the field `paymentToken` in it's place. This must -be the paymentToken generated in the initial purchase. +For card payments, using `payerReference` and `generatePaymentToken: true` will +display all (max 3) cards connected to the payerReference. If you wish to +display one specific card only, you can remove `generatePaymentToken` and add +the field `paymentToken` in it's place. This must be the paymentToken generated +in the initial purchase. {% if documentation_section contains "payment-instruments" %} @@ -272,7 +275,7 @@ Content-Type: application/json POST {{ purchase_url }} HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 { "paymentorder": { @@ -294,7 +297,7 @@ Content-Type: application/json POST {{ purchase_url }} HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 { "paymentorder": { @@ -382,7 +385,7 @@ should look like this: PATCH /psp/paymentorders/payerownedtokens/ HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 { "state": "Deleted", @@ -402,7 +405,8 @@ TODO: Remove pipes from the above code example and add a field table ```http HTTP/1.1 200 OK -Content-Type: application/json +Content-Type: application/json; charset=utf-8; version=3.1/3.0/2.0 +api-supported-versions: 2.0, 3.0, 3.1 { "payerOwnedTokens": { @@ -442,8 +446,9 @@ Content-Type: application/json {% if documentation_section contains "checkout" %} For single token deletions, the request and response should look like this. In -this example, the token is connected to a card. If it was a token connected to -an invoice, the `instrumentDisplayName` would be the payer's date of birth. +this example, the token is connected to a card. If the token is connected to +an invoice, the `instrumentDisplayName` will be the payer's date of birth. For +Trustly transactions, it will be a masked account number. ## Delete Single Token Request For Checkout Integrations @@ -454,7 +459,7 @@ an invoice, the `instrumentDisplayName` would be the payer's date of birth. PATCH /psp/paymentorders/paymenttokens/{{ page.payment_token }} HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 { "state": "Deleted", @@ -469,7 +474,8 @@ Content-Type: application/json ```http HTTP/1.1 200 OK -Content-Type: application/json +Content-Type: application/json; charset=utf-8; version=3.1 +api-supported-versions: 2.0, 3.0, 3.1 { "paymentToken": "{{paymentToken}}", @@ -543,4 +549,4 @@ Content-Type: application/json [create-card-payment]: /old-implementations/payment-instruments-v1/card/features/technical-reference/create-payment [create-invoice-payment]: /old-implementations/payment-instruments-v1/invoice/features/technical-reference/create-payment [paid-resource]: /checkout-v3/features/technical-reference/status-models#paid -[verify]: /old-implementations/payment-instruments-v1/card/features/optional/verify +[verify]: /checkout-v3/features/optional/verify diff --git a/_includes/payer-aware-payment-menu.md b/_includes/payer-aware-payment-menu.md index 2e863c1c6f..a8823b0d33 100644 --- a/_includes/payer-aware-payment-menu.md +++ b/_includes/payer-aware-payment-menu.md @@ -240,7 +240,7 @@ CContent-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | The `payeeInfo` object, containing information about the payee. | +| {% icon check %} | {% f payeeInfo %} | `object` | The `payeeInfo` object, containing information about the payee. | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md documentation_section=include.documentation_section describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/payment-order-3-1.md b/_includes/payment-order-3-1.md index 620ae22a5f..f5fa7cab6c 100644 --- a/_includes/payment-order-3-1.md +++ b/_includes/payment-order-3-1.md @@ -62,23 +62,7 @@ Content-Type: application/json;version=3.1 | {% icon check %} | {% f cancelUrl, 2 %} | `string` | The URL to redirect the payer to if the payment is cancelled, either by the payer or by the merchant trough an `abort` request of the `payment` or `paymentorder`. | | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | -| {% icon check %} | {% f orderItems %} | `array` | {% include fields/order-items.md %} | -| {% icon check %} | {% f reference, 2 %} | `string` | A reference that identifies the order item. | -| {% icon check %} | {% f name, 2 %} | `string` | The name of the order item. | -| {% icon check %} | {% f type, 2 %} | `enum` | `PRODUCT`, `SERVICE`, `SHIPPING_FEE`, `DISCOUNT`, `VALUE_CODE`, or `OTHER`. The type of the order item. | -| {% icon check %} | {% f class, 2 %} | `string` | The classification of the order item. Can be used for assigning the order item to a specific product category, such as `MobilePhone`. Note that `class` cannot contain spaces and must follow the regex pattern `[\w-]*`. Swedbank Pay may use this field for statistics. | -| | {% f itemUrl, 2 %} | `string` | The URL to a page that can display the purchased item, such as a product page | -| | {% f imageUrl, 2 %} | `string` | The URL to an image of the order item. | -| | {% f description, 2 %} | `string` | The human readable description of the order item. | -| | {% f discountDescription, 2 %}| `string` | The human readable description of the possible discount. | -| {% icon check %} | {% f quantity, 2 %} | `number` | The 4 decimal precision quantity of order items being purchased. | -| {% icon check %} | {% f quantityUnit, 2 %} | `string` | The unit of the quantity, such as `pcs`, `grams`, or similar. | -| {% icon check %} | {% f unitPrice, 2 %} | `integer` | The price per unit of order item, including VAT. | -| | {% f discountPrice, 2 %} | `integer` | If the order item is purchased at a discounted price. This field should contain that price, including VAT. | -| {% icon check %} | {% f vatPercent, 2 %} | `integer` | The percent value of the VAT multiplied by 100, so `25%` becomes `2500`. | -| {% icon check %} | {% f amount, 2 %} | `integer` | {% include fields/amount.md %} | -| {% icon check %} | {% f vatAmount, 2 %} | `integer` | {% include fields/vat-amount.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -217,7 +201,7 @@ api-supported-versions: 2.0, 3.0, 3.1 | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the [`history` resource]({{ features_url }}/technical-reference/resource-sub-models#history) where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the [`failed` resource]({{ features_url }}/technical-reference/resource-sub-models#failed) where information about the failed transactions can be retrieved. | @@ -227,7 +211,7 @@ api-supported-versions: 2.0, 3.0, 3.1 | {% f reversed %} | `string` | The URL to the `reversed` resource where information about the reversed transactions can be retrieved. | | {% f financialTransactions %} | `string` | The URL to the [`financialTransactions` resource]({{ features_url }}/technical-reference/resource-sub-models#financialtransactions) where information about the financial transactions can be retrieved. | | {% f failedAttempts %} | `string` | The URL to the [`failedAttempts` resource]({{ features_url }}/technical-reference/resource-sub-models#failedattempts) where information about the failed attempts can be retrieved. | -| {% f postpurchaseFailedAttempts %} | `string` | The URL to the `postpurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | +| {% f postPurchaseFailedAttempts %} | `string` | The URL to the `postPurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | | {% f metadata %} | `string` | The URL to the `metadata` resource where information about the metadata can be retrieved. | | {% f operations %} | `array` | {% include fields/operations.md %} | {% endcapture %} diff --git a/_includes/payment-order-abort.md b/_includes/payment-order-abort.md index 9b0df1492a..205c7bb471 100644 --- a/_includes/payment-order-abort.md +++ b/_includes/payment-order-abort.md @@ -174,7 +174,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f guestMode %} | `bool` | {% include fields/guest-mode.md %} | | {% f orderItems %} | `string` | {% include fields/order-items.md %} | | {% f urls %} | `string` | The URL to the `urls` resource where information about the urls can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | {% include fields/payer.md %} | | {% f history %} | `string` | {% include fields/history.md %} | | {% f failed %} | `string` | {% include fields/failed.md %} | diff --git a/_includes/payment-order-afd.md b/_includes/payment-order-afd.md index 6f1106f6d6..b0a4125a17 100644 --- a/_includes/payment-order-afd.md +++ b/_includes/payment-order-afd.md @@ -78,7 +78,7 @@ seamless view table: | :----------------------- | :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | {% f generateAfdPayment %} | `bool` | Set to `true` if the payment order is an AFD payment, `false` if not. | | {% f restrictedToAfdInstruments %} | `bool` | Set to `true` if the payment menu should show only payment options that support AFD, `false` to show all options. Default is true when using `generateAfdPayment`. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f mcc, 2 %} | `integer` | The merchant category code used for the purchase, 4 digits. | {% if include.integration_mode=="redirect" %} diff --git a/_includes/payment-order-cancel-3-1.md b/_includes/payment-order-cancel-3-1.md index b1fbd5bd7d..d8ec97ceae 100644 --- a/_includes/payment-order-cancel-3-1.md +++ b/_includes/payment-order-cancel-3-1.md @@ -115,7 +115,7 @@ api-supported-versions: 3.1 "failedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/failedattempts" }, - "postpurchaseFailedAttempts": { + "postPurchaseFailedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/postpurchasefailedattempts" }, "metadata": { @@ -153,7 +153,7 @@ api-supported-versions: 3.1 | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the `history` resource where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the `failed` resource where information about the failed transactions can be retrieved. | @@ -162,7 +162,7 @@ api-supported-versions: 3.1 | {% f cancelled %} | `string` | The URL to the `cancelled` resource where information about the cancelled transactions can be retrieved. | | {% f financialTransactions %} | `string` | The URL to the `financialTransactions` resource where information about the financial transactions can be retrieved. | | {% f failedAttempts %} | `string` | The URL to the `failedAttempts` resource where information about the failed attempts can be retrieved. | -| {% f postpurchaseFailedAttempts %} | `string` | The URL to the `postpurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | +| {% f postPurchaseFailedAttempts %} | `string` | The URL to the `postPurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | | {% f metadata %} | `string` | The URL to the `metadata` resource where information about the metadata can be retrieved. | | {% f operations %} | `array` | {% include fields/operations.md %} [See Operations for details]({{ features_url }}/technical-reference/operations). | {% endcapture %} diff --git a/_includes/payment-order-capture-3-1.md b/_includes/payment-order-capture-3-1.md index d0168719dc..135a23b29f 100644 --- a/_includes/payment-order-capture-3-1.md +++ b/_includes/payment-order-capture-3-1.md @@ -158,7 +158,7 @@ api-supported-versions: 3.1 "failedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/failedattempts" }, - "postpurchaseFailedAttempts": { + "postPurchaseFailedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/postpurchasefailedattempts" }, "metadata": { @@ -202,7 +202,7 @@ api-supported-versions: 3.1 | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the `history` resource where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the `failed` resource where information about the failed transactions can be retrieved. | @@ -211,7 +211,7 @@ api-supported-versions: 3.1 | {% f cancelled %} | `string` | The URL to the `cancelled` resource where information about the cancelled transactions can be retrieved. | | {% f financialTransactions %} | `string` | The URL to the `financialTransactions` resource where information about the financial transactions can be retrieved. | | {% f failedAttempts %} | `string` | The URL to the `failedAttempts` resource where information about the failed attempts can be retrieved. | -| {% f postpurchaseFailedAttempts %} | `string` | The URL to the `postpurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | +| {% f postPurchaseFailedAttempts %} | `string` | The URL to the `postPurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | | {% f metadata %} | `string` | The URL to the `metadata` resource where information about the metadata can be retrieved. | | {% f operations %} | `array` | {% include fields/operations.md %} [See Operations for details]({{ features_url }}/technical-reference/operations). | {% endcapture %} diff --git a/_includes/payment-order-checkout-enterprise.md b/_includes/payment-order-checkout-enterprise.md index 48388627e4..097560ef65 100644 --- a/_includes/payment-order-checkout-enterprise.md +++ b/_includes/payment-order-checkout-enterprise.md @@ -146,7 +146,7 @@ Content-Type: application/json | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/payment-order-checkout-payments-only.md b/_includes/payment-order-checkout-payments-only.md index f37eb06c2f..204c730e97 100644 --- a/_includes/payment-order-checkout-payments-only.md +++ b/_includes/payment-order-checkout-payments-only.md @@ -81,7 +81,7 @@ Content-Type: application/json;version=3.0 // Version optional | {% icon check %} | {% f vatPercent, 2 %} | `integer` | The percent value of the VAT multiplied by 100, so `25%` becomes `2500`. | | {% icon check %} | {% f amount, 2 %} | `integer` | {% include fields/amount.md %} | | {% icon check %} | {% f vatAmount, 2 %} | `integer` | {% include fields/vat-amount.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/payment-order-get.md b/_includes/payment-order-get.md index 3775f17587..6ec19c5d39 100644 --- a/_includes/payment-order-get.md +++ b/_includes/payment-order-get.md @@ -114,7 +114,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f nonPaymentToken %} | `string` | The result of our own card tokenization. Activated in POS for the merchant or merchant group. | | {% f externalNonPaymentToken %} | `string` | The result of an external tokenization. This value will vary depending on card types, acquirers, customers, etc. For Mass Transit merchants, transactions redeemed by Visa will be populated with PAR. For Mastercard and Amex, it will be our own token. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where information about the payer can be retrieved. | | {% f orderItems %} | `string` | {% include fields/metadata.md %} | | {% f metadata %} | `string` | The URL to the `payments` resource where information about all underlying payments can be retrieved. | diff --git a/_includes/payment-order-purchase.md b/_includes/payment-order-purchase.md index c7a7bd2f7c..24e2454e6e 100644 --- a/_includes/payment-order-purchase.md +++ b/_includes/payment-order-purchase.md @@ -205,7 +205,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -261,7 +261,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where information about the payer can be retrieved. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f metadata %} | `string` | {% include fields/metadata.md %} | diff --git a/_includes/payment-order-recur.md b/_includes/payment-order-recur.md index cdc0f2359d..22967d1335 100644 --- a/_includes/payment-order-recur.md +++ b/_includes/payment-order-recur.md @@ -170,7 +170,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -534,7 +534,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | | {% f implementation %} | `string` | Indicates which implementation to use. | {% endif %} | {% icon check %} | {% f urls, 2 %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f receiptReference %} | `string(30)` | {% include fields/receipt-reference.md %} | diff --git a/_includes/payment-order-reversal-3-1.md b/_includes/payment-order-reversal-3-1.md index a2d55e6f9a..1655434389 100644 --- a/_includes/payment-order-reversal-3-1.md +++ b/_includes/payment-order-reversal-3-1.md @@ -145,7 +145,7 @@ api-supported-versions: 3.1 "failedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/failedattempts" }, - "postpurchaseFailedAttempts": { + "postPurchaseFailedAttempts": { "id": "/psp/paymentorders/8be318c1-1caa-4db1-e2c6-08d7bf41224d/postpurchasefailedattempts" }, "metadata": { @@ -183,7 +183,7 @@ api-supported-versions: 3.1 | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the `history` resource where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the `failed` resource where information about the failed transactions can be retrieved. | @@ -192,7 +192,7 @@ api-supported-versions: 3.1 | {% f cancelled %} | `string` | The URL to the `cancelled` resource where information about the cancelled transactions can be retrieved. | | {% f financialTransactions %} | `string` | The URL to the `financialTransactions` resource where information about the financial transactions can be retrieved. | | {% f failedAttempts %} | `string` | The URL to the `failedAttempts` resource where information about the failed attempts can be retrieved. | -| {% f postpurchaseFailedAttempts %} | `string` | The URL to the `postpurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | +| {% f postPurchaseFailedAttempts %} | `string` | The URL to the `postPurchaseFailedAttempts` resource where information about the failed capture, cancel or reversal attempts can be retrieved. | | {% f metadata %} | `string` | The URL to the `metadata` resource where information about the metadata can be retrieved. | | {% f operations %} | `array` | {% include fields/operations.md %} [See Operations for details]({{ features_url }}/technical-reference/operations). | {% endcapture %} diff --git a/_includes/payment-order-unscheduled.md b/_includes/payment-order-unscheduled.md index ba2de78f46..5448c7071c 100644 --- a/_includes/payment-order-unscheduled.md +++ b/_includes/payment-order-unscheduled.md @@ -177,7 +177,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -530,7 +530,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | | {% f implementation %} | `string` | Indicates which implementation to use. | | {% icon check %} | {% f urls, 2 %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f receiptReference %} | `string(30)` | {% include fields/receipt-reference.md %} | diff --git a/_includes/payment-resource.md b/_includes/payment-resource.md index af430a5fb6..62e3f750e3 100644 --- a/_includes/payment-resource.md +++ b/_includes/payment-resource.md @@ -134,7 +134,7 @@ Content-Type: application/json | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/_includes/payout.md b/_includes/payout.md index 40382e7d6e..364b802667 100644 --- a/_includes/payout.md +++ b/_includes/payout.md @@ -181,7 +181,7 @@ Content-Type: application/json | {% icon check %} | {% f hostUrls, 2 %} | `array` | The array of URLs valid for embedding of Swedbank Pay Seamless Views. Not needed to implement the Swedbank Pay redirect flow. | | {% icon check %} | {% f completeUrl, 2 %} | `string` | {% include fields/complete-url.md %} | | {% icon check %} | {% f cancelUrl, 2 %} | `string` | The URL to redirect the payer to if the payment is cancelled, either by the payer or by the merchant trough an `abort` request of the `payment` or `paymentorder`. | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -327,7 +327,7 @@ Content-Type: application/json | {% f instrumentMode %} | `bool` | Set to `true` or `false`. Indicates if the payment is initialized with only one payment instrument available. | | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the [`history` resource]({{ features_url }}/technical-reference/resource-sub-models#history) where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the [`failed` resource]({{ features_url }}/technical-reference/resource-sub-models#failed) where information about the failed transactions can be retrieved. | @@ -476,7 +476,7 @@ Content-Type: application/json | {% f instrumentMode %} | `bool` | Set to `true` or `false`. Indicates if the payment is initialized with only one payment instrument available. | | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the [`history` resource]({{ features_url }}/technical-reference/resource-sub-models#history) where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the [`failed` resource]({{ features_url }}/technical-reference/resource-sub-models#failed) where information about the failed transactions can be retrieved. | @@ -540,7 +540,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f language %} | `string` | The language of the payer. | | {% icon check %} | {% f urls %} | `object` | The `urls` object, containing the URLs relevant for the payment order. | | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | @@ -636,7 +636,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f guestMode %} | `bool` | Set to `true` or `false`. Indicates if the payer chose to pay as a guest or not. When using the Payments Only implementation, this is triggered by not including a `payerReference` in the original `paymentOrder` request. | | {% f orderItems %} | `string` | The URL to the `orderItems` resource where information about the order items can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f history %} | `string` | The URL to the [`history` resource]({{ features_url }}/technical-reference/resource-sub-models#history) where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the [`failed` resource]({{ features_url }}/technical-reference/resource-sub-models#failed) where information about the failed transactions can be retrieved. | | {% f aborted %} | `string` | The URL to the [`aborted` resource]({{ features_url }}/technical-reference/resource-sub-models#aborted) where information about the aborted transactions can be retrieved. | @@ -758,7 +758,7 @@ Content-Type: application/json | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | | {% f id, 2 %} | `string` | {% include fields/id.md resource="paymentorder" %} | | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payer %} | `string` | The URL to the [`payer` resource]({{ features_url }}/technical-reference/resource-sub-models#payer) where information about the payer can be retrieved. | | {% f history %} | `string` | The URL to the [`history` resource]({{ features_url }}/technical-reference/resource-sub-models#history) where information about the payment's history can be retrieved. | | {% f failed %} | `string` | The URL to the [`failed` resource]({{ features_url }}/technical-reference/resource-sub-models#failed) where information about the failed transactions can be retrieved. | diff --git a/_includes/purchase.md b/_includes/purchase.md index 6aff54492e..6e67d60062 100644 --- a/_includes/purchase.md +++ b/_includes/purchase.md @@ -183,7 +183,7 @@ Content-Type: application/json | | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md resource="payment" %} | | | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | | | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md %} | | | {% f payeeName, 2 %} | `string` | The payee name (like merchant name) that will be displayed when redirected to Swedbank Pay. | @@ -338,7 +338,7 @@ Content-Type: application/json | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/_includes/recurring-card-payments.md b/_includes/recurring-card-payments.md index 7f719e0dc5..ea0a97c25a 100644 --- a/_includes/recurring-card-payments.md +++ b/_includes/recurring-card-payments.md @@ -115,7 +115,7 @@ Content-Type: application/json | {% icon check %} | {% f language, 2 %} | `string` | {% include fields/language.md %} | | {% icon check %} | {% f urls, 2 %} | `string` | The URL to the `urls` resource where all URLs related to the payment order can be retrieved. | | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f receiptReference %} | `string(30)` | {% include fields/receipt-reference.md %} | diff --git a/_includes/request-delivery-info.md b/_includes/request-delivery-info.md index 9da9d30c1c..883e96cef1 100644 --- a/_includes/request-delivery-info.md +++ b/_includes/request-delivery-info.md @@ -227,7 +227,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/tra.md b/_includes/tra.md index 03e35682cd..a775fa7fd9 100644 --- a/_includes/tra.md +++ b/_includes/tra.md @@ -183,7 +183,7 @@ Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for | {% icon check %} | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md %} | | {% icon check %} | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} |{% if include.integration_mode=="redirect" %}, | {% icon check %} | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} |{% endif %} -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | The ID of the payee, usually the merchant ID. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md describe_receipt=true %} | | | {% f payeeName, 2 %} | `string` | The name of the payee, usually the name of the merchant. | diff --git a/_includes/transaction-on-file.md b/_includes/transaction-on-file.md index 22f0cff946..58930beb36 100644 --- a/_includes/transaction-on-file.md +++ b/_includes/transaction-on-file.md @@ -59,7 +59,7 @@ Content-Type: application/json "userAgent": "Mozilla/5.0...", "language": "nb-NO", "generateTransactionOnFileToken": true, {% if documentation_section contains "checkout-v3" %} - "productName": "Checkout3", + "productName": "Checkout3", // Removed in 3.1, can be excluded in 3.0 if version is added in header "implementation": "{{implementation}}",{% endif %} "urls": { "hostUrls": ["https://example.com", "https://example.net"], diff --git a/_includes/transaction-response.md b/_includes/transaction-response.md index 8f5e977a53..c3a60ca408 100644 --- a/_includes/transaction-response.md +++ b/_includes/transaction-response.md @@ -28,7 +28,8 @@ The created `{{ transaction }}` resource contains information about the ```http HTTP/1.1 200 OK -Content-Type: application/json +Content-Type: application/json; charset=utf-8; version=3.1/3.0/2.0 +api-supported-versions: 3.1/3.0/2.0 { "paymentorder": "/psp/paymentorders/{{ page.payment_id }}", diff --git a/_includes/transaction.md b/_includes/transaction.md index 01985b2a69..5b81839974 100644 --- a/_includes/transaction.md +++ b/_includes/transaction.md @@ -34,7 +34,7 @@ When a transaction is created it will have one of three states: GET /psp/paymentorders/{{ page.payment_id }}/currentpayment HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 ``` {:.code-view-header} @@ -42,7 +42,8 @@ Content-Type: application/json ```http HTTP/1.1 200 OK -Content-Type: application/json +Content-Type: application/json; charset=utf-8; version=3.1/3.0/2.0 +api-supported-versions: 3.1/3.0/2.0 { "paymentorder": "/psp/paymentorders/{{ page.payment_id }}", diff --git a/_includes/transactions.md b/_includes/transactions.md index 4410c68ecc..69eefc686d 100644 --- a/_includes/transactions.md +++ b/_includes/transactions.md @@ -32,7 +32,7 @@ specific payment. GET /psp/paymentorders/{{ page.payment_id }}/currentpayment HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 ``` {% else %} diff --git a/_includes/unscheduled-purchase.md b/_includes/unscheduled-purchase.md index 4622fc0c72..e0181e1f1e 100644 --- a/_includes/unscheduled-purchase.md +++ b/_includes/unscheduled-purchase.md @@ -179,7 +179,7 @@ Content-Type: application/json | | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md resource="payment" %} | | | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | | | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md %} | | | {% f payeeName, 2 %} | `string` | The payee name (like merchant name) that will be displayed when redirected to Swedbank Pay. | @@ -346,7 +346,7 @@ Content-Type: application/json | {% f reversals %} | `string` | The URL to the `reversals` resource where the information about the payer can be retrieved. | | {% f cancellations %} | `string` | The URL to the `cancellations` resource where the information about the payer can be retrieved. | | {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f settings %} | `string` | The URL to the `settings` resource where the information about the payer can be retrieved. | @@ -470,7 +470,7 @@ Content-Type: application/json | | {% f callbackUrl, 2 %} | `string` | {% include fields/callback-url.md resource="payment" %} | | | {% f logoUrl, 2 %} | `string` | {% include fields/logo-url.md %} | | | {% f termsOfServiceUrl, 2 %} | `string` | {% include fields/terms-of-service-url.md %} | -| {% icon check %} | {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% icon check %} | {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% icon check %} | {% f payeeId, 2 %} | `string` | This is the unique id that identifies this payee (like merchant) set by Swedbank Pay. | | {% icon check %} | {% f payeeReference, 2 %} | `string` | {% include fields/payee-reference.md %} | | | {% f payeeName, 2 %} | `string` | The payee name (like merchant name) that will be displayed when redirected to Swedbank Pay. | diff --git a/_includes/update-payment-order.md b/_includes/update-payment-order.md index ec9995218f..15a4f9d72e 100644 --- a/_includes/update-payment-order.md +++ b/_includes/update-payment-order.md @@ -189,7 +189,7 @@ api-supported-versions: 3.1/3.0/2.0 | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/_includes/urls.md b/_includes/urls.md index 15046b43e9..3649dcd3ad 100644 --- a/_includes/urls.md +++ b/_includes/urls.md @@ -34,7 +34,7 @@ Request GET /psp/paymentorders/{{ page.payment_order_id }}/urls/ HTTP/1.1 Host: {{ page.api_host }} Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional for 3.0 and 2.0 ``` {:.code-view-header} diff --git a/_includes/use-case-subscriptions.md b/_includes/use-case-subscriptions.md index 416de657eb..25e8e59b4a 100644 --- a/_includes/use-case-subscriptions.md +++ b/_includes/use-case-subscriptions.md @@ -1,15 +1,18 @@ ## Supported Payment Instruments -Looking to get started with subscription services? They are supported through -Cards and Trustly (bank payments). +Looking to get started with subscription services? They are currently supported +in Digital Payments using these instruments: + +* Card payments +* Trustly payments ## Step 1: Create a Payment Order -To initiate subscription services, create a Payment Order with Swedbank Pay. +To initiate subscription services, create a payment order with Swedbank Pay. This can be done by making an initial purchase, storing user details along with -the transaction, or performing a "Verify" operation for account verification. -"Verify" is a zero-sum operation used solely for registering details for future +the transaction, or performing a `Verify` operation for account verification. +`Verify` is a zero-sum operation used solely for registering details for future use. ## Step 2: Choose Subscription Model and Token diff --git a/checkout-v3/index.md b/checkout-v3/index.md index f4bd81747b..ddf945c954 100644 --- a/checkout-v3/index.md +++ b/checkout-v3/index.md @@ -56,7 +56,7 @@ sensitive card info.
- + hiking diff --git a/checkout-v3/resources/fundamental-principles.md b/checkout-v3/resources/fundamental-principles.md index caa5e8523e..c15a058380 100644 --- a/checkout-v3/resources/fundamental-principles.md +++ b/checkout-v3/resources/fundamental-principles.md @@ -53,7 +53,7 @@ All requests against the API Platform should have a few common headers: ```http POST /some/resource HTTP/1.1 -Content-Type: application/json; charset=utf-8 +Content-Type: application/json;version=3.1/3.0/2.0 charset=utf-8 // Version optional except for 3.1 Authorization: "Bearer 123456781234123412341234567890AB" User-Agent: swedbankpay-sdk-dotnet/3.0.1 Accept: application/problem+json; q=1.0, application/json; q=0.9 @@ -141,7 +141,7 @@ field. ```http POST /psp/creditcard/payments HTTP/1.1 Authorization: Bearer -Content-Type: application/json +Content-Type: application/json;version=3.1/3.0/2.0 // Version optional except for 3.1 { "payment": { @@ -168,7 +168,8 @@ Content-Type: application/json ```http HTTP/1.1 200 OK -Content-Type: application/json +Content-Type: application/json; charset=utf-8; version=3.1/3.0/2.0 +api-supported-versions: 3.1/3.0/2.0 { "payment": { diff --git a/old-implementations/payment-instruments-v1/invoice/direct.md b/old-implementations/payment-instruments-v1/invoice/direct.md index 4397512aca..39158e9d1a 100644 --- a/old-implementations/payment-instruments-v1/invoice/direct.md +++ b/old-implementations/payment-instruments-v1/invoice/direct.md @@ -241,7 +241,7 @@ Content-Type: application/json | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/old-implementations/payment-instruments-v1/mobile-pay/redirect.md b/old-implementations/payment-instruments-v1/mobile-pay/redirect.md index da9329a319..244b737b3c 100644 --- a/old-implementations/payment-instruments-v1/mobile-pay/redirect.md +++ b/old-implementations/payment-instruments-v1/mobile-pay/redirect.md @@ -324,7 +324,7 @@ Content-Type: application/json | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md api_resource="mobile-pay" %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/old-implementations/payment-instruments-v1/swish/direct.md b/old-implementations/payment-instruments-v1/swish/direct.md index 66df5160ce..3a66f43731 100644 --- a/old-implementations/payment-instruments-v1/swish/direct.md +++ b/old-implementations/payment-instruments-v1/swish/direct.md @@ -389,8 +389,8 @@ Content-Type: application/json | {% f description %} | `string(40)` | {% include fields/description.md %} | | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | -| {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | The URL to the payeeinfo resource where the information about the payee of the payment can be retrieved. | +| {% f urls %} | `string` | The URL to the `urls` resource where all URLs related to the payment can be retrieved. | +| {% f payeeInfo %} | `string` | The URL to the `payeeinfo` resource where the information about the payee of the payment can be retrieved. | | {% f payers %} | `string` | The URL to the `payer` resource where the information about the payer can be retrieved. | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | diff --git a/old-implementations/payment-instruments-v1/vipps/redirect.md b/old-implementations/payment-instruments-v1/vipps/redirect.md index ca0c833fe8..40eec3752b 100644 --- a/old-implementations/payment-instruments-v1/vipps/redirect.md +++ b/old-implementations/payment-instruments-v1/vipps/redirect.md @@ -308,7 +308,7 @@ Content-Type: application/json | {% f userAgent %} | `string` | {% include fields/user-agent.md %} | | {% f language %} | `string` | {% include fields/language.md %} | | {% f urls %} | `string` | The URL to the urls resource where all URLs related to the payment can be retrieved. | -| {% f payeeInfo %} | `string` | {% include fields/payee-info.md %} | +| {% f payeeInfo %} | `object` | {% include fields/payee-info.md %} | | {% f operations, 0 %} | `array` | {% include fields/operations.md resource="payment" %} | | {% f method, 2 %} | `string` | The HTTP method to use when performing the operation. | | {% f href, 2 %} | `string` | The target URL to perform the operation against. |