jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f2f067f0935d237fcd6bd05ed81602722bdbc06e
adyen-postman/postman/CheckoutService-v53.json
AdyenAutomationBot 7b345e6bbb Update latest definitions files
2024-10-29 10:37:29 +00:00

4979 lines
286 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"info": {
"name": "Adyen Checkout API (v53)",
"description": {
"content": "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v53/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v53/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!",
"type": "text/markdown"
},
"version": "53",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Modifications",
"item": [
{
"name": "/cancels",
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).",
"item": [
{
"name": "Cancel a payment using your own reference",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentReference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cancels",
"host": [
"{{baseUrl}}"
],
"path": [
"cancels"
],
"variable": [
],
"query": [
]
},
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentReference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentReference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cancels",
"host": [
"{{baseUrl}}"
],
"path": [
"cancels"
],
"variable": [
],
"query": [
]
},
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel)."
}
}
]
}
]
},
{
"name": "/payments/:paymentPspReference/amountUpdates",
"description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).",
"item": [
{
"name": "Update the amount of an authorized payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n},\n \"reference\": \"YOUR_UNIQUE_REFERENCE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"amountUpdates"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment."
}
],
"query": [
]
},
"description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n},\n \"reference\": \"YOUR_UNIQUE_REFERENCE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/amountUpdates",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"amountUpdates"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment."
}
],
"query": [
]
},
"description": "Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount. For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases)."
}
}
]
}
]
},
{
"name": "/payments/:paymentPspReference/cancels",
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).",
"item": [
{
"name": "Cancel payment using a PSP reference",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/cancels",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"cancels"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. "
}
],
"query": [
]
},
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/cancels",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"cancels"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. "
}
],
"query": [
]
},
"description": "Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment but don't have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel)."
}
}
]
}
]
},
{
"name": "/payments/:paymentPspReference/captures",
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture).",
"item": [
{
"name": "Capture an authorized payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
}
]
},
{
"name": "Capture and split an authorized payment between balance accounts",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"amount\": {\n \"value\": 1500\n},\n \"type\": \"BalanceAccount\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the sale amount\",\n \"description\": \"Your description for the sale amount\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"type\": \"Commission\",\n \"reference\": \"Your reference for the commission\",\n \"description\": \"Your description for the commission\"\n}, {\n \"type\": \"PaymentFee\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the fees\",\n \"description\": \"Your description for the fees\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"amount\": {\n \"value\": 1500\n},\n \"type\": \"BalanceAccount\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the sale amount\",\n \"description\": \"Your description for the sale amount\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"type\": \"Commission\",\n \"reference\": \"Your reference for the commission\",\n \"description\": \"Your description for the commission\"\n}, {\n \"type\": \"PaymentFee\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the fees\",\n \"description\": \"Your description for the fees\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"amount\": {\n \"value\": 1500\n},\n \"type\": \"BalanceAccount\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the sale amount\",\n \"description\": \"Your description for the sale amount\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"type\": \"Commission\",\n \"reference\": \"Your reference for the commission\",\n \"description\": \"Your description for the commission\"\n}, {\n \"type\": \"PaymentFee\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the fees\",\n \"description\": \"Your description for the fees\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
}
]
},
{
"name": "Capture and split an authorized payment in the Classic Platforms integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"account\": \"8816080397613514\",\n \"amount\": {\n \"value\": 1500\n},\n \"reference\": \"Your reference for the sale amount.\",\n \"type\": \"MarketPlace\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"reference\": \"Your reference for the commission.\",\n \"type\": \"Commission\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"account\": \"8816080397613514\",\n \"amount\": {\n \"value\": 1500\n},\n \"reference\": \"Your reference for the sale amount.\",\n \"type\": \"MarketPlace\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"reference\": \"Your reference for the commission.\",\n \"type\": \"Commission\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"USD\"\n},\n \"splits\": [{\n \"account\": \"8816080397613514\",\n \"amount\": {\n \"value\": 1500\n},\n \"reference\": \"Your reference for the sale amount.\",\n \"type\": \"MarketPlace\"\n}, {\n \"amount\": {\n \"value\": 500\n},\n \"reference\": \"Your reference for the commission.\",\n \"type\": \"Commission\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/captures",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"captures"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture."
}
],
"query": [
]
},
"description": " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification). You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
}
}
]
}
]
},
{
"name": "/payments/:paymentPspReference/refunds",
"description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).",
"item": [
{
"name": "Refund a payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n},\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"refunds"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund."
}
],
"query": [
]
},
"description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n},\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"refunds"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund."
}
],
"query": [
]
},
"description": "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)."
}
}
]
}
]
},
{
"name": "/payments/:paymentPspReference/reversals",
"description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).",
"item": [
{
"name": "Reverse (cancel or refund) a payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/reversals",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"reversals"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. "
}
],
"query": [
]
},
"description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal)."
}
,"response": [
{"name": "Created - the request has been fulfilled and has resulted in one or more new resources being created.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"paymentPspReference\": \"993617894903480A\",\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"pspReference\": \"993617894906488A\",\n \"status\": \"received\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_UNIQUE_REFERENCE\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/:paymentPspReference/reversals",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":paymentPspReference",
"reversals"
],
"variable": [
{
"key": "paymentPspReference",
"value": "",
"description": "The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. "
}
],
"query": [
]
},
"description": "[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). The reversed amount is always the full payment amount. > Do not use this request for payments that involve multiple partial captures. For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal)."
}
}
]
}
]
}
]
},
{
"name": "Orders",
"item": [
{
"name": "/orders",
"description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.",
"item": [
{
"name": "Create an order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_ORDER_REFERENCE\",\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"EUR\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/orders",
"host": [
"{{baseUrl}}"
],
"path": [
"orders"
],
"variable": [
],
"query": [
]
},
"description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"pspReference\": \"8616178914061985\",\n \"resultCode\": \"Success\",\n \"expiresAt\": \"2021-04-09T14:16:46Z\",\n \"orderData\": \"Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA==\",\n \"reference\": \"shopper-reference-ekvL83\",\n \"remainingAmount\": {\n \"currency\": \"EUR\",\n \"value\": 2500\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"YOUR_ORDER_REFERENCE\",\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"EUR\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/orders",
"host": [
"{{baseUrl}}"
],
"path": [
"orders"
],
"variable": [
],
"query": [
]
},
"description": "Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods."
}
}
]
}
]
},
{
"name": "/orders/cancel",
"description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.",
"item": [
{
"name": "Cancel an order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"order\": {\n \"pspReference\": \"8815517812932012\",\n \"orderData\": \"823fh892f8f18f4...148f13f9f3f\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/orders/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"cancel"
],
"variable": [
],
"query": [
]
},
"description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"pspReference\": \"8816178914079738\",\n \"resultCode\": \"Received\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"order\": {\n \"pspReference\": \"8815517812932012\",\n \"orderData\": \"823fh892f8f18f4...148f13f9f3f\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/orders/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"orders",
"cancel"
],
"variable": [
],
"query": [
]
},
"description": "Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method."
}
}
]
}
]
},
{
"name": "/paymentMethods/balance",
"description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.",
"item": [
{
"name": "Get gift card balance specifying amount of 10 EUR",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods/balance",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods",
"balance"
],
"variable": [
],
"query": [
]
},
"description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"pspReference\": \"KHQC5N7G84BLNK43\",\n \"resultCode\": \"Success\",\n \"balance\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods/balance",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods",
"balance"
],
"variable": [
],
"query": [
]
},
"description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object."
}
}
]
},
{
"name": "Get gift card balance specifying amount of 100 EUR",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 10000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods/balance",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods",
"balance"
],
"variable": [
],
"query": [
]
},
"description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"pspReference\": \"FKSPNCQ8HXSKGK82\",\n \"resultCode\": \"NotEnoughBalance\",\n \"balance\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 10000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods/balance",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods",
"balance"
],
"variable": [
],
"query": [
]
},
"description": "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object."
}
}
]
}
]
}
]
},
{
"name": "Utility",
"item": [
{
"name": "/applePay/sessions",
"description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).",
"item": [
{
"name": "Get payment session for Apple Pay",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"YOUR_MERCHANT_NAME\",\n \"domainName\": \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\": \"YOUR_MERCHANT_ID\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/applePay/sessions",
"host": [
"{{baseUrl}}"
],
"path": [
"applePay",
"sessions"
],
"variable": [
],
"query": [
]
},
"description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"data\": \"eyJ2Z...\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"YOUR_MERCHANT_NAME\",\n \"domainName\": \"YOUR_DOMAIN_NAME\",\n \"merchantIdentifier\": \"YOUR_MERCHANT_ID\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/applePay/sessions",
"host": [
"{{baseUrl}}"
],
"path": [
"applePay",
"sessions"
],
"variable": [
],
"query": [
]
},
"description": "You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation)."
}
}
]
}
]
},
{
"name": "/originKeys",
"description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. ",
"item": [
{
"name": "Get origin keys",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"originDomains\": [\"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/originKeys",
"host": [
"{{baseUrl}}"
],
"path": [
"originKeys"
],
"variable": [
],
"query": [
]
},
"description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"originKeys\": {\n \"https://www.your-domain1.com\": \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw\",\n \"https://www.your-domain3.com\": \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc\",\n \"https://www.your-domain2.com\": \"pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"originDomains\": [\"https://www.your-domain1.com\", \"https://www.your-domain2.com\", \"https://www.your-domain3.com\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/originKeys",
"host": [
"{{baseUrl}}"
],
"path": [
"originKeys"
],
"variable": [
],
"query": [
]
},
"description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. > If you're still using origin key for your Web Drop-in or Components integration, we recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key). This allows you to use a single key for all origins, add or remove origins without generating a new key, and detect the card type from the number entered in your payment form. "
}
}
]
}
]
},
{
"name": "/paypal/updateOrder",
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address.",
"item": [
{
"name": "Update a PayPal order with delivery methods in an Advanced flow integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentData\": \"po7XZ...\",\n \"status\": \"success\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pspReference\": \"DZ4DPSHB4WD2WN82\",\n \"paymentData\": \"po7XZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
}
]
},
{
"name": "Update a PayPal order in an Advanced flow integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentData\": \"kly45P...\",\n \"status\": \"success\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"pspReference\": \"HWL5D5BDLSGLNK82\",\n \"paymentData\": \"kly45P...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1200\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
}
]
},
{
"name": "Update a PayPal order with delivery methods in a Sessions flow integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentData\": \"ey4YZ...\",\n \"status\": \"success\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"ey4YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 12000\n},\n \"deliveryMethods\": [{\n \"reference\": \"1\",\n \"description\": \"Express Shipping\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selected\": true\n}, {\n \"reference\": \"2\",\n \"description\": \"Standard Ground\",\n \"type\": \"Shipping\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"selected\": false\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
}
]
},
{
"name": "Update a PayPal order in a Sessions flow integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentData\": \"em9YZ...\",\n \"status\": \"success\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sessionId\": \"CS12345679\",\n \"paymentData\": \"em9YZ...\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paypal/updateOrder",
"host": [
"{{baseUrl}}"
],
"path": [
"paypal",
"updateOrder"
],
"variable": [
],
"query": [
]
},
"description": "Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address."
}
}
]
}
]
}
]
},
{
"name": "Recurring",
"item": [
{
"name": "/storedPaymentMethods",
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments.",
"item": [
{
"name": "Create a token to store payment details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"shopperEmail\": \"<string>\",\n \"shopperIP\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"storingMethod\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/storedPaymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"storedPaymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments."
}
,"response": [
]
}
]
}
]
},
{
"name": "Donations",
"item": [
{
"name": "/donations",
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).",
"item": [
{
"name": "Start a donation transaction",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\"\n},\n \"donationToken\": \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\": \"991559660454807J\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/donations",
"host": [
"{{baseUrl}}"
],
"path": [
"donations"
],
"variable": [
],
"query": [
]
},
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"status\": \"completed\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"payment\": {\n \"pspReference\": \"8535762347980628\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\"\n},\n \"donationToken\": \"YOUR_DONATION_TOKEN\",\n \"donationOriginalPspReference\": \"991559660454807J\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/donations",
"host": [
"{{baseUrl}}"
],
"path": [
"donations"
],
"variable": [
],
"query": [
]
},
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
}
}
]
},
{
"name": "Start a donation transaction with a token",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/donations",
"host": [
"{{baseUrl}}"
],
"path": [
"donations"
],
"variable": [
],
"query": [
]
},
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"id\": \"UNIQUE_RESOURCE_ID\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"payment\": {\n \"pspReference\": \"FJM726V375BV9D82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 500\n},\n \"merchantReference\": \"YOUR_DONATION_REFERENCE\"\n},\n \"reference\": \"1412563167350061\",\n \"status\": \"completed\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/donations",
"host": [
"{{baseUrl}}"
],
"path": [
"donations"
],
"variable": [
],
"query": [
]
},
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
}
},
{"name": "Unprocessable Entity - a request validation error.",
"code": 422,
"status": "Unprocessable Entity",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"status\": 422,\n \"errorCode\": \"187\",\n \"message\": \"Field 'additionalData.donationAccount' is not valid.\",\n \"errorType\": \"validation\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"7219687191761347\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"NONPROFIT_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/donations",
"host": [
"{{baseUrl}}"
],
"path": [
"donations"
],
"variable": [
],
"query": [
]
},
"description": "Takes in the donation token generated by the `/payments` request and uses it to make the donation for the donation account specified in the request. For more information, see [Donations](https://docs.adyen.com/online-payments/donations)."
}
}
]
}
]
}
]
},
{
"name": "Payments",
"item": [
{
"name": "/cardDetails",
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. ",
"item": [
{
"name": "Get a list of brands on a card with the unencrypted card number",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"cardDetails"
],
"variable": [
],
"query": [
]
},
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"brands\": [{\n \"type\": \"visa\",\n \"supported\": true\n}, {\n \"type\": \"cartebancaire\",\n \"supported\": true\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"cardDetails"
],
"variable": [
],
"query": [
]
},
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. "
}
}
]
},
{
"name": "Get a list of brands on a card specifying your supported card brands",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\", \"mc\", \"amex\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"cardDetails"
],
"variable": [
],
"query": [
]
},
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"brands\": [{\n \"type\": \"visa\",\n \"supported\": true\n}, {\n \"type\": \"cartebancaire\",\n \"supported\": false\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\", \"mc\", \"amex\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardDetails",
"host": [
"{{baseUrl}}"
],
"path": [
"cardDetails"
],
"variable": [
],
"query": [
]
},
"description": "Send a request with at least the first 6 digits of the card number to get a response with an array of brands on the card. If you include [your supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands) in the request, the response also tells you if you support each [brand that was identified](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__resParam_details). If you have an API-only integration and collect card data, use this endpoint to find out if the shopper's card is co-branded. For co-branded cards, you must let the shopper choose the brand to pay with if you support both brands. "
}
}
]
}
]
},
{
"name": "/paymentMethods",
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.",
"item": [
{
"name": "Get available payment methods",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentMethods\": [{\n \"details\": [{\n \"details\": [{\n \"key\": \"ownerName\",\n \"type\": \"text\"\n}, {\n \"key\": \"bankLocationId\",\n \"type\": \"text\"\n}, {\n \"key\": \"bankAccountNumber\",\n \"type\": \"text\"\n}],\n \"key\": \"bankAccount\",\n \"type\": \"bankAccount\"\n}],\n \"name\": \"ACH Direct Debit\",\n \"type\": \"ach\"\n}, {\n \"name\": \"Adyen Voucher\",\n \"type\": \"adyen_test_voucher\"\n}, {\n \"details\": [{\n \"details\": [{\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"dateOfBirth\",\n \"type\": \"date\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}],\n \"key\": \"personalDetails\",\n \"type\": \"fieldSet\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"billingAddress\",\n \"type\": \"address\"\n}, {\n \"key\": \"separateDeliveryAddress\",\n \"optional\": true,\n \"type\": \"boolean\",\n \"value\": \"false\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"deliveryAddress\",\n \"optional\": true,\n \"type\": \"address\"\n}],\n \"name\": \"AfterPay Invoice\",\n \"type\": \"afterpay_default\"\n}, {\n \"name\": \"AfterPay DirectDebit\",\n \"type\": \"afterpay_directdebit\"\n}, {\n \"name\": \"Afterpay\",\n \"type\": \"afterpaytouch\"\n}, {\n \"details\": [{\n \"key\": \"encryptedCardNumber\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedSecurityCode\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryMonth\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryYear\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"holderName\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Credit Card\",\n \"type\": \"scheme\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay\"\n}, {\n \"name\": \"AliPay HK\",\n \"type\": \"alipay_hk\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay_wap\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.androidpay.token\",\n \"type\": \"androidPayToken\"\n}],\n \"name\": \"Android Pay\",\n \"type\": \"androidpay\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.applepay.token\",\n \"type\": \"applePayToken\"\n}],\n \"name\": \"Apple Pay\",\n \"type\": \"applepay\"\n}, {\n \"name\": \"Credit Card via AsiaPay\",\n \"type\": \"asiapay\"\n}, {\n \"name\": \"China UnionPay\",\n \"type\": \"asiapay_unionpay\"\n}, {\n \"name\": \"Baby Gift Card\",\n \"type\": \"babygiftcard\"\n}, {\n \"name\": \"Baloto\",\n \"type\": \"baloto\"\n}, {\n \"name\": \"BancNet\",\n \"type\": \"bancnet\"\n}, {\n \"name\": \"Bank Transfer (BG)\",\n \"type\": \"bankTransfer_BG\"\n}, {\n \"name\": \"Bank Transfer (CH)\",\n \"type\": \"bankTransfer_CH\"\n}, {\n \"name\": \"Bank Transfer (DE)\",\n \"type\": \"bankTransfer_DE\"\n}, {\n \"name\": \"Bank Transfer (FI)\",\n \"type\": \"bankTransfer_FI\"\n}, {\n \"name\": \"Bank Transfer (GB)\",\n \"type\": \"bankTransfer_GB\"\n}, {\n \"name\": \"Bank Transfer (HU)\",\n \"type\": \"bankTransfer_HU\"\n}, {\n \"name\": \"SEPA Bank Transfer\",\n \"type\": \"bankTransfer_IBAN\"\n}, {\n \"name\": \"Bank Transfer (IE)\",\n \"type\": \"bankTransfer_IE\"\n}, {\n \"name\": \"Electronic Bank Transfer (MX)\",\n \"type\": \"bankTransfer_MX_linked\"\n}, {\n \"name\": \"Bank Transfer (MX)\",\n \"type\": \"bankTransfer_MX_offline\"\n}, {\n \"name\": \"Bank Transfer (NL)\",\n \"type\": \"bankTransfer_NL\"\n}, {\n \"name\": \"Bank Transfer (PL)\",\n \"type\": \"bankTransfer_PL\"\n}, {\n \"name\": \"Bank Transfer (SE)\",\n \"type\": \"bankTransfer_SE\"\n}, {\n \"name\": \"Bank Transfer (US)\",\n \"type\": \"bankTransfer_US\"\n}, {\n \"name\": \"Payconiq by Bancontact\",\n \"type\": \"bcmc_mobile\"\n}, {\n \"name\": \"Bijenkorf Cadeaucard\",\n \"type\": \"bijcadeaucard\"\n}, {\n \"name\": \"99Bill\",\n \"type\": \"bill99\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"AUB_DIRECT\",\n \"name\": \"AU Small Finance Bank\"\n}, {\n \"id\": \"ALB_DIRECT\",\n \"name\": \"Allahabad Bank \"\n}, {\n \"id\": \"APG_DIRECT\",\n \"name\": \"Andhra Pragathi Grameena Bank\"\n}, {\n \"id\": \"BDN_DIRECT\",\n \"name\": \"Bandhan bank\"\n}, {\n \"id\": \"BBK_DIRECT\",\n \"name\": \"Bank of Bahrain and Kuwait\"\n}, {\n \"id\": \"BBR_DIRECT\",\n \"name\": \"Bank of Baroda - Retail Banking\"\n}, {\n \"id\": \"BCB_DIRECT\",\n \"name\": \"Bassien Catholic Co-Operative Bank \"\n}, {\n \"id\": \"CNB_DIRECT\",\n \"name\": \"Canara Bank\"\n}, {\n \"id\": \"SYD_DIRECT\",\n \"name\": \"Canara Bank (e-Syndicate)\"\n}, {\n \"id\": \"CSB_DIRECT\",\n \"name\": \"Catholic Syrian Bank\"\n}, {\n \"id\": \"CBI_DIRECT\",\n \"name\": \"Central Bank of India\"\n}, {\n \"id\": \"CUB_DIRECT\",\n \"name\": \"City Union Bank\"\n}, {\n \"id\": \"COB_DIRECT\",\n \"name\": \"Cosmos Bank\"\n}, {\n \"id\": \"DEN_DIRECT\",\n \"name\": \"Dena Bank\"\n}, {\n \"id\": \"DBK_DIRECT\",\n \"name\": \"Deutsche Bank\"\n}, {\n \"id\": \"DCB_DIRECT\",\n \"name\": \"Development Credit Bank\"\n}, {\n \"id\": \"DLB_DIRECT\",\n \"name\": \"Dhanlakshmi Bank - Retail Net Banking\"\n}, {\n \"id\": \"ESF_DIRECT\",\n \"name\": \"ESAF Small Finance Bank\"\n}, {\n \"id\": \"EQB_DIRECT\",\n \"name\": \"Equitas Small Finance Bank\"\n}, {\n \"id\": \"FBK_DIRECT\",\n \"name\": \"Federal Bank\"\n}, {\n \"id\": \"FNC_DIRECT\",\n \"name\": \"Fincare Bank\"\n}, {\n \"id\": \"HDF_DIRECT\",\n \"name\": \"HDFC Bank\"\n}, {\n \"id\": \"ICI_DIRECT\",\n \"name\": \"ICICI Bank \"\n}, {\n \"id\": \"IDB_DIRECT\",\n \"name\": \"IDBI Bank - Retail Net Banking\"\n}, {\n \"id\": \"IDN_DIRECT\",\n \"name\": \"IDFC FIRST Bank\"\n}, {\n \"id\": \"INB_DIRECT\",\n \"name\": \"Indian Bank\"\n}, {\n \"id\": \"IOB_DIRECT\",\n \"name\": \"Indian Overseas Bank\"\n}, {\n \"id\": \"IDS_DIRECT\",\n \"name\": \"IndusInd Bank\"\n}, {\n \"id\": \"JKB_DIRECT\",\n \"name\": \"Jammu & Kashmir Bank\"\n}, {\n \"id\": \"JNB_DIRECT\",\n \"name\": \"Jana Small Finance Bank\"\n}, {\n \"id\": \"JSB_DIRECT\",\n \"name\": \"Janata Sahakari Bank Ltd Pune\"\n}, {\n \"id\": \"KJB_DIRECT\",\n \"name\": \"Kalyan Janata Sahakari Bank\"\n}, {\n \"id\": \"KBL_DIRECT\",\n \"name\": \"Karnataka Bank Ltd\"\n}, {\n \"id\": \"KVB_DIRECT\",\n \"name\": \"Karur Vysya Bank\"\n}, {\n \"id\": \"162_DIRECT\",\n \"name\": \"Kotak Bank\"\n}, {\n \"id\": \"LVR_DIRECT\",\n \"name\": \"Laxmi Vilas Bank - Retail\"\n}, {\n \"id\": \"NKB_DIRECT\",\n \"name\": \"NKGSB Co-op Bank\"\n}, {\n \"id\": \"NEB_DIRECT\",\n \"name\": \"North East Small Finance Bank\"\n}, {\n \"id\": \"OBC_DIRECT\",\n \"name\": \"PNB (Erstwhile-Oriental Bank of Commerce)\"\n}, {\n \"id\": \"UNI_DIRECT\",\n \"name\": \"PNB (Erstwhile-United Bank of India)\"\n}, {\n \"id\": \"PMC_DIRECT\",\n \"name\": \"Punjab & Maharastra Co-op Bank\"\n}, {\n \"id\": \"PSB_DIRECT\",\n \"name\": \"Punjab & Sind Bank\"\n}, {\n \"id\": \"CPN_DIRECT\",\n \"name\": \"Punjab National Bank - Corporate \"\n}, {\n \"id\": \"PNB_DIRECT\",\n \"name\": \"Punjab National Bank - Retail Banking\"\n}, {\n \"id\": \"RBL_DIRECT\",\n \"name\": \"RBL Bank Limited\"\n}, {\n \"id\": \"SWB_DIRECT\",\n \"name\": \"Saraswat Bank\"\n}, {\n \"id\": \"SHB_DIRECT\",\n \"name\": \"Shivalik Mercantile Cooperative Bank Ltd\"\n}, {\n \"id\": \"SIB_DIRECT\",\n \"name\": \"South Indian Bank\"\n}, {\n \"id\": \"SCB_DIRECT\",\n \"name\": \"Standard Chartered Bank\"\n}, {\n \"id\": \"SBI_DIRECT\",\n \"name\": \"State Bank of India\"\n}, {\n \"id\": \"SRB_DIRECT\",\n \"name\": \"Suryoday Small Finance Bank\"\n}, {\n \"id\": \"TJB_DIRECT\",\n \"name\": \"TJSB Bank\"\n}, {\n \"id\": \"TNC_DIRECT\",\n \"name\": \"Tamil Nadu State Co-operative Bank\"\n}, {\n \"id\": \"TMB_DIRECT\",\n \"name\": \"Tamilnad Mercantile Bank Ltd\"\n}, {\n \"id\": \"TBB_DIRECT\",\n \"name\": \"Thane Bharat Sahakari Bank Ltd\"\n}, {\n \"id\": \"MSB_DIRECT\",\n \"name\": \"The Mehsana Urban Co Op Bank Ltd\"\n}, {\n \"id\": \"UCO_DIRECT\",\n \"name\": \"UCO Bank\"\n}, {\n \"id\": \"UBI_DIRECT\",\n \"name\": \"Union Bank of India\"\n}, {\n \"id\": \"ADB_DIRECT\",\n \"name\": \"Union Bank of India (Erstwhile Andhra Bank)\"\n}, {\n \"id\": \"CRP_DIRECT\",\n \"name\": \"Union Bank of India (Erstwhile Corporation Bank)\"\n}, {\n \"id\": \"VRB_DIRECT\",\n \"name\": \"Varachha Co-operative Bank Limited\"\n}, {\n \"id\": \"VJB_DIRECT\",\n \"name\": \"Vijaya Bank\"\n}, {\n \"id\": \"YBK_DIRECT\",\n \"name\": \"Yes Bank\"\n}, {\n \"id\": \"ZOB_DIRECT\",\n \"name\": \"Zoroastrian Co-operative Bank Limited\"\n}, {\n \"id\": \"DBS_DIRECT\",\n \"name\": \"digibank by DBS\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Online Banking India\",\n \"type\": \"billdesk_online\"\n}, {\n \"name\": \"UPI\",\n \"type\": \"billdesk_upi\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"DCW_DIRECT\",\n \"name\": \"DCB Cippy\"\n}, {\n \"id\": \"ICC_DIRECT\",\n \"name\": \"ICC Cash Card\"\n}, {\n \"id\": \"OXY_DIRECT\",\n \"name\": \"Oxigen Wallet\"\n}, {\n \"id\": \"PCH_DIRECT\",\n \"name\": \"Pay World Money\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Wallets India\",\n \"type\": \"billdesk_wallet\"\n}, {\n \"name\": \"Blik\",\n \"type\": \"blik\"\n}, {\n \"name\": \"Bloemen Giftcard\",\n \"type\": \"bloemengiftcard\"\n}, {\n \"name\": \"Boekenbon Giftcard\",\n \"type\": \"boekenbon\"\n}, {\n \"name\": \"Boleto\",\n \"type\": \"boleto\"\n}, {\n \"name\": \"Boleto Bancario\",\n \"type\": \"boletobancario_santander\"\n}, {\n \"name\": \"Bradesco\",\n \"type\": \"bradesco\"\n}, {\n \"name\": \"Cash-Ticket\",\n \"type\": \"cashticket\"\n}, {\n \"name\": \"CashU\",\n \"type\": \"cashu\"\n}, {\n \"name\": \"CCAvenue\",\n \"type\": \"ccavenue\"\n}, {\n \"name\": \"Mula Checkout\",\n \"type\": \"cellulant\"\n}, {\n \"name\": \"Chasin Giftcard\",\n \"type\": \"chasingiftcard\"\n}, {\n \"name\": \"Clearpay\",\n \"type\": \"clearpay\"\n}, {\n \"name\": \"ClickandBuy\",\n \"type\": \"clickandbuy\"\n}, {\n \"name\": \"Paiement en 3 fois par Cartes Bancaires\",\n \"type\": \"cofinoga_3xcb\"\n}, {\n \"name\": \"Costes Giftcard\",\n \"type\": \"costesgiftcard\"\n}, {\n \"name\": \"custom_settlement\",\n \"type\": \"custom_settlement\"\n}, {\n \"name\": \"DANA\",\n \"type\": \"dana\"\n}, {\n \"name\": \"DineroMail\",\n \"type\": \"dineromail\"\n}, {\n \"name\": \"Online bank transfer.\",\n \"type\": \"directEbanking\"\n}, {\n \"name\": \"Direct Debit Brazil - Banco do Brazil\",\n \"type\": \"directdebit_BR_bancodobrasil\"\n}, {\n \"name\": \"Direct Debit Brazil - Bradesco\",\n \"type\": \"directdebit_BR_bradesco\"\n}, {\n \"name\": \"Direct Debit Brazil - Caixa Economica Federal\",\n \"type\": \"directdebit_BR_caixa\"\n}, {\n \"name\": \"Direct Debit Brazil - HSBC\",\n \"type\": \"directdebit_BR_hsbc\"\n}, {\n \"name\": \"Direct Debit Brazil - Itau\",\n \"type\": \"directdebit_BR_itau\"\n}, {\n \"name\": \"Direct Debit Brazil - Santander\",\n \"type\": \"directdebit_BR_santander\"\n}, {\n \"name\": \"BACS Direct Debit\",\n \"type\": \"directdebit_GB\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Alfamart\",\n \"type\": \"doku_alfamart\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"BCA Bank Transfer\",\n \"type\": \"doku_bca_va\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"BNI VA\",\n \"type\": \"doku_bni_va\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"BRI VA\",\n \"type\": \"doku_bri_va\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"CIMB VA\",\n \"type\": \"doku_cimb_va\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Danamon VA\",\n \"type\": \"doku_danamon_va\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Indomaret\",\n \"type\": \"doku_indomaret\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Mandiri VA\",\n \"type\": \"doku_mandiri_va\"\n}, {\n \"details\": [{\n \"key\": \"ovoId\",\n \"type\": \"text\"\n}],\n \"name\": \"OVO\",\n \"type\": \"doku_ovo\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Bank Transfer\",\n \"type\": \"doku_permata_lite_atm\"\n}, {\n \"details\": [{\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"infix\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"DOKU wallet\",\n \"type\": \"doku_wallet\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"66\",\n \"name\": \"Bank Nowy BFG S.A.\"\n}, {\n \"id\": \"92\",\n \"name\": \"Bank Spółdzielczy w Brodnicy\"\n}, {\n \"id\": \"11\",\n \"name\": \"Bank transfer / postal\"\n}, {\n \"id\": \"74\",\n \"name\": \"Banki Spółdzielcze\"\n}, {\n \"id\": \"73\",\n \"name\": \"BLIK\"\n}, {\n \"id\": \"90\",\n \"name\": \"BNP Paribas - płacę z Pl@net\"\n}, {\n \"id\": \"59\",\n \"name\": \"CinkciarzPAY\"\n}, {\n \"id\": \"87\",\n \"name\": \"Credit Agricole PBL\"\n}, {\n \"id\": \"83\",\n \"name\": \"EnveloBank\"\n}, {\n \"id\": \"76\",\n \"name\": \"Getin Bank PBL\"\n}, {\n \"id\": \"81\",\n \"name\": \"Idea Cloud\"\n}, {\n \"id\": \"7\",\n \"name\": \"ING Corporate customers\"\n}, {\n \"id\": \"93\",\n \"name\": \"Kasa Stefczyka\"\n}, {\n \"id\": \"44\",\n \"name\": \"Millennium - Płatności Internetowe\"\n}, {\n \"id\": \"10\",\n \"name\": \"Millennium Corporate customers\"\n}, {\n \"id\": \"68\",\n \"name\": \"mRaty\"\n}, {\n \"id\": \"1\",\n \"name\": \"mTransfer\"\n}, {\n \"id\": \"91\",\n \"name\": \"Nest Bank\"\n}, {\n \"id\": \"80\",\n \"name\": \"Noble Pay\"\n}, {\n \"id\": \"50\",\n \"name\": \"Pay Way Toyota Bank\"\n}, {\n \"id\": \"45\",\n \"name\": \"Pay with Alior Bank\"\n}, {\n \"id\": \"36\",\n \"name\": \"Pekao24Przelew\"\n}, {\n \"id\": \"70\",\n \"name\": \"Pocztowy24\"\n}, {\n \"id\": \"6\",\n \"name\": \"Przelew24\"\n}, {\n \"id\": \"46\",\n \"name\": \"Płacę z Citi Handlowy\"\n}, {\n \"id\": \"38\",\n \"name\": \"Płacę z ING\"\n}, {\n \"id\": \"2\",\n \"name\": \"Płacę z Inteligo\"\n}, {\n \"id\": \"4\",\n \"name\": \"Płacę z iPKO\"\n}, {\n \"id\": \"75\",\n \"name\": \"Płacę z Plus Bank\"\n}, {\n \"id\": \"51\",\n \"name\": \"Płać z BOŚ\"\n}, {\n \"id\": \"55\",\n \"name\": \"Raty z Alior Bankiem PLN\"\n}, {\n \"id\": \"89\",\n \"name\": \"Santander\"\n}, {\n \"id\": \"52\",\n \"name\": \"SkyCash\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Local Polish Payment Methods\",\n \"type\": \"dotpay\"\n}, {\n \"name\": \"Dragonpay Prepaid Credits\",\n \"type\": \"dragonpay_credits\"\n}, {\n \"name\": \"Online Banking\",\n \"type\": \"dragonpay_ebanking\"\n}, {\n \"name\": \"GCash\",\n \"type\": \"dragonpay_gcash\"\n}, {\n \"name\": \"Over The Counter Banks\",\n \"type\": \"dragonpay_otc_banking\"\n}, {\n \"name\": \"OTC non-Bank via Dragonpay\",\n \"type\": \"dragonpay_otc_non_banking\"\n}, {\n \"name\": \"Convenience Stores\",\n \"type\": \"dragonpay_otc_philippines\"\n}, {\n \"name\": \"7/11\",\n \"type\": \"dragonpay_seveneleven\"\n}, {\n \"name\": \"eagleeye_voucher\",\n \"type\": \"eagleeye_voucher\"\n}, {\n \"name\": \"Finnish E-Banking\",\n \"type\": \"ebanking_FI\"\n}, {\n \"name\": \"Pay-easy ATM\",\n \"type\": \"econtext_atm\"\n}, {\n \"name\": \"Online Banking\",\n \"type\": \"econtext_online\"\n}, {\n \"name\": \"7-Eleven\",\n \"type\": \"econtext_seven_eleven\"\n}, {\n \"name\": \"Convenience Stores\",\n \"type\": \"econtext_stores\"\n}, {\n \"name\": \"eft_directdebit_CA\",\n \"type\": \"eft_directdebit_CA\"\n}, {\n \"name\": \"Lastschrift (ELV)\",\n \"type\": \"elv\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"231\",\n \"name\": \"POP Pankki\"\n}, {\n \"id\": \"551\",\n \"name\": \"Komerční banka\"\n}, {\n \"id\": \"232\",\n \"name\": \"Aktia\"\n}, {\n \"id\": \"552\",\n \"name\": \"Raiffeisen\"\n}, {\n \"id\": \"233\",\n \"name\": \"Säästöpankki\"\n}, {\n \"id\": \"750\",\n \"name\": \"Swedbank\"\n}, {\n \"id\": \"211\",\n \"name\": \"Nordea\"\n}, {\n \"id\": \"553\",\n \"name\": \"ČSOB\"\n}, {\n \"id\": \"234\",\n \"name\": \"S-Pankki\"\n}, {\n \"id\": \"751\",\n \"name\": \"SEB\"\n}, {\n \"id\": \"554\",\n \"name\": \"Moneta\"\n}, {\n \"id\": \"235\",\n \"name\": \"OmaSP\"\n}, {\n \"id\": \"752\",\n \"name\": \"Nordea\"\n}, {\n \"id\": \"213\",\n \"name\": \"Op-Pohjola\"\n}, {\n \"id\": \"555\",\n \"name\": \"UniCredit\"\n}, {\n \"id\": \"753\",\n \"name\": \"LHV\"\n}, {\n \"id\": \"556\",\n \"name\": \"Fio\"\n}, {\n \"id\": \"557\",\n \"name\": \"mBank\"\n}, {\n \"id\": \"216\",\n \"name\": \"Handelsbanken\"\n}, {\n \"id\": \"558\",\n \"name\": \"Air Bank\"\n}, {\n \"id\": \"260\",\n \"name\": \"Länsförsäkringar\"\n}, {\n \"id\": \"240\",\n \"name\": \"BankDeposit\"\n}, {\n \"id\": \"265\",\n \"name\": \"Sparbanken\"\n}, {\n \"id\": \"640\",\n \"name\": \"BankDeposit\"\n}, {\n \"id\": \"200\",\n \"name\": \"Ålandsbanken\"\n}, {\n \"id\": \"940\",\n \"name\": \"Swedbank\"\n}, {\n \"id\": \"500\",\n \"name\": \"Česká spořitelna\"\n}, {\n \"id\": \"720\",\n \"name\": \"Swedbank\"\n}, {\n \"id\": \"941\",\n \"name\": \"SEB\"\n}, {\n \"id\": \"204\",\n \"name\": \"Danske Bank\"\n}, {\n \"id\": \"721\",\n \"name\": \"SEB\"\n}, {\n \"id\": \"942\",\n \"name\": \"Citadele\"\n}, {\n \"id\": \"205\",\n \"name\": \"Handelsbanken\"\n}, {\n \"id\": \"722\",\n \"name\": \"DNB\"\n}, {\n \"id\": \"943\",\n \"name\": \"DNB\"\n}, {\n \"id\": \"206\",\n \"name\": \"Nordea\"\n}, {\n \"id\": \"723\",\n \"name\": \"Šiaulių bankas\"\n}, {\n \"id\": \"207\",\n \"name\": \"SEB\"\n}, {\n \"id\": \"724\",\n \"name\": \"Nordea\"\n}, {\n \"id\": \"505\",\n \"name\": \"Komerční banka\"\n}, {\n \"id\": \"208\",\n \"name\": \"Skandiabanken\"\n}, {\n \"id\": \"209\",\n \"name\": \"Swedbank\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Bank Payment\",\n \"type\": \"entercash\"\n}, {\n \"name\": \"Nationale Entertainment Card\",\n \"type\": \"entertainmentcard\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"d5d5b133-1c0d-4c08-b2be-3c9b116dc326\",\n \"name\": \"Dolomitenbank\"\n}, {\n \"id\": \"ee9fc487-ebe0-486c-8101-17dce5141a67\",\n \"name\": \"Raiffeissen Bankengruppe\"\n}, {\n \"id\": \"6765e225-a0dc-4481-9666-e26303d4f221\",\n \"name\": \"Hypo Tirol Bank AG\"\n}, {\n \"id\": \"8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc\",\n \"name\": \"Sparda Bank Wien\"\n}, {\n \"id\": \"1190c4d1-b37a-487e-9355-e0a067f54a9f\",\n \"name\": \"Schoellerbank AG\"\n}, {\n \"id\": \"e2e97aaa-de4c-4e18-9431-d99790773433\",\n \"name\": \"Volksbank Gruppe\"\n}, {\n \"id\": \"bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9\",\n \"name\": \"Immo-Bank\"\n}, {\n \"id\": \"e6819e7a-f663-414b-92ec-cf7c82d2f4e5\",\n \"name\": \"Bank Austria\"\n}, {\n \"id\": \"eff103e6-843d-48b7-a6e6-fbd88f511b11\",\n \"name\": \"Easybank AG\"\n}, {\n \"id\": \"25942cc9-617d-42a1-89ba-d1ab5a05770a\",\n \"name\": \"VR-BankBraunau\"\n}, {\n \"id\": \"4a0a975b-0594-4b40-9068-39f77b3a91f9\",\n \"name\": \"Volkskreditbank\"\n}, {\n \"id\": \"3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3\",\n \"name\": \"Erste Bank und Sparkassen\"\n}, {\n \"id\": \"ba7199cc-f057-42f2-9856-2378abf21638\",\n \"name\": \"BAWAG P.S.K. Gruppe\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"EPS\",\n \"type\": \"eps\"\n}, {\n \"name\": \"Expert Cadeaukaart\",\n \"type\": \"expertgiftcard\"\n}, {\n \"details\": [{\n \"details\": [{\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}],\n \"key\": \"personalDetails\",\n \"type\": \"fieldSet\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"FR\",\n \"name\": \"France\"\n}, {\n \"id\": \"ES\",\n \"name\": \"Spain\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"billingAddress\",\n \"type\": \"address\"\n}, {\n \"key\": \"separateDeliveryAddress\",\n \"optional\": true,\n \"type\": \"boolean\",\n \"value\": \"false\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"FR\",\n \"name\": \"France\"\n}, {\n \"id\": \"ES\",\n \"name\": \"Spain\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"deliveryAddress\",\n \"optional\": true,\n \"type\": \"address\"\n}],\n \"name\": \"3x Oney\",\n \"type\": \"facilypay_3x\"\n}, {\n \"details\": [{\n \"details\": [{\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}],\n \"key\": \"personalDetails\",\n \"type\": \"fieldSet\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"FR\",\n \"name\": \"France\"\n}, {\n \"id\": \"ES\",\n \"name\": \"Spain\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"billingAddress\",\n \"type\": \"address\"\n}, {\n \"key\": \"separateDeliveryAddress\",\n \"optional\": true,\n \"type\": \"boolean\",\n \"value\": \"false\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"FR\",\n \"name\": \"France\"\n}, {\n \"id\": \"ES\",\n \"name\": \"Spain\"\n}],\n \"key\": \"country\",\n \"type\": \"select\"\n}],\n \"key\": \"deliveryAddress\",\n \"optional\": true,\n \"type\": \"address\"\n}],\n \"name\": \"4x Oney\",\n \"type\": \"facilypay_4x\"\n}, {\n \"name\": \"Fashioncheque\",\n \"type\": \"fashioncheque\"\n}, {\n \"details\": [{\n \"key\": \"shopper.firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"shopper.lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"countryCode\",\n \"type\": \"text\"\n}],\n \"name\": \"Fawry\",\n \"type\": \"fawry\"\n}, {\n \"name\": \"FijnCadeau\",\n \"type\": \"fijncadeau\"\n}, {\n \"name\": \"Fleurop Bloemenbon\",\n \"type\": \"fleuropbloemenbon\"\n}, {\n \"name\": \"Fonq Giftcard\",\n \"type\": \"fonqgiftcard\"\n}, {\n \"name\": \"Gall & Gall\",\n \"type\": \"gallgall\"\n}, {\n \"name\": \"GCash\",\n \"type\": \"gcash\"\n}, {\n \"name\": \"Generic GiftCard\",\n \"type\": \"genericgiftcard\"\n}, {\n \"name\": \"GiftFor2\",\n \"type\": \"giftfor2card\"\n}, {\n \"name\": \"Givex\",\n \"type\": \"givex\"\n}, {\n \"name\": \"Globe GCash\",\n \"type\": \"globegcash\"\n}, {\n \"name\": \"Goldsmiths Card\",\n \"type\": \"goldsmithscard\"\n}, {\n \"name\": \"GoPay Wallet\",\n \"type\": \"gopay_wallet\"\n}, {\n \"name\": \"OVO\",\n \"type\": \"grabpay_ID\"\n}, {\n \"name\": \"GrabPay\",\n \"type\": \"grabpay_PH\"\n}, {\n \"name\": \"GrabPay\",\n \"type\": \"grabpay_SG\"\n}, {\n \"name\": \"Hallmark Card\",\n \"type\": \"hallmarkcard\"\n}, {\n \"name\": \"HDFC\",\n \"type\": \"hdfc\"\n}, {\n \"name\": \"Hunkemoller Member Card\",\n \"type\": \"hmclub\"\n}, {\n \"name\": \"Hunkemoller Lingerie Card\",\n \"type\": \"hmlingerie\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"1121\",\n \"name\": \"Test Issuer\"\n}, {\n \"id\": \"1154\",\n \"name\": \"Test Issuer 5\"\n}, {\n \"id\": \"1153\",\n \"name\": \"Test Issuer 4\"\n}, {\n \"id\": \"1152\",\n \"name\": \"Test Issuer 3\"\n}, {\n \"id\": \"1151\",\n \"name\": \"Test Issuer 2\"\n}, {\n \"id\": \"1162\",\n \"name\": \"Test Issuer Cancelled\"\n}, {\n \"id\": \"1161\",\n \"name\": \"Test Issuer Pending\"\n}, {\n \"id\": \"1160\",\n \"name\": \"Test Issuer Refused\"\n}, {\n \"id\": \"1159\",\n \"name\": \"Test Issuer 10\"\n}, {\n \"id\": \"1158\",\n \"name\": \"Test Issuer 9\"\n}, {\n \"id\": \"1157\",\n \"name\": \"Test Issuer 8\"\n}, {\n \"id\": \"1156\",\n \"name\": \"Test Issuer 7\"\n}, {\n \"id\": \"1155\",\n \"name\": \"Test Issuer 6\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"iDEAL\",\n \"type\": \"ideal\"\n}, {\n \"name\": \"igive\",\n \"type\": \"igive\"\n}, {\n \"name\": \"Korean Account Transfer (IniPay)\",\n \"type\": \"inicisIniPay_accounttransfer\"\n}, {\n \"name\": \"Korean Credit Cards (IniPay)\",\n \"type\": \"inicisIniPay_creditcard\"\n}, {\n \"name\": \"Korean Mobile Phone (IniPay)\",\n \"type\": \"inicisIniPay_mobilephone\"\n}, {\n \"name\": \"Korean Virtual Account (IniPay)\",\n \"type\": \"inicisIniPay_virtualaccount\"\n}, {\n \"name\": \"Korean Account Transfer (Mobile)\",\n \"type\": \"inicisMobile_accounttransfer\"\n}, {\n \"name\": \"Korean Credit Cards (Mobile)\",\n \"type\": \"inicisMobile_creditcard\"\n}, {\n \"name\": \"Korean Mobile Phone (Mobile)\",\n \"type\": \"inicisMobile_mobilephone\"\n}, {\n \"name\": \"Korean Virtual Account (Mobile)\",\n \"type\": \"inicisMobile_virtualaccount\"\n}, {\n \"name\": \"Korean Credit Cards\",\n \"type\": \"inicis_creditcard\"\n}, {\n \"name\": \"Interac® Online\",\n \"type\": \"interac\"\n}, {\n \"name\": \"Instant EFT\",\n \"type\": \"ipay\"\n}, {\n \"name\": \"iPay88\",\n \"type\": \"ipay88\"\n}, {\n \"name\": \"isracard\",\n \"type\": \"isracard\"\n}, {\n \"name\": \"Phone Payment\",\n \"type\": \"ivr\"\n}, {\n \"name\": \"Landline phone\",\n \"type\": \"ivrLandline\"\n}, {\n \"name\": \"Mobile phone\",\n \"type\": \"ivrMobile\"\n}, {\n \"name\": \"Kado Wereld\",\n \"type\": \"kadowereld\"\n}, {\n \"name\": \"KakaoPay\",\n \"type\": \"kakaopay\"\n}, {\n \"name\": \"Karen Millen Card\",\n \"type\": \"karenmillen\"\n}, {\n \"name\": \"Karen Millen GiftCard\",\n \"type\": \"karenmillengiftcard\"\n}, {\n \"name\": \"Bank Transfer\",\n \"type\": \"kcp_banktransfer\"\n}, {\n \"name\": \"Korea–issued cards\",\n \"type\": \"kcp_creditcard\"\n}, {\n \"name\": \"PayCo\",\n \"type\": \"kcp_payco\"\n}, {\n \"name\": \"Naver Pay\",\n \"type\": \"kcp_naverpay\"\n}, {\n \"name\": \"Virtual Account via KCP\",\n \"type\": \"kcp_va\"\n}, {\n \"name\": \"Pay later with Klarna.\",\n \"type\": \"klarna\"\n}, {\n \"name\": \"Pay over time with Klarna.\",\n \"type\": \"klarna_account\"\n}, {\n \"name\": \"Buy Now, Pay Later with Billie\",\n \"type\": \"klarna_b2b\"\n}, {\n \"name\": \"Pay now with Klarna.\",\n \"type\": \"klarna_paynow\"\n}, {\n \"name\": \"Leisure Card\",\n \"type\": \"leisurecard\"\n}, {\n \"name\": \"China Credit Card\",\n \"type\": \"lianlianpay_creditcard\"\n}, {\n \"name\": \"China Debit Card\",\n \"type\": \"lianlianpay_debitcard\"\n}, {\n \"details\": [{\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}],\n \"name\": \"China Online Banking - Credit Card\",\n \"type\": \"lianlianpay_ebanking_credit\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"01030000\",\n \"name\": \"Agricultural Bank of China\"\n}, {\n \"id\": \"4031000\",\n \"name\": \"Bank of Beijing\"\n}, {\n \"id\": \"01040000\",\n \"name\": \"Bank of China\"\n}, {\n \"id\": \"03020000\",\n \"name\": \"China Citic Bank\"\n}, {\n \"id\": \"01050000\",\n \"name\": \"China Construction Bank\"\n}, {\n \"id\": \"03030000\",\n \"name\": \"China Everbright Bank\"\n}, {\n \"id\": \"03080000\",\n \"name\": \"China Merchants Bank\"\n}, {\n \"id\": \"03050000\",\n \"name\": \"China Minsheng Banking Group\"\n}, {\n \"id\": \"03040000\",\n \"name\": \"Hua Xia Bank Co\"\n}, {\n \"id\": \"01020000\",\n \"name\": \"Industrial and Commercial Bank of China\"\n}, {\n \"id\": \"03070000\",\n \"name\": \"PingAn Bank\"\n}, {\n \"id\": \"1000000\",\n \"name\": \"Postal Savings Bank of China\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}],\n \"name\": \"China Online Banking - Debit Card\",\n \"type\": \"lianlianpay_ebanking_debit\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"01030000\",\n \"name\": \"Agricultural Bank of China\"\n}, {\n \"id\": \"01050000\",\n \"name\": \"China Construction Bank\"\n}, {\n \"id\": \"03080000\",\n \"name\": \"China Merchants Bank\"\n}, {\n \"id\": \"01020000\",\n \"name\": \"Industrial and Commercial Bank of China\"\n}, {\n \"id\": \"03100000\",\n \"name\": \"Shanghai Pudong Development Bank\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}],\n \"name\": \"China Online Banking - Enterprise\",\n \"type\": \"lianlianpay_ebanking_enterprise\"\n}, {\n \"name\": \"Loods5 Cadeaukaart\",\n \"type\": \"loods5giftcard\"\n}, {\n \"name\": \"Loods5 Tegoedbon\",\n \"type\": \"loods5prepaidcard\"\n}, {\n \"name\": \"Love2Shop GiftCard\",\n \"type\": \"love2shop\"\n}, {\n \"details\": [{\n \"key\": \"shopper.firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"shopper.lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"countryCode\",\n \"type\": \"text\"\n}],\n \"name\": \"mada\",\n \"type\": \"mada\"\n}, {\n \"name\": \"Mappin & Webb Card\",\n \"type\": \"mappinwebbcard\"\n}, {\n \"name\": \"MB WAY\",\n \"type\": \"mbway\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.amazonPayToken\",\n \"type\": \"text\"\n}],\n \"name\": \"Amazon Pay\",\n \"supportsRecurring\": true,\n \"type\": \"amazonpay\"\n}, {\n \"name\": \"Mercado Pago\",\n \"type\": \"mercadopago\"\n}, {\n \"name\": \"MobilePay\",\n \"type\": \"mobilepay\"\n}, {\n \"name\": \"AliPay via Razer Merchant Services\",\n \"type\": \"molpay_alipay\"\n}, {\n \"name\": \"7-Eleven\",\n \"type\": \"molpay_cash\"\n}, {\n \"name\": \"CIMB Virtual Account\",\n \"type\": \"molpay_cimb_va\"\n}, {\n \"name\": \"Malaysia E-Banking via Razer Merchant Services\",\n \"type\": \"molpay_ebanking_MY\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"vtcpay-vietinbank\",\n \"name\": \"Vietinbank\"\n}, {\n \"id\": \"vtcpay-bidv\",\n \"name\": \"BIDV\"\n}, {\n \"id\": \"vtcpay-agribank\",\n \"name\": \"Agribank\"\n}, {\n \"id\": \"vtcpay-mb\",\n \"name\": \"MB Bank\"\n}, {\n \"id\": \"vtcpay-sacombank\",\n \"name\": \"Sacombank\"\n}, {\n \"id\": \"vtcpay-dongabank\",\n \"name\": \"DongABank\"\n}, {\n \"id\": \"vtcpay-maritimebank\",\n \"name\": \"MaritimeBank\"\n}, {\n \"id\": \"vtcpay-vietcombank\",\n \"name\": \"Vietcombank\"\n}, {\n \"id\": \"vtcpay-acb\",\n \"name\": \"ACB\"\n}, {\n \"id\": \"vtcpay-techcombank\",\n \"name\": \"Techcombank\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Vietnam E-Banking\",\n \"type\": \"molpay_ebanking_VN\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"fpx_bimb\",\n \"name\": \"Bank Islam\"\n}, {\n \"id\": \"fpx_uob\",\n \"name\": \"UOB Bank\"\n}, {\n \"id\": \"fpx_cimbclicks\",\n \"name\": \"CIMB Clicks\"\n}, {\n \"id\": \"fpx_kfh\",\n \"name\": \"Kuwait Finance House\"\n}, {\n \"id\": \"fpx_rhb\",\n \"name\": \"RHB Now\"\n}, {\n \"id\": \"fpx_abmb\",\n \"name\": \"Alliance Bank\"\n}, {\n \"id\": \"fpx_amb\",\n \"name\": \"Am Online\"\n}, {\n \"id\": \"fpx_hsbc\",\n \"name\": \"HSBC\"\n}, {\n \"id\": \"fpx_abb\",\n \"name\": \"Affin Bank\"\n}, {\n \"id\": \"fpx_ocbc\",\n \"name\": \"OCBC Bank\"\n}, {\n \"id\": \"fpx_pbb\",\n \"name\": \"Public Bank\"\n}, {\n \"id\": \"fpx_scb\",\n \"name\": \"Standard Chartered Bank\"\n}, {\n \"id\": \"fpx_bsn\",\n \"name\": \"Bank Simpanan Nasional\"\n}, {\n \"id\": \"fpx_mb2u\",\n \"name\": \"Maybank2u\"\n}, {\n \"id\": \"fpx_hlb\",\n \"name\": \"Hong Leong Connect\"\n}, {\n \"id\": \"fpx_bmmb\",\n \"name\": \"Bank Muamalat\"\n}, {\n \"id\": \"fpx_bkrm\",\n \"name\": \"Bank Rakyat\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Malaysia E-Banking\",\n \"type\": \"molpay_ebanking_fpx_MY\"\n}, {\n \"name\": \"eNETS Debit\",\n \"type\": \"molpay_enetsd\"\n}, {\n \"name\": \"epay\",\n \"type\": \"molpay_epay\"\n}, {\n \"name\": \"Esapay\",\n \"type\": \"molpay_esapay\"\n}, {\n \"name\": \"MyClear FPX\",\n \"type\": \"molpay_fpx\"\n}, {\n \"name\": \"Maybank2u\",\n \"type\": \"molpay_maybank2u\"\n}, {\n \"name\": \"Nganluong\",\n \"type\": \"molpay_nganluong\"\n}, {\n \"name\": \"Convenience Stores Thailand\",\n \"type\": \"molpay_paysbuy\"\n}, {\n \"name\": \"MOLPoints\",\n \"type\": \"molpay_points\"\n}, {\n \"name\": \"RHB Now\",\n \"type\": \"molpay_rhb\"\n}, {\n \"name\": \"SAM by SingPost\",\n \"type\": \"molpay_singpost\"\n}, {\n \"name\": \"MOLWallet\",\n \"type\": \"molpay_wallet\"\n}, {\n \"name\": \"MoMo ATM\",\n \"type\": \"momo_atm\"\n}, {\n \"name\": \"Momo Wallet\",\n \"type\": \"momo_wallet\"\n}, {\n \"name\": \"Moneybookers\",\n \"type\": \"moneybookers\"\n}, {\n \"name\": \"Multibanco\",\n \"type\": \"multibanco\"\n}, {\n \"name\": \"De Nationale Musicalcard\",\n \"type\": \"musicalcard\"\n}, {\n \"name\": \"Nationale Bioscoopbon\",\n \"type\": \"nationalebioscoopbon\"\n}, {\n \"name\": \"Nationale Tuinbon\",\n \"type\": \"nationaletuinbon\"\n}, {\n \"name\": \"Nationale Verwen Cadeaubon\",\n \"type\": \"nationaleverwencadeaubon\"\n}, {\n \"name\": \"BankAxess\",\n \"type\": \"netaxept_bankaxess\"\n}, {\n \"name\": \"NETELLER\",\n \"type\": \"neteller\"\n}, {\n \"name\": \"Onebip\",\n \"type\": \"onebip\"\n}, {\n \"name\": \"One Two Three\",\n \"type\": \"onetwothree\"\n}, {\n \"name\": \"Online Banking PL\",\n \"type\": \"onlineBanking_PL\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"1\",\n \"name\": \"Model Bank v2\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"Online banking\",\n \"type\": \"openbanking_UK\"\n}, {\n \"name\": \"Oxxo\",\n \"type\": \"oxxo\"\n}, {\n \"name\": \"Pathe Giftcard\",\n \"type\": \"pathegiftcard\"\n}, {\n \"name\": \"PayBright\",\n \"type\": \"paybright\"\n}, {\n \"name\": \"Maya Wallet\",\n \"type\": \"paymaya_wallet\"\n}, {\n \"name\": \"PayPal\",\n \"type\": \"paypal\"\n}, {\n \"name\": \"Paysafecard\",\n \"type\": \"paysafecard\"\n}, {\n \"name\": \"Payshop\",\n \"type\": \"payshop\"\n}, {\n \"name\": \"PayD AMT via Paythru\",\n \"type\": \"paythru_amt\"\n}, {\n \"name\": \"EFT via Paythru\",\n \"type\": \"paythru_eft\"\n}, {\n \"name\": \"PayTM\",\n \"type\": \"paytm\"\n}, {\n \"details\": [{\n \"key\": \"virtualPaymentAddress\",\n \"type\": \"text\"\n}],\n \"name\": \"PayU UPI\",\n \"type\": \"payu_IN_upi\"\n}, {\n \"name\": \"EFT Pro via PayU\",\n \"type\": \"payu_ZA_eftpro\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.paywithgoogle.token\",\n \"type\": \"payWithGoogleToken\"\n}],\n \"name\": \"Google Pay\",\n \"type\": \"paywithgoogle\"\n}, {\n \"name\": \"pix\",\n \"type\": \"pix\"\n}, {\n \"name\": \"Plastix\",\n \"type\": \"plastix\"\n}, {\n \"name\": \"Pluim\",\n \"type\": \"pluimgiftcard\"\n}, {\n \"name\": \"Podium Card\",\n \"type\": \"podiumcard\"\n}, {\n \"name\": \"POLi\",\n \"type\": \"poli\"\n}, {\n \"name\": \"PPS\",\n \"type\": \"pps\"\n}, {\n \"name\": \"Primera Cadeaukaart\",\n \"type\": \"primeracadeaucard\"\n}, {\n \"name\": \"Illicado Gift Card\",\n \"type\": \"prosodie_illicado\"\n}, {\n \"name\": \"PSE\",\n \"type\": \"pse\"\n}, {\n \"details\": [{\n \"items\": [{\n \"id\": \"+7\",\n \"name\": \"RU\"\n}, {\n \"id\": \"+9955\",\n \"name\": \"GE\"\n}, {\n \"id\": \"+507\",\n \"name\": \"PA\"\n}, {\n \"id\": \"+44\",\n \"name\": \"GB\"\n}, {\n \"id\": \"+992\",\n \"name\": \"TJ\"\n}, {\n \"id\": \"+370\",\n \"name\": \"LT\"\n}, {\n \"id\": \"+972\",\n \"name\": \"IL\"\n}, {\n \"id\": \"+996\",\n \"name\": \"KG\"\n}, {\n \"id\": \"+380\",\n \"name\": \"UA\"\n}, {\n \"id\": \"+84\",\n \"name\": \"VN\"\n}, {\n \"id\": \"+90\",\n \"name\": \"TR\"\n}, {\n \"id\": \"+994\",\n \"name\": \"AZ\"\n}, {\n \"id\": \"+374\",\n \"name\": \"AM\"\n}, {\n \"id\": \"+371\",\n \"name\": \"LV\"\n}, {\n \"id\": \"+91\",\n \"name\": \"IN\"\n}, {\n \"id\": \"+66\",\n \"name\": \"TH\"\n}, {\n \"id\": \"+373\",\n \"name\": \"MD\"\n}, {\n \"id\": \"+1\",\n \"name\": \"US\"\n}, {\n \"id\": \"+81\",\n \"name\": \"JP\"\n}, {\n \"id\": \"+998\",\n \"name\": \"UZ\"\n}, {\n \"id\": \"+77\",\n \"name\": \"KZ\"\n}, {\n \"id\": \"+375\",\n \"name\": \"BY\"\n}, {\n \"id\": \"+372\",\n \"name\": \"EE\"\n}, {\n \"id\": \"+40\",\n \"name\": \"RO\"\n}, {\n \"id\": \"+82\",\n \"name\": \"KR\"\n}],\n \"key\": \"qiwiwallet.telephoneNumberPrefix\",\n \"type\": \"select\"\n}, {\n \"key\": \"qiwiwallet.telephoneNumber\",\n \"type\": \"text\"\n}],\n \"name\": \"Qiwi Wallet\",\n \"type\": \"qiwiwallet\"\n}, {\n \"name\": \"RatePay Invoice\",\n \"type\": \"ratepay\"\n}, {\n \"name\": \"RatePay Direct Debit\",\n \"type\": \"ratepay_directdebit\"\n}, {\n \"name\": \"Rituals Giftcard\",\n \"type\": \"rituals\"\n}, {\n \"name\": \"Rob Peetoom Giftcard\",\n \"type\": \"robpeetoomgiftcard\"\n}, {\n \"name\": \"SafetyPay\",\n \"type\": \"safetypay\"\n}, {\n \"name\": \"SafetyPay Cash\",\n \"type\": \"safetypay_cash\"\n}, {\n \"name\": \"Shoes&Accessories Cadeau\",\n \"type\": \"sagiftcard\"\n}, {\n \"name\": \"Score Giftcard\",\n \"type\": \"scoregiftcard\"\n}, {\n \"name\": \"SEB Direktbetalning\",\n \"type\": \"sebdirectpayment\"\n}, {\n \"details\": [{\n \"key\": \"sepa.ownerName\",\n \"type\": \"text\"\n}, {\n \"key\": \"sepa.ibanNumber\",\n \"type\": \"text\"\n}],\n \"name\": \"SEPA Direct Debit\",\n \"type\": \"sepadirectdebit\"\n}, {\n \"name\": \"7-Eleven\",\n \"type\": \"seveneleven\"\n}, {\n \"name\": \"Premium SMS\",\n \"type\": \"sms\"\n}, {\n \"name\": \"SVS\",\n \"type\": \"svs\"\n}, {\n \"name\": \"Swish\",\n \"type\": \"swish\"\n}, {\n \"name\": \"TCS Test GiftCard\",\n \"type\": \"tcstestgiftcard\"\n}, {\n \"name\": \"TenPay\",\n \"type\": \"tenpay\"\n}, {\n \"name\": \"The Sting Giftcard\",\n \"type\": \"thestinggiftcard\"\n}, {\n \"name\": \"TrueMoney\",\n \"type\": \"truemoney\"\n}, {\n \"name\": \"Trustly\",\n \"type\": \"trustly\"\n}, {\n \"name\": \"Online Banking by Trustpay\",\n \"type\": \"trustpay\"\n}, {\n \"name\": \"TWINT\",\n \"type\": \"twint\"\n}, {\n \"name\": \"Ukash\",\n \"type\": \"ukash\"\n}, {\n \"name\": \"UnionPay\",\n \"type\": \"unionpay\"\n}, {\n \"details\": [{\n \"key\": \"virtualPaymentAddress\",\n \"type\": \"text\"\n}],\n \"name\": \"UPI Collect\",\n \"type\": \"upi_collect\"\n}, {\n \"name\": \"Valuelink\",\n \"type\": \"valuelink\"\n}, {\n \"name\": \"V&D Cadeaukaart\",\n \"type\": \"vdcadeaucard\"\n}, {\n \"details\": [{\n \"key\": \"telephoneNumber\",\n \"optional\": true,\n \"type\": \"tel\"\n}],\n \"name\": \"Vipps\",\n \"type\": \"vipps\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.visacheckout.callId\",\n \"type\": \"text\"\n}],\n \"name\": \"Visa Checkout\",\n \"type\": \"visacheckout\"\n}, {\n \"name\": \"VVV Cadeaubon\",\n \"type\": \"vvvcadeaubon\"\n}, {\n \"name\": \"VVV Giftcard\",\n \"type\": \"vvvgiftcard\"\n}, {\n \"name\": \"Webshop Giftcard\",\n \"type\": \"webshopgiftcard\"\n}, {\n \"name\": \"WeChat Pay\",\n \"type\": \"wechatpayMiniProgram\"\n}, {\n \"name\": \"WeChat Pay\",\n \"type\": \"wechatpayQR\"\n}, {\n \"name\": \"WeChat Pay\",\n \"type\": \"wechatpayWeb\"\n}, {\n \"name\": \"WE Fashion Giftcard\",\n \"type\": \"wefashiongiftcard\"\n}, {\n \"name\": \"Western Union\",\n \"type\": \"westernunion\"\n}, {\n \"name\": \"Winkel Cheque\",\n \"type\": \"winkelcheque\"\n}, {\n \"name\": \"WOS Card\",\n \"type\": \"woscard\"\n}, {\n \"name\": \"Alfa-Click\",\n \"type\": \"yandex_alfaclick\"\n}, {\n \"name\": \"Pay using bank card\",\n \"type\": \"yandex_bank_card\"\n}, {\n \"name\": \"Cash terminals\",\n \"type\": \"yandex_cash\"\n}, {\n \"name\": \"Pay using installments\",\n \"type\": \"yandex_installments\"\n}, {\n \"name\": \"YooMoney\",\n \"type\": \"yandex_money\"\n}, {\n \"name\": \"Promsvyazbank\",\n \"type\": \"yandex_promsvyazbank\"\n}, {\n \"name\": \"SberPay\",\n \"type\": \"yandex_sberbank\"\n}, {\n \"name\": \"WebMoney\",\n \"type\": \"yandex_webmoney\"\n}, {\n \"name\": \"Your Gift\",\n \"type\": \"yourgift\"\n}, {\n \"name\": \"Zip\",\n \"type\": \"zip\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
}
]
},
{
"name": "Get payment methods based on the country and amount",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl-NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentMethods\": [{\n \"details\": [{\n \"items\": [{\n \"id\": \"1121\",\n \"name\": \"Test Issuer\"\n}, {\n \"id\": \"1154\",\n \"name\": \"Test Issuer 5\"\n}, {\n \"id\": \"1153\",\n \"name\": \"Test Issuer 4\"\n}, {\n \"id\": \"1152\",\n \"name\": \"Test Issuer 3\"\n}, {\n \"id\": \"1151\",\n \"name\": \"Test Issuer 2\"\n}, {\n \"id\": \"1162\",\n \"name\": \"Test Issuer Cancelled\"\n}, {\n \"id\": \"1161\",\n \"name\": \"Test Issuer Pending\"\n}, {\n \"id\": \"1160\",\n \"name\": \"Test Issuer Refused\"\n}, {\n \"id\": \"1159\",\n \"name\": \"Test Issuer 10\"\n}, {\n \"id\": \"1158\",\n \"name\": \"Test Issuer 9\"\n}, {\n \"id\": \"1157\",\n \"name\": \"Test Issuer 8\"\n}, {\n \"id\": \"1156\",\n \"name\": \"Test Issuer 7\"\n}, {\n \"id\": \"1155\",\n \"name\": \"Test Issuer 6\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"iDEAL\",\n \"type\": \"ideal\"\n}, {\n \"details\": [{\n \"key\": \"encryptedCardNumber\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedSecurityCode\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryMonth\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryYear\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"holderName\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Hitelkártya\",\n \"type\": \"scheme\"\n}, {\n \"name\": \"PayPal\",\n \"type\": \"paypal\"\n}, {\n \"details\": [{\n \"details\": [{\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"dateOfBirth\",\n \"type\": \"date\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}],\n \"key\": \"personalDetails\",\n \"type\": \"fieldSet\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\",\n \"value\": \"NL\"\n}],\n \"key\": \"billingAddress\",\n \"type\": \"address\"\n}, {\n \"key\": \"separateDeliveryAddress\",\n \"optional\": true,\n \"type\": \"boolean\",\n \"value\": \"false\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\",\n \"value\": \"NL\"\n}],\n \"key\": \"deliveryAddress\",\n \"optional\": true,\n \"type\": \"address\"\n}],\n \"name\": \"AfterPay Invoice\",\n \"type\": \"afterpay_default\"\n}, {\n \"name\": \"Pay later with Klarna.\",\n \"type\": \"klarna\"\n}, {\n \"details\": [{\n \"key\": \"sepa.ownerName\",\n \"type\": \"text\"\n}, {\n \"key\": \"sepa.ibanNumber\",\n \"type\": \"text\"\n}],\n \"name\": \"SEPA Direct Debit\",\n \"type\": \"sepadirectdebit\"\n}, {\n \"name\": \"Paysafecard\",\n \"type\": \"paysafecard\"\n}, {\n \"name\": \"Bijenkorf Cadeaucard\",\n \"type\": \"bijcadeaucard\"\n}, {\n \"name\": \"Fonq Giftcard\",\n \"type\": \"fonqgiftcard\"\n}, {\n \"name\": \"Bank Transfer (NL)\",\n \"type\": \"bankTransfer_NL\"\n}, {\n \"name\": \"Pathe Giftcard\",\n \"type\": \"pathegiftcard\"\n}, {\n \"name\": \"VVV Giftcard\",\n \"type\": \"vvvgiftcard\"\n}, {\n \"name\": \"Podium Card\",\n \"type\": \"podiumcard\"\n}, {\n \"name\": \"RatePay Direct Debit\",\n \"type\": \"ratepay_directdebit\"\n}, {\n \"name\": \"Rituals Giftcard\",\n \"type\": \"rituals\"\n}, {\n \"name\": \"Hunkemoller Lingerie Card\",\n \"type\": \"hmlingerie\"\n}, {\n \"name\": \"Primera Cadeaukaart\",\n \"type\": \"primeracadeaucard\"\n}, {\n \"name\": \"Fashioncheque\",\n \"type\": \"fashioncheque\"\n}, {\n \"name\": \"NETELLER\",\n \"type\": \"neteller\"\n}, {\n \"name\": \"Adyen Voucher\",\n \"type\": \"adyen_test_voucher\"\n}, {\n \"name\": \"AfterPay B2B\",\n \"type\": \"afterpay_b2b\"\n}, {\n \"name\": \"AfterPay DirectDebit\",\n \"type\": \"afterpay_directdebit\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay_wap\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.androidpay.token\",\n \"type\": \"androidPayToken\"\n}],\n \"name\": \"Android Pay\",\n \"type\": \"androidpay\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.applepay.token\",\n \"type\": \"applePayToken\"\n}],\n \"name\": \"Apple Pay\",\n \"type\": \"applepay\"\n}, {\n \"name\": \"Baby Gift Card\",\n \"type\": \"babygiftcard\"\n}, {\n \"name\": \"SEPA Bank Transfer\",\n \"type\": \"bankTransfer_IBAN\"\n}, {\n \"name\": \"Bloemen Giftcard\",\n \"type\": \"bloemengiftcard\"\n}, {\n \"name\": \"Boekenbon Giftcard\",\n \"type\": \"boekenbon\"\n}, {\n \"name\": \"Cash-Ticket\",\n \"type\": \"cashticket\"\n}, {\n \"name\": \"Chasin Giftcard\",\n \"type\": \"chasingiftcard\"\n}, {\n \"name\": \"ClickandBuy\",\n \"type\": \"clickandbuy\"\n}, {\n \"name\": \"Costes Giftcard\",\n \"type\": \"costesgiftcard\"\n}, {\n \"name\": \"custom_settlement\",\n \"type\": \"custom_settlement\"\n}, {\n \"name\": \"eft_directdebit_CA\",\n \"type\": \"eft_directdebit_CA\"\n}, {\n \"name\": \"Nationale Entertainment Card\",\n \"type\": \"entertainmentcard\"\n}, {\n \"name\": \"Expert Cadeaukaart\",\n \"type\": \"expertgiftcard\"\n}, {\n \"name\": \"FijnCadeau\",\n \"type\": \"fijncadeau\"\n}, {\n \"name\": \"Fleurop Bloemenbon\",\n \"type\": \"fleuropbloemenbon\"\n}, {\n \"name\": \"Gall & Gall\",\n \"type\": \"gallgall\"\n}, {\n \"name\": \"Generic GiftCard\",\n \"type\": \"genericgiftcard\"\n}, {\n \"name\": \"GiftFor2\",\n \"type\": \"giftfor2card\"\n}, {\n \"name\": \"Givex\",\n \"type\": \"givex\"\n}, {\n \"name\": \"Goldsmiths Card\",\n \"type\": \"goldsmithscard\"\n}, {\n \"name\": \"Hunkemoller Member Card\",\n \"type\": \"hmclub\"\n}, {\n \"name\": \"Phone Payment\",\n \"type\": \"ivr\"\n}, {\n \"name\": \"Landline phone\",\n \"type\": \"ivrLandline\"\n}, {\n \"name\": \"Mobile phone\",\n \"type\": \"ivrMobile\"\n}, {\n \"name\": \"Kado Wereld\",\n \"type\": \"kadowereld\"\n}, {\n \"name\": \"Karen Millen GiftCard\",\n \"type\": \"karenmillengiftcard\"\n}, {\n \"name\": \"Leisure Card\",\n \"type\": \"leisurecard\"\n}, {\n \"name\": \"Loods5 Cadeaukaart\",\n \"type\": \"loods5giftcard\"\n}, {\n \"name\": \"Loods5 Tegoedbon\",\n \"type\": \"loods5prepaidcard\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.amazonPayToken\",\n \"type\": \"text\"\n}],\n \"name\": \"Amazon Pay\",\n \"supportsRecurring\": true,\n \"type\": \"amazonpay\"\n}, {\n \"name\": \"MOLPoints\",\n \"type\": \"molpay_points\"\n}, {\n \"name\": \"Moneybookers\",\n \"type\": \"moneybookers\"\n}, {\n \"name\": \"De Nationale Musicalcard\",\n \"type\": \"musicalcard\"\n}, {\n \"name\": \"Nationale Bioscoopbon\",\n \"type\": \"nationalebioscoopbon\"\n}, {\n \"name\": \"Nationale Tuinbon\",\n \"type\": \"nationaletuinbon\"\n}, {\n \"name\": \"Nationale Verwen Cadeaubon\",\n \"type\": \"nationaleverwencadeaubon\"\n}, {\n \"name\": \"Onebip\",\n \"type\": \"onebip\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.paywithgoogle.token\",\n \"type\": \"payWithGoogleToken\"\n}],\n \"name\": \"Google Pay\",\n \"type\": \"paywithgoogle\"\n}, {\n \"name\": \"Plastix\",\n \"type\": \"plastix\"\n}, {\n \"name\": \"Pluim\",\n \"type\": \"pluimgiftcard\"\n}, {\n \"name\": \"Illicado Gift Card\",\n \"type\": \"prosodie_illicado\"\n}, {\n \"name\": \"RatePay Invoice\",\n \"type\": \"ratepay\"\n}, {\n \"name\": \"Rob Peetoom Giftcard\",\n \"type\": \"robpeetoomgiftcard\"\n}, {\n \"name\": \"Shoes&Accessories Cadeau\",\n \"type\": \"sagiftcard\"\n}, {\n \"name\": \"Score Giftcard\",\n \"type\": \"scoregiftcard\"\n}, {\n \"name\": \"Premium SMS\",\n \"type\": \"sms\"\n}, {\n \"name\": \"SVS\",\n \"type\": \"svs\"\n}, {\n \"name\": \"TCS Test GiftCard\",\n \"type\": \"tcstestgiftcard\"\n}, {\n \"name\": \"The Sting Giftcard\",\n \"type\": \"thestinggiftcard\"\n}, {\n \"name\": \"Ukash\",\n \"type\": \"ukash\"\n}, {\n \"name\": \"UnionPay\",\n \"type\": \"unionpay\"\n}, {\n \"name\": \"Valuelink\",\n \"type\": \"valuelink\"\n}, {\n \"name\": \"V&D Cadeaukaart\",\n \"type\": \"vdcadeaucard\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.visacheckout.callId\",\n \"type\": \"text\"\n}],\n \"name\": \"Visa Checkout\",\n \"type\": \"visacheckout\"\n}, {\n \"name\": \"VVV Cadeaubon\",\n \"type\": \"vvvcadeaubon\"\n}, {\n \"name\": \"Webshop Giftcard\",\n \"type\": \"webshopgiftcard\"\n}, {\n \"name\": \"WE Fashion Giftcard\",\n \"type\": \"wefashiongiftcard\"\n}, {\n \"name\": \"Western Union\",\n \"type\": \"westernunion\"\n}, {\n \"name\": \"Winkel Cheque\",\n \"type\": \"winkelcheque\"\n}, {\n \"name\": \"Your Gift\",\n \"type\": \"yourgift\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl-NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
}
]
},
{
"name": "Get payment methods, including stored payment details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"paymentMethods\": [{\n \"details\": [{\n \"items\": [{\n \"id\": \"1121\",\n \"name\": \"Test Issuer\"\n}, {\n \"id\": \"1154\",\n \"name\": \"Test Issuer 5\"\n}, {\n \"id\": \"1153\",\n \"name\": \"Test Issuer 4\"\n}, {\n \"id\": \"1152\",\n \"name\": \"Test Issuer 3\"\n}, {\n \"id\": \"1151\",\n \"name\": \"Test Issuer 2\"\n}, {\n \"id\": \"1162\",\n \"name\": \"Test Issuer Cancelled\"\n}, {\n \"id\": \"1161\",\n \"name\": \"Test Issuer Pending\"\n}, {\n \"id\": \"1160\",\n \"name\": \"Test Issuer Refused\"\n}, {\n \"id\": \"1159\",\n \"name\": \"Test Issuer 10\"\n}, {\n \"id\": \"1158\",\n \"name\": \"Test Issuer 9\"\n}, {\n \"id\": \"1157\",\n \"name\": \"Test Issuer 8\"\n}, {\n \"id\": \"1156\",\n \"name\": \"Test Issuer 7\"\n}, {\n \"id\": \"1155\",\n \"name\": \"Test Issuer 6\"\n}],\n \"key\": \"issuer\",\n \"type\": \"select\"\n}],\n \"name\": \"iDEAL\",\n \"type\": \"ideal\"\n}, {\n \"details\": [{\n \"key\": \"encryptedCardNumber\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedSecurityCode\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryMonth\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"encryptedExpiryYear\",\n \"type\": \"cardToken\"\n}, {\n \"key\": \"holderName\",\n \"optional\": true,\n \"type\": \"text\"\n}],\n \"name\": \"Credit Card\",\n \"type\": \"scheme\"\n}, {\n \"name\": \"PayPal\",\n \"type\": \"paypal\"\n}, {\n \"details\": [{\n \"details\": [{\n \"key\": \"firstName\",\n \"type\": \"text\"\n}, {\n \"key\": \"lastName\",\n \"type\": \"text\"\n}, {\n \"key\": \"dateOfBirth\",\n \"type\": \"date\"\n}, {\n \"key\": \"telephoneNumber\",\n \"type\": \"tel\"\n}, {\n \"key\": \"shopperEmail\",\n \"type\": \"emailAddress\"\n}],\n \"key\": \"personalDetails\",\n \"type\": \"fieldSet\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\",\n \"value\": \"NL\"\n}],\n \"key\": \"billingAddress\",\n \"type\": \"address\"\n}, {\n \"key\": \"separateDeliveryAddress\",\n \"optional\": true,\n \"type\": \"boolean\",\n \"value\": \"false\"\n}, {\n \"details\": [{\n \"key\": \"street\",\n \"type\": \"text\"\n}, {\n \"key\": \"houseNumberOrName\",\n \"type\": \"text\"\n}, {\n \"key\": \"city\",\n \"type\": \"text\"\n}, {\n \"key\": \"postalCode\",\n \"type\": \"text\"\n}, {\n \"key\": \"stateOrProvince\",\n \"optional\": true,\n \"type\": \"text\"\n}, {\n \"items\": [{\n \"id\": \"NL\",\n \"name\": \"Netherlands\"\n}, {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n}],\n \"key\": \"country\",\n \"type\": \"select\",\n \"value\": \"NL\"\n}],\n \"key\": \"deliveryAddress\",\n \"optional\": true,\n \"type\": \"address\"\n}],\n \"name\": \"AfterPay Invoice\",\n \"type\": \"afterpay_default\"\n}, {\n \"name\": \"Pay later with Klarna.\",\n \"type\": \"klarna\"\n}, {\n \"details\": [{\n \"key\": \"sepa.ownerName\",\n \"type\": \"text\"\n}, {\n \"key\": \"sepa.ibanNumber\",\n \"type\": \"text\"\n}],\n \"name\": \"SEPA Direct Debit\",\n \"type\": \"sepadirectdebit\"\n}, {\n \"name\": \"Paysafecard\",\n \"type\": \"paysafecard\"\n}, {\n \"name\": \"Bijenkorf Cadeaucard\",\n \"type\": \"bijcadeaucard\"\n}, {\n \"name\": \"Fonq Giftcard\",\n \"type\": \"fonqgiftcard\"\n}, {\n \"name\": \"Bank Transfer (NL)\",\n \"type\": \"bankTransfer_NL\"\n}, {\n \"name\": \"Pathe Giftcard\",\n \"type\": \"pathegiftcard\"\n}, {\n \"name\": \"VVV Giftcard\",\n \"type\": \"vvvgiftcard\"\n}, {\n \"name\": \"Podium Card\",\n \"type\": \"podiumcard\"\n}, {\n \"name\": \"RatePay Direct Debit\",\n \"type\": \"ratepay_directdebit\"\n}, {\n \"name\": \"Rituals Giftcard\",\n \"type\": \"rituals\"\n}, {\n \"name\": \"Hunkemoller Lingerie Card\",\n \"type\": \"hmlingerie\"\n}, {\n \"name\": \"Primera Cadeaukaart\",\n \"type\": \"primeracadeaucard\"\n}, {\n \"name\": \"Fashioncheque\",\n \"type\": \"fashioncheque\"\n}, {\n \"name\": \"NETELLER\",\n \"type\": \"neteller\"\n}, {\n \"name\": \"Adyen Voucher\",\n \"type\": \"adyen_test_voucher\"\n}, {\n \"name\": \"AfterPay B2B\",\n \"type\": \"afterpay_b2b\"\n}, {\n \"name\": \"AfterPay DirectDebit\",\n \"type\": \"afterpay_directdebit\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay\"\n}, {\n \"name\": \"AliPay\",\n \"type\": \"alipay_wap\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.androidpay.token\",\n \"type\": \"androidPayToken\"\n}],\n \"name\": \"Android Pay\",\n \"type\": \"androidpay\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.applepay.token\",\n \"type\": \"applePayToken\"\n}],\n \"name\": \"Apple Pay\",\n \"type\": \"applepay\"\n}, {\n \"name\": \"Baby Gift Card\",\n \"type\": \"babygiftcard\"\n}, {\n \"name\": \"SEPA Bank Transfer\",\n \"type\": \"bankTransfer_IBAN\"\n}, {\n \"name\": \"Bloemen Giftcard\",\n \"type\": \"bloemengiftcard\"\n}, {\n \"name\": \"Boekenbon Giftcard\",\n \"type\": \"boekenbon\"\n}, {\n \"name\": \"Cash-Ticket\",\n \"type\": \"cashticket\"\n}, {\n \"name\": \"Chasin Giftcard\",\n \"type\": \"chasingiftcard\"\n}, {\n \"name\": \"ClickandBuy\",\n \"type\": \"clickandbuy\"\n}, {\n \"name\": \"Costes Giftcard\",\n \"type\": \"costesgiftcard\"\n}, {\n \"name\": \"custom_settlement\",\n \"type\": \"custom_settlement\"\n}, {\n \"name\": \"eft_directdebit_CA\",\n \"type\": \"eft_directdebit_CA\"\n}, {\n \"name\": \"Nationale Entertainment Card\",\n \"type\": \"entertainmentcard\"\n}, {\n \"name\": \"Expert Cadeaukaart\",\n \"type\": \"expertgiftcard\"\n}, {\n \"name\": \"FijnCadeau\",\n \"type\": \"fijncadeau\"\n}, {\n \"name\": \"Fleurop Bloemenbon\",\n \"type\": \"fleuropbloemenbon\"\n}, {\n \"name\": \"Gall & Gall\",\n \"type\": \"gallgall\"\n}, {\n \"name\": \"Generic GiftCard\",\n \"type\": \"genericgiftcard\"\n}, {\n \"name\": \"GiftFor2\",\n \"type\": \"giftfor2card\"\n}, {\n \"name\": \"Givex\",\n \"type\": \"givex\"\n}, {\n \"name\": \"Goldsmiths Card\",\n \"type\": \"goldsmithscard\"\n}, {\n \"name\": \"Hunkemoller Member Card\",\n \"type\": \"hmclub\"\n}, {\n \"name\": \"Phone Payment\",\n \"type\": \"ivr\"\n}, {\n \"name\": \"Landline phone\",\n \"type\": \"ivrLandline\"\n}, {\n \"name\": \"Mobile phone\",\n \"type\": \"ivrMobile\"\n}, {\n \"name\": \"Kado Wereld\",\n \"type\": \"kadowereld\"\n}, {\n \"name\": \"Karen Millen GiftCard\",\n \"type\": \"karenmillengiftcard\"\n}, {\n \"name\": \"Leisure Card\",\n \"type\": \"leisurecard\"\n}, {\n \"name\": \"Loods5 Cadeaukaart\",\n \"type\": \"loods5giftcard\"\n}, {\n \"name\": \"Loods5 Tegoedbon\",\n \"type\": \"loods5prepaidcard\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.amazonPayToken\",\n \"type\": \"text\"\n}],\n \"name\": \"Amazon Pay\",\n \"supportsRecurring\": true,\n \"type\": \"amazonpay\"\n}, {\n \"name\": \"MOLPoints\",\n \"type\": \"molpay_points\"\n}, {\n \"name\": \"Moneybookers\",\n \"type\": \"moneybookers\"\n}, {\n \"name\": \"De Nationale Musicalcard\",\n \"type\": \"musicalcard\"\n}, {\n \"name\": \"Nationale Bioscoopbon\",\n \"type\": \"nationalebioscoopbon\"\n}, {\n \"name\": \"Nationale Tuinbon\",\n \"type\": \"nationaletuinbon\"\n}, {\n \"name\": \"Nationale Verwen Cadeaubon\",\n \"type\": \"nationaleverwencadeaubon\"\n}, {\n \"name\": \"Onebip\",\n \"type\": \"onebip\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.paywithgoogle.token\",\n \"type\": \"payWithGoogleToken\"\n}],\n \"name\": \"Google Pay\",\n \"type\": \"paywithgoogle\"\n}, {\n \"name\": \"Plastix\",\n \"type\": \"plastix\"\n}, {\n \"name\": \"Pluim\",\n \"type\": \"pluimgiftcard\"\n}, {\n \"name\": \"Illicado Gift Card\",\n \"type\": \"prosodie_illicado\"\n}, {\n \"name\": \"RatePay Invoice\",\n \"type\": \"ratepay\"\n}, {\n \"name\": \"Rob Peetoom Giftcard\",\n \"type\": \"robpeetoomgiftcard\"\n}, {\n \"name\": \"Shoes&Accessories Cadeau\",\n \"type\": \"sagiftcard\"\n}, {\n \"name\": \"Score Giftcard\",\n \"type\": \"scoregiftcard\"\n}, {\n \"name\": \"Premium SMS\",\n \"type\": \"sms\"\n}, {\n \"name\": \"SVS\",\n \"type\": \"svs\"\n}, {\n \"name\": \"TCS Test GiftCard\",\n \"type\": \"tcstestgiftcard\"\n}, {\n \"name\": \"The Sting Giftcard\",\n \"type\": \"thestinggiftcard\"\n}, {\n \"name\": \"Ukash\",\n \"type\": \"ukash\"\n}, {\n \"name\": \"UnionPay\",\n \"type\": \"unionpay\"\n}, {\n \"name\": \"Valuelink\",\n \"type\": \"valuelink\"\n}, {\n \"name\": \"V&D Cadeaukaart\",\n \"type\": \"vdcadeaucard\"\n}, {\n \"details\": [{\n \"key\": \"additionalData.visacheckout.callId\",\n \"type\": \"text\"\n}],\n \"name\": \"Visa Checkout\",\n \"type\": \"visacheckout\"\n}, {\n \"name\": \"VVV Cadeaubon\",\n \"type\": \"vvvcadeaubon\"\n}, {\n \"name\": \"Webshop Giftcard\",\n \"type\": \"webshopgiftcard\"\n}, {\n \"name\": \"WE Fashion Giftcard\",\n \"type\": \"wefashiongiftcard\"\n}, {\n \"name\": \"Western Union\",\n \"type\": \"westernunion\"\n}, {\n \"name\": \"Winkel Cheque\",\n \"type\": \"winkelcheque\"\n}, {\n \"name\": \"Your Gift\",\n \"type\": \"yourgift\"\n}]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentMethods",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentMethods"
],
"variable": [
],
"query": [
]
},
"description": "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`). Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week."
}
}
]
}
]
},
{
"name": "/payments",
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ",
"item": [
{
"name": "Make an Apple Pay payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"applepay\",\n \"applePayToken\": \"VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Make a card payment with 3D Secure 2 native authentication",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4917610000000000\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"additionalData\": {\n \"allow3DS2\": \"true\"\n},\n \"accountInfo\": {\n \"accountCreationDate\": \"2019-01-17T13:42:40+01:00\"\n},\n \"billingAddress\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"street\": \"Redwood Block\",\n \"houseNumberOrName\": \"37C\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"10039\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\",\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\": \"nl-NL\",\n \"colorDepth\": 24,\n \"screenHeight\": 723,\n \"screenWidth\": 1536,\n \"timeZoneOffset\": 0,\n \"javaEnabled\": true\n},\n \"channel\": \"Web\",\n \"origin\": \"https://your-company.com\",\n \"returnUrl\": \"https://your-company.com/checkout/\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"044410\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9TI1O2\"\n},\n \"pspReference\": \"993617895005515H\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4917610000000000\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"additionalData\": {\n \"allow3DS2\": \"true\"\n},\n \"accountInfo\": {\n \"accountCreationDate\": \"2019-01-17T13:42:40+01:00\"\n},\n \"billingAddress\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"street\": \"Redwood Block\",\n \"houseNumberOrName\": \"37C\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"10039\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"192.0.2.1\",\n \"browserInfo\": {\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\n \"language\": \"nl-NL\",\n \"colorDepth\": 24,\n \"screenHeight\": 723,\n \"screenWidth\": 1536,\n \"timeZoneOffset\": 0,\n \"javaEnabled\": true\n},\n \"channel\": \"Web\",\n \"origin\": \"https://your-company.com\",\n \"returnUrl\": \"https://your-company.com/checkout/\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a card payment with 3D Secure redirect authentication",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4212345678901237\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"browserInfo\": {\n \"colorDepth\": 24,\n \"screenHeight\": 1800,\n \"screenWidth\": 2880,\n \"timeZoneOffset\": 60,\n \"language\": \"nl\",\n \"userAgent\": \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\": true\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"074516\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9SJ7DN\"\n},\n \"pspReference\": \"993617894903480A\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4212345678901237\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"browserInfo\": {\n \"colorDepth\": 24,\n \"screenHeight\": 1800,\n \"screenWidth\": 2880,\n \"timeZoneOffset\": 60,\n \"language\": \"nl\",\n \"userAgent\": \"Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0\",\n \"acceptHeader\": \"text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\",\n \"javaEnabled\": true\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a payment with 3D Secure 2 native authentication, using encrypted card details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4212345678901237\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"083996\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9SJH66\"\n},\n \"pspReference\": \"993617894905481G\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4212345678901237\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a card payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"036240\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9SJQUL\"\n},\n \"pspReference\": \"993617894906488A\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a card payment using encrypted card details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"064649\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9SM92L\"\n},\n \"pspReference\": \"993617894914488A\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4111111111111111\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Tokenize card details for one-off payments, using encrypted card details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryMonth\": \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedExpiryYear\": \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\",\n \"encryptedSecurityCode\": \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Tokenize card details for one-off payments",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"022966\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\": \"9916178934434753\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"recurring.shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9T0BB6\"\n},\n \"pspReference\": \"993617894947495G\",\n \"resultCode\": \"Authorised\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a Google Pay payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"paywithgoogle\",\n \"googlePayToken\": \"==Payload as retrieved from Google Pay response==\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"YourMerchantAccount\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Make an iDEAL payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"ideal\",\n \"issuer\": \"1121\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"resultCode\": \"RedirectShopper\",\n \"details\": [{\n \"key\": \"payload\",\n \"type\": \"text\"\n}],\n \"paymentData\": \"Ab02b4c0!BQABAgBOBkMn4vBx6T3DgxR+OR/a1zEA0xbGaYKP9mh/vWDSADlyktW39HZckwcm4Wr9kw2TvE9SYngEf9f6kZb1OimKls3+HEn3dRGOrTbWZZ8/tpmlS62YoDh1eQIE3EHZsUm7CQxhXjm8F0HQCelzIkVgj8DpLgtxwM3nFZxfpzl91HSt9CP/GIsx8S/RPVG2Fwg2S/jtdQ4MlFeG89S+icDvTecTyGoYFZlS/KL77Q4zJCR8Vgn4M9DJZEGRxv6kApLwDMkMyUMQngN95xDSCdLSW7fKkVusSub2+2hB7rzWxtj1E8R9dbtkCxgTe0F/G7tqrzUfEmseiHoKmaF6F8bN0j6BZiFhQJ/KHXJ6Pb+a7f0qYbQCAZmwYmeSSfNzqIDehyufpL0bP3w38spuso3QlhtPIqSHrIHDIQzbYmxPtt/I6A/RCMXJ7VN4nB6JigEygV383lnr8wd7mEynOQXnq9zEF+GGJy0Ool05WEy8L/mATgg++6bpsuSB2Wea5/VffvG6KcMyzs7OBG9zLAdYcrfqlsyXz/42UBJTeA2s6kVb1sBUfd6CQuQRF+37sjMwKiNIxwVaNWIYZMiWhbqPXOS4ozt0kNCtruhHqHgULPfF6aia/BnZKib6n+pBSepTdS47wZ31xC8VPqsoPia8RGNziLO/MmSMpW2fQRdgrhCrSniHb8qrh0vwgbPB4S7vAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifTMy2HjS+Bb81E9m0fQAZJXCA1BJgLgstBw3wxbdpZevF8c+pSBGUYNUm9ZbwrD93dGdCU2RvlI1gcyKke0cEEqKGjqWFXOWIYkSNzfLrgP3ERdp5t9VGZi6BDQko2CFzP4uAR3jwgR3AP0/mQ/4YWDrBrnYZCWjOpo7izGhNbHYvWbBOqVDvnfReoCrSNSLSo8OfSxuFrN6sJLXrajGu1qbPqQtxFIRyqLgbOfHLHw/DN3I+BZKGrNYynRfM2NparXTQ6ZRgC8E5xIodApr4JHMNeiPTjMlReaLBQwbcqaBzzRNLdV0v8/ZSXexS68WBeUMt7OkomYJBFrpwmpzgx/nzRzV87MZ9TGhZht/1zjcyaSi0Toc6r7UhbADuDX5RH5L0T8Q3iGJfjrYuS5h9aiYSg8oaVJ5DZhJAicDbb8eLvdAGXFTIV+EXbD+4e9Xl+c5um4FdKfufcrrUEo2s6lUuSBSJ3Gf6r+yJMxkamWwfnRUtxt+axRcXfmywYqU7O1r0zzW+RKCbV2qZeUWWeN1u5UIPdJbQbH4633ukPp//aGh8R4IWckBp7DGH4M5P1ZiYJB8OQRS5gD/y+iuwensnq1rKFBOK4gFNSpKmuDQYLeWb5VljHgE1sS4DRhl0fl8UCabehP+3tZu/2i88JTWbdUuvPLmkyv8zQdY36YeSDWmwC40vvbB+lo2e8MgVpfDwn+xyQFpFhasbEyr4VVoPwHq1sGR/QEutxmeoJi1Zux48jSHoGOj5RZ4ei+b8Lxp4rj45wwm0AiROghLnZJZfJaySp/LVxQ=\",\n \"redirect\": {\n \"method\": \"GET\",\n \"url\": \"https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1vozAQ-DXwFmQDAfLgh4jSC730Q1yoqr5Urr0NXIlNbUPj-PozXC6qqpOstTWz2p3Z9auigueSA2k50M5ng1IgmJ2hoq78VusBVMkJxiH2D6BYQ4VZMyYHYcgOtLk9YxeyFAb2ippWisDYHki*KfKf9-Xu5UdxV1Rl-t-MEZR2N4nRha7gDSY1QLRRrdh-IcygxBU1lKxWOMFptopXcZZEyc0l51e7J9XdcHpeDTxC4edG1pFF5WMHnw95FtHf3N5z1MWqipKjF17XXnTl99QewNk7zO4wQshXoOtqSxpjei9au0R3Oslo10htHJKhDDmINcDe5WB0I-selEM0qLFloN3z4W-ZUjB5cD4q4K0CZhwz4n-lzjm3YBrJvej626iduq-D9sJEzUNw2hw1qXONlpPA5STRBSsHtXANeyps4O4ZDILA16CnST-SruWtsSREIV6geIGyHU6cI7x0Ic6e-bOXaUuKsmlLpHCFJmXg6-dWzL*kH16DMQzOi0iTNE1xFsXBqRyfot1NwrPRFmGzPr4w3jTHGpX16S3*2H4Um22xB8u5-ANWgt0s\"\n}\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"ideal\",\n \"issuer\": \"1121\"\n},\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Make a Klarna payment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"YOUR_ORDER_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"klarna\"\n},\n \"amount\": {\n \"currency\": \"SEK\",\n \"value\": 1000\n},\n \"shopperLocale\": \"en_US\",\n \"countryCode\": \"SE\",\n \"telephoneNumber\": \"+46 840 839 298\",\n \"shopperEmail\": \"youremail@email.com\",\n \"shopperName\": {\n \"firstName\": \"Testperson-se\",\n \"lastName\": \"Approved\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"billingAddress\": {\n \"city\": \"Ankeborg\",\n \"country\": \"SE\",\n \"houseNumberOrName\": \"1\",\n \"postalCode\": \"12345\",\n \"street\": \"Stargatan\"\n},\n \"deliveryAddress\": {\n \"city\": \"Ankeborg\",\n \"country\": \"SE\",\n \"houseNumberOrName\": \"1\",\n \"postalCode\": \"12345\",\n \"street\": \"Stargatan\"\n},\n \"returnUrl\": \"https://www.your-company.com/...\",\n \"lineItems\": [{\n \"quantity\": 1,\n \"amountExcludingTax\": 331,\n \"taxPercentage\": 2100,\n \"description\": \"Shoes\",\n \"id\": \"Item #1\",\n \"taxAmount\": 69,\n \"amountIncludingTax\": 400,\n \"productUrl\": \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\": \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n}, {\n \"quantity\": 2,\n \"amountExcludingTax\": 248,\n \"taxPercentage\": 2100,\n \"description\": \"Socks\",\n \"id\": \"Item #2\",\n \"taxAmount\": 52,\n \"amountIncludingTax\": 300,\n \"productUrl\": \"URL_TO_PURCHASED_ITEM\",\n \"imageUrl\": \"URL_TO_PICTURE_OF_PURCHASED_ITEM\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Make a one-off payment with a token and CVV",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8416038790273850\",\n \"cvc\": \"737\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Make a one-off payment with a token and CVV, using encrypted card details",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"recurringDetailReference\": \"8416038790273850\",\n \"encryptedSecurityCode\": \"adyenjs_0_1_18$MT6ppy0FAMVMLH...\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_6738oneoff\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Make a card payment with a token",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8316038796685850\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"Subscription\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Split a payment between balance accounts",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"cvc\": \"737\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"amount\": {\n \"value\": 40000,\n \"currency\": \"USD\"\n},\n \"reference\": \"{{$guid}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"splits\": [{\n \"amount\": {\n \"value\": 39600\n},\n \"type\": \"BalanceAccount\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the sale amount\",\n \"description\": \"Your description for the sale amount\"\n}, {\n \"amount\": {\n \"value\": 400\n},\n \"type\": \"Commission\",\n \"reference\": \"Your reference for the commission\",\n \"description\": \"Your description for the commission\"\n}, {\n \"type\": \"PaymentFee\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the fees\",\n \"description\": \"Your description for the fees\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"eci\": \"N/A\",\n \"acquirerAccountCode\": \"YOUR_ACQUIRER_ACCOUNT\",\n \"xid\": \"N/A\",\n \"threeDAuthenticated\": \"false\",\n \"paymentMethodVariant\": \"visa\",\n \"issuerBin\": \"41111111\",\n \"payoutEligible\": \"Y\",\n \"fraudManualReview\": \"false\",\n \"threeDOffered\": \"false\",\n \"threeDOfferedResponse\": \"N/A\",\n \"authorisationMid\": \"50\",\n \"fundsAvailability\": \"I\",\n \"authorisedAmountCurrency\": \"USD\",\n \"threeDAuthenticatedResponse\": \"N/A\",\n \"avsResultRaw\": \"5\",\n \"retry.attempt1.rawResponse\": \"AUTHORISED\",\n \"paymentMethod\": \"visa\",\n \"avsResult\": \"5 No AVS data provided\",\n \"cardSummary\": \"1111\",\n \"retry.attempt1.avsResultRaw\": \"5\",\n \"networkTxReference\": \"777718270854480\",\n \"expiryDate\": \"3/2030\",\n \"cavvAlgorithm\": \"N/A\",\n \"cardBin\": \"411111\",\n \"alias\": \"8915844059375211\",\n \"cvcResultRaw\": \"M\",\n \"merchantReference\": \"YOUR_ORDER_NUMBER\",\n \"acquirerReference\": \"YOUR_ACQUIRER_REFERENCE\",\n \"cardIssuingCountry\": \"NL\",\n \"liabilityShift\": \"false\",\n \"fraudResultType\": \"GREEN\",\n \"authCode\": \"035450\",\n \"cardHolderName\": \"John Smith\",\n \"isCardCommercial\": \"unknown\",\n \"PaymentAccountReference\": \"6006491286999921374...\",\n \"retry.attempt1.acquirerAccount\": \"YOUR_ACQUIRER_ACCOUNT\",\n \"cardIssuingBank\": \"ISSUING_BANK_CUSTOMER\",\n \"retry.attempt1.acquirer\": \"YOUR_ACQUIRER_CODE\",\n \"authorisedAmountValue\": \"40000\",\n \"issuerCountry\": \"NL\",\n \"cvcResult\": \"1 Matches\",\n \"retry.attempt1.responseCode\": \"Approved\",\n \"aliasType\": \"Default\",\n \"retry.attempt1.shopperInteraction\": \"Ecommerce\",\n \"cardPaymentMethod\": \"visa\",\n \"acquirerCode\": \"YOUR_ACQUIRER_CODE\"\n},\n \"pspReference\": \"PPKFQ89R6QRXGN82\",\n \"resultCode\": \"Authorised\",\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 40000\n},\n \"merchantReference\": \"YOUR_ORDER_NUMBER\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"cvc\": \"737\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"amount\": {\n \"value\": 40000,\n \"currency\": \"USD\"\n},\n \"reference\": \"{{$guid}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"splits\": [{\n \"amount\": {\n \"value\": 39600\n},\n \"type\": \"BalanceAccount\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the sale amount\",\n \"description\": \"Your description for the sale amount\"\n}, {\n \"amount\": {\n \"value\": 400\n},\n \"type\": \"Commission\",\n \"reference\": \"Your reference for the commission\",\n \"description\": \"Your description for the commission\"\n}, {\n \"type\": \"PaymentFee\",\n \"account\": \"BA00000000000000000000001\",\n \"reference\": \"Your reference for the fees\",\n \"description\": \"Your description for the fees\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
},
{
"name": "Split a payment in a Classic Platforms integration",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"cvc\": \"737\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"amount\": {\n \"value\": 6200,\n \"currency\": \"EUR\"\n},\n \"reference\": \"{{$guid}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"splits\": [{\n \"amount\": {\n \"value\": 6000\n},\n \"type\": \"MarketPlace\",\n \"account\": \"151272963\",\n \"reference\": \"6124145\",\n \"description\": \"Porcelain Doll: Eliza (20cm)\"\n}, {\n \"amount\": {\n \"value\": 200\n},\n \"type\": \"Commission\",\n \"reference\": \"6124146\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
]
},
{
"name": "Tokenize card details for a subscription",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"additionalData\": {\n \"cvcResult\": \"1 Matches\",\n \"authCode\": \"004908\",\n \"avsResult\": \"4 AVS not supported for this card type\",\n \"recurring.recurringDetailReference\": \"9916178934434753\",\n \"recurringProcessingModel\": \"Subscription\",\n \"avsResultRaw\": \"4\",\n \"cvcResultRaw\": \"M\",\n \"refusalReasonRaw\": \"AUTHORISED\",\n \"recurring.shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"acquirerCode\": \"TestPmmAcquirer\",\n \"acquirerReference\": \"8PQMP9UV722\"\n},\n \"pspReference\": \"993617895153552A\",\n \"resultCode\": \"Authorised\",\n \"merchantReference\": \"string\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\",\n \"cvc\": \"737\"\n},\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"returnUrl\": \"https://your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
"payments"
],
"variable": [
],
"query": [
]
},
"description": "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. "
}
}
]
}
]
},
{
"name": "/payments/details",
"description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. ",
"item": [
{
"name": "Submit details for the 3D Secure payment ",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentData\": \"Hee57361f99....\",\n \"details\": {\n \"MD\": \"Ab02b4c0!BQABAgCW5sxB4e/==...\",\n \"PaRes\": \"eNrNV0mTo7gS...\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/details",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
"details"
],
"variable": [
],
"query": [
]
},
"description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. "
}
,"response": [
]
},
{
"name": "Submit 3D Secure 2 callenge flow result",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"details\": {\n \"threeds2.challengeResult\": \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\n},\n \"paymentData\": \"YOUR_PAYMENT_DATA\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/details",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
"details"
],
"variable": [
],
"query": [
]
},
"description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. "
}
,"response": [
]
},
{
"name": "Submit 3D Secure 2 device fingerprinting result",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"details\": {\n \"threeds2.fingerprint\": \"eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0=\"\n},\n \"paymentData\": \"YOUR_PAYMENT_DATA...\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/details",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
"details"
],
"variable": [
],
"query": [
]
},
"description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. "
}
,"response": [
]
},
{
"name": "Submit the redirect result",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"paymentData\": \"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...\",\n \"details\": {\n \"redirectResult\": \"X6XtfGC3!Y...\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/payments/details",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
"details"
],
"variable": [
],
"query": [
]
},
"description": "Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment. "
}
,"response": [
]
}
]
}
]
},
{
"name": "Payment links",
"item": [
{
"name": "/paymentLinks",
"description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).",
"item": [
{
"name": "Create a payment link",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"{{$guid}}\",\n \"amount\": {\n \"value\": 1250,\n \"currency\": \"BRL\"\n},\n \"countryCode\": \"BR\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\": \"test@email.com\",\n \"shopperLocale\": \"pt-BR\",\n \"billingAddress\": {\n \"street\": \"Roque Petroni Jr\",\n \"postalCode\": \"59000060\",\n \"city\": \"São Paulo\",\n \"houseNumberOrName\": \"999\",\n \"country\": \"BR\",\n \"stateOrProvince\": \"SP\"\n},\n \"deliveryAddress\": {\n \"street\": \"Roque Petroni Jr\",\n \"postalCode\": \"59000060\",\n \"city\": \"São Paulo\",\n \"houseNumberOrName\": \"999\",\n \"country\": \"BR\",\n \"stateOrProvince\": \"SP\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentLinks",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentLinks"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)."
}
,"response": [
{"name": "Created - the request has succeeded.",
"code": 201,
"status": "Created",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"amount\": {\n \"currency\": \"BRL\",\n \"value\": 1250\n},\n \"billingAddress\": {\n \"city\": \"São Paulo\",\n \"country\": \"BR\",\n \"houseNumberOrName\": \"999\",\n \"postalCode\": \"59000060\",\n \"stateOrProvince\": \"SP\",\n \"street\": \"Roque Petroni Jr\"\n},\n \"countryCode\": \"BR\",\n \"deliveryAddress\": {\n \"city\": \"São Paulo\",\n \"country\": \"BR\",\n \"houseNumberOrName\": \"999\",\n \"postalCode\": \"59000060\",\n \"stateOrProvince\": \"SP\",\n \"street\": \"Roque Petroni Jr\"\n},\n \"expiresAt\": \"2022-10-28T09:16:22Z\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\": \"YOUR_ORDER_NUMBER\",\n \"reusable\": false,\n \"shopperEmail\": \"test@email.com\",\n \"shopperLocale\": \"pt-BR\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"id\": \"PLE83C39B0A0DE0C1E\",\n \"status\": \"active\",\n \"url\": \"https://test.adyen.link/PLE83C39B0A0DE0C1E\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Idempotency-Key",
"value": "",
"description": "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reference\": \"{{$guid}}\",\n \"amount\": {\n \"value\": 1250,\n \"currency\": \"BRL\"\n},\n \"countryCode\": \"BR\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"shopperEmail\": \"test@email.com\",\n \"shopperLocale\": \"pt-BR\",\n \"billingAddress\": {\n \"street\": \"Roque Petroni Jr\",\n \"postalCode\": \"59000060\",\n \"city\": \"São Paulo\",\n \"houseNumberOrName\": \"999\",\n \"country\": \"BR\",\n \"stateOrProvince\": \"SP\"\n},\n \"deliveryAddress\": {\n \"street\": \"Roque Petroni Jr\",\n \"postalCode\": \"59000060\",\n \"city\": \"São Paulo\",\n \"houseNumberOrName\": \"999\",\n \"country\": \"BR\",\n \"stateOrProvince\": \"SP\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentLinks",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentLinks"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request. For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api)."
}
}
]
}
]
},
{
"name": "/paymentLinks/:linkId",
"description": "Retrieves the payment link details using the payment link `id`.",
"item": [
{
"name": "Get a payment link",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentLinks/:linkId",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentLinks",
":linkId"
],
"variable": [
{
"key": "linkId",
"value": "",
"description": "Unique identifier of the payment link."
}
],
"query": [
]
},
"description": "Retrieves the payment link details using the payment link `id`."
}
,"response": [
]
}
]
},
{
"name": "/paymentLinks/:linkId",
"description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).",
"item": [
{
"name": "Update the status of a payment link",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"expired\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentLinks/:linkId",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentLinks",
":linkId"
],
"variable": [
{
"key": "linkId",
"value": "",
"description": "Unique identifier of the payment link."
}
],
"query": [
]
},
"description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 8700\n},\n \"countryCode\": \"NL\",\n \"expiresAt\": \"2021-04-08T14:06:39Z\",\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\",\n \"reference\": \"shopper-reference-ekvL83\",\n \"shopperLocale\": \"hu-HU\",\n \"shopperReference\": \"shopper-reference-LZfdWZ\",\n \"status\": \"expired\",\n \"url\": \"https://test.adyen.link/PL61C53A8B97E6915A\",\n \"id\": \"PL61C53A8B97E6915A\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"expired\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentLinks/:linkId",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentLinks",
":linkId"
],
"variable": [
{
"key": "linkId",
"value": "",
"description": "Unique identifier of the payment link."
}
],
"query": [
]
},
"description": "Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status)."
}
}
]
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://checkout-test.adyen.com/v53",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "YOUR_MERCHANT_ACCOUNT",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink