diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..fd3d333 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +@jlengrand @gcatanese \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bb16ae9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +adyen-openapi +.idea +.DS_Store diff --git a/README.md b/README.md index 3537a84..ebe2fef 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# adyen-postman \ No newline at end of file +# Adyen Postman + + +This repository contains declaration files in the [Postman](https://postman.com/) format. The files are automatically generated based on the latest [adyen-openapi](https://github.com/adyen/adyen-openapi) definition files. +They are then uploaded on our [AdyenDev](https://www.postman.com/adyendev/) Postman space and you can fork it from there. You can also directly pick the `.json` files available here and upload them if you prefer. + +## Usage + +The preferred way to use these files is to fork the [Adyen APIs](https://adyendev.postman.co/workspace/Adyen-APIs~a8d63f9f-cfc7-4810-90c5-9e0c60030d3e) Postman workspace. This way you will be notified of new versions and changes. +However, in case you want to experiment, or simply want to keep your experiments private, you can also take any of the json files in this repository and upload them yourself. + +![Importing a json file as a Postman collection](./images/import-postman.gif) + + +## Contributing + +We encourage you to contribute to our repository. Find out more in our [contribution guidelines](https://github.com/Adyen/.github/blob/master/CONTRIBUTING.md). +However, for anything related to our APIs, the correct repository to contribute to would be [adyen-openapi](https://github.com/adyen/adyen-openapi). + +## Setup + +* `generateAll.sh` generates all postman API collection files for all versions of the OpenAPI definitions and places them in the postman folder. It is meant to run inside the [dedicated docker image](https://github.com/gcatanese/openapi-generator-postman-v2/). +* `runDocker.sh` is the script that actually runs `generateAll.sh` inside the docker image. + +This step should only be done for initial setup, or if something goes wrong. Most work should be automated in the GitHub workflows. + +## Documentation +Link to relevant documentation and next steps that have to be taken. + +## Support +If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://www.adyen.help/hc/en-us/requests/new). + +## License +MIT license. For more information, see the LICENSE file. \ No newline at end of file diff --git a/generateAll.sh b/generateAll.sh new file mode 100755 index 0000000..c256caa --- /dev/null +++ b/generateAll.sh @@ -0,0 +1,39 @@ +#!/bin/sh + +# Sets working tools +if [[ $OSTYPE == 'darwin'* ]]; then + echo "MacOS detected. Alias sed to gsed." + alias sed=gsed +fi + +DATE=$(date +"%Y-%m-%d") +# We allow only non classic, non webhook APIs +ALLOW_LIST="BalanceControlService|BalancePlatformService|BinLookupService|CheckoutService|DataProtectionService|LegalEntityService|ManagementService|PayoutService|RecurringService|StoredValueService|TestCardService|TfmAPIService|TransferService" + +for entry in "adyen-openapi/yaml"/* +do + echo "Processing $entry" + if echo "$entry" | grep -q -E "$ALLOW_LIST"; then + echo "$entry is part of the allow list. Generating" + FILENAME=$entry + BASE=$(echo "$(basename "${FILENAME%.*}")") + NAME=$(echo $FILENAME | sed 's/-.*//' | sed 's/.*\///') + REAL_NAME=$(sed '/title:/!d;q' $FILENAME | sed 's/.*://') + VERSION=$(echo $FILENAME | sed 's/.*-v//' | sed 's/\..*//') + + # echo "Generating $FILENAME $BASE $NAME $REAL_NAME $VERSION $DATE" + + sed -i.bak "1s/.*/openapi: 3.0.3/" $FILENAME # downgrade version for compat + sed -i.bak2 "0,/title:.*/{s//title: $REAL_NAME\ (v$VERSION)/}" $FILENAME # Set unique name of API for Postman + + /script.sh generate \ + --additional-properties postmanVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM,generatedVariables=YOUR_REFERENCE_NUMBER-YOUR_REFERENCE-YOUR_ORDER_NUMBER-YOUR_ORDER_NUMBER\ + -i $FILENAME \ + -o postman/$BASE + + mv postman/$BASE/postman.json postman/$BASE.json + rm -rf postman/$BASE + else + echo "$entry is NOT part of the allow list. Skipping" + fi +done \ No newline at end of file diff --git a/images/import-postman.gif b/images/import-postman.gif new file mode 100644 index 0000000..30f84b1 Binary files /dev/null and b/images/import-postman.gif differ diff --git a/postman/.keep b/postman/.keep new file mode 100644 index 0000000..e69de29 diff --git a/postman/BalanceControlService-v1.json b/postman/BalanceControlService-v1.json new file mode 100644 index 0000000..ca26bdf --- /dev/null +++ b/postman/BalanceControlService-v1.json @@ -0,0 +1,91 @@ +{ + "info": { + "name": "Adyen Balance Control API (v1)", + "description": { + "content": "The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account.\n\n## Authentication\nTo connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key:\n\n```\ncurl\n-H \"X-API-Key: Your_API_key\" \\n-H \"Content-Type: application/json\" \\n...\n```\nNote that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Balance Control 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\n```\nhttps://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer\n```\n", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/balanceTransfer", + "description": "Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. ", + "item": [ + { + "name": "Transfer balances between merchant accounts", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 50000,\n \"currency\": \"EUR\"\n},\n \"description\": \"Your description for the transfer\",\n \"fromMerchant\": \"MerchantAccount_NL\",\n \"toMerchant\": \"MerchantAccount_DE\",\n \"type\": \"debit\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceTransfer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceTransfer" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. " + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BalanceControl/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/BalancePlatformService-v2.json b/postman/BalancePlatformService-v2.json new file mode 100644 index 0000000..840aef3 --- /dev/null +++ b/postman/BalancePlatformService-v2.json @@ -0,0 +1,1728 @@ +{ + "info": { + "name": "Configuration API (v2)", + "description": { + "content": "The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Versioning\nThe Configuration 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://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v2`.", + "type": "text/markdown" + }, + "version": "2", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Platform", + "item": [ + { + "name": "/balancePlatforms/{{id}}", + "description": "Returns a balance platform.", + "item": [ + { + "name": "Get a balance platform", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + ] + }, + "description": "Returns a balance platform." + } + } + ] + }, + { + "name": "/balancePlatforms/{{id}}/accountHolders", + "description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.", + "item": [ + { + "name": "Get all account holders under a balance platform", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balancePlatforms/{{id}}/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balancePlatforms", + "{{id}}", + "accountHolders" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance platform." + } + ], + "query": [ + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`." + } + } + ] + } + ] + }, + { + "name": "Payment instrument groups", + "item": [ + { + "name": "/paymentInstrumentGroups/{{id}}", + "description": "Returns the details of a payment instrument group.", + "item": [ + { + "name": "Get a payment instrument group", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument group." + } + } + ] + }, + { + "name": "/paymentInstrumentGroups/{{id}}/transactionRules", + "description": "Returns a list of all the transaction rules associated with a payment instrument group.", + "item": [ + { + "name": "Get all transaction rules for a payment instrument group", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups/{{id}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups", + "{{id}}", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument group." + } + ], + "query": [ + ] + }, + "description": "Returns a list of all the transaction rules associated with a payment instrument group." + } + } + ] + }, + { + "name": "/paymentInstrumentGroups", + "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.", + "item": [ + { + "name": "Create a payment instrument group", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balancePlatform\": \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\": \"mc\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstrumentGroups", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstrumentGroups" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group." + } + } + ] + } + ] + }, + { + "name": "Account holders", + "item": [ + { + "name": "/accountHolders/{{id}}", + "description": "Returns an account holder.", + "item": [ + { + "name": "Get an account holder", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Returns an account holder." + } + } + ] + }, + { + "name": "/accountHolders/{{id}}/balanceAccounts", + "description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.", + "item": [ + { + "name": "Get all balance accounts of an account holder", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/{{id}}/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + "{{id}}", + "balanceAccounts" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`." + } + } + ] + }, + { + "name": "/accountHolders/{{id}}", + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.", + "item": [ + { + "name": "Request account holder capability", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"capabilities\": {\n \"receivePayments\": {\n \"requested\": true\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." + } + }, + { + "name": "Deactivate an account holder", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"closed\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the account holder." + } + ], + "query": [ + ] + }, + "description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged." + } + } + ] + }, + { + "name": "/accountHolders", + "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). ", + "item": [ + { + "name": "Create an account holder", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/accountHolders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "accountHolders" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). " + } + } + ] + } + ] + }, + { + "name": "Payment instruments", + "item": [ + { + "name": "/paymentInstruments/{{id}}", + "description": "Returns the details of a payment instrument.", + "item": [ + { + "name": "Get a payment instrument", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a payment instrument." + } + } + ] + }, + { + "name": "/paymentInstruments/{{id}}/transactionRules", + "description": "Returns a list of transaction rules associated with a payment instrument.", + "item": [ + { + "name": "Get all transaction rules for a payment instrument", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/{{id}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + "{{id}}", + "transactionRules" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Returns a list of transaction rules associated with a payment instrument." + } + } + ] + }, + { + "name": "/paymentInstruments/{{id}}", + "description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.", + "item": [ + { + "name": "Update the balance account linked to a payment instrument", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\": \"BA32272223222B5CM82WL892M\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card." + } + }, + { + "name": "Update the status of a payment instrument", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"suspended\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the payment instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card." + } + } + ] + }, + { + "name": "/paymentInstruments", + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).", + "item": [ + { + "name": "Create a business account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." + } + }, + { + "name": "Create a physical card", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"card\",\n \"issuingCountryCode\": \"NL\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S.Hopper - Main card\",\n \"status\": \"Inactive\",\n \"card\": {\n \"formFactor\": \"physical\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Sam Hopper\",\n \"deliveryContact\": {\n \"address\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"stateOrProvince\": \"NH\",\n \"line1\": \"Brannan Street\",\n \"line2\": \"274\",\n \"postalCode\": \"1020CD\"\n},\n \"name\": {\n \"firstName\": \"Sam\",\n \"lastName\": \"Hopper\"\n}\n},\n \"configuration\": {\n \"configurationProfileId\": \"CP123AB45678C91ABCD2ABCDE\"\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." + } + }, + { + "name": "Create a virtual card", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"card\",\n \"description\": \"S. Hopper - Main card\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Sam Hopper\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"formFactor\": \"virtual\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)." + } + } + ] + } + ] + }, + { + "name": "Balance accounts", + "item": [ + { + "name": "/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "description": "Deletes a sweep for a balance account.", + "item": [ + { + "name": "Delete a sweep", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps", + "{{sweepId}}" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Deletes a sweep for a balance account." + } + } + ] + }, + { + "name": "/balanceAccounts/{{balanceAccountId}}/sweeps", + "description": "Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.", + "item": [ + { + "name": "Get all sweeps for a balance account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`." + } + } + ] + }, + { + "name": "/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "description": "Returns a sweep.", + "item": [ + { + "name": "Get a sweep", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps", + "{{sweepId}}" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Returns a sweep." + } + } + ] + }, + { + "name": "/balanceAccounts/{{id}}", + "description": "Returns a balance account.", + "item": [ + { + "name": "Get a balance account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Returns a balance account." + } + } + ] + }, + { + "name": "/balanceAccounts/{{id}}/paymentInstruments", + "description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.", + "item": [ + { + "name": "Get all payment instruments for a balance account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{id}}/paymentInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{id}}", + "paymentInstruments" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`." + } + } + ] + }, + { + "name": "/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.", + "item": [ + { + "name": "Update the status of a sweep", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps", + "{{sweepId}}" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + }, + { + "key": "sweepId", + "value": "", + "description": "The unique identifier of the sweep." + } + ], + "query": [ + ] + }, + "description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged." + } + } + ] + }, + { + "name": "/balanceAccounts/{{id}}", + "description": "Updates a balance account.", + "item": [ + { + "name": "Update a balance account", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\": \"\",\n \"defaultCurrencyCode\": \"\",\n \"description\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"timeZone\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Updates a balance account." + } + } + ] + }, + { + "name": "/balanceAccounts", + "description": "Creates a balance account that holds the funds of the associated account holder.", + "item": [ + { + "name": "Create a balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountHolderId\": \"AH32272223222B59K6ZKBBFNQ\",\n \"description\": \"S.Hopper - Main balance account\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a balance account that holds the funds of the associated account holder." + } + } + ] + }, + { + "name": "/balanceAccounts/{{balanceAccountId}}/sweeps", + "description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.", + "item": [ + { + "name": "Create a sweep to pull funds in to a balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\": {\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"balance\"\n},\n \"type\": \"pull\",\n \"status\": \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination." + } + }, + { + "name": "Create a sweep to push funds out of a balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"counterparty\": {\n \"balanceAccountId\": \"BA32278887611B5FTD2KR6TJD\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/balanceAccounts/{{balanceAccountId}}/sweeps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "balanceAccounts", + "{{balanceAccountId}}", + "sweeps" + ], + "variable": [ + { + "key": "balanceAccountId", + "value": "", + "description": "The unique identifier of the balance account." + } + ], + "query": [ + ] + }, + "description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination." + } + } + ] + } + ] + }, + { + "name": "Transaction rules", + "item": [ + { + "name": "/transactionRules/{{transactionRuleId}}", + "description": "Deletes a transaction rule.", + "item": [ + { + "name": "Delete a transaction rule", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/{{transactionRuleId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + "{{transactionRuleId}}" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Deletes a transaction rule." + } + } + ] + }, + { + "name": "/transactionRules/{{transactionRuleId}}", + "description": "Returns the details of a transaction rule.", + "item": [ + { + "name": "Get a transaction rule", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/{{transactionRuleId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + "{{transactionRuleId}}" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transaction rule." + } + } + ] + }, + { + "name": "/transactionRules/{{transactionRuleId}}", + "description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.", + "item": [ + { + "name": "Update the status of transaction rule", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"inactive\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules/{{transactionRuleId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules", + "{{transactionRuleId}}" + ], + "variable": [ + { + "key": "transactionRuleId", + "value": "", + "description": "The unique identifier of the transaction rule." + } + ], + "query": [ + ] + }, + "description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource." + } + } + ] + }, + { + "name": "/transactionRules", + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples).", + "item": [ + { + "name": "Allow only point-of-sale transactions", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Allow only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5BPCMFXD2XG\"\n},\n \"status\": \"active\",\n \"interval\": {\n \"type\": \"perTransaction\"\n},\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"type\": \"blockList\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." + } + }, + { + "name": "Increase the score of a card", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\": {\n \"entityReference\": \"PI3227C223222B5FN65FN5NS9\",\n \"entityType\": \"paymentInstrument\"\n},\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": 2,\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"scoreBased\",\n \"reference\": \"myRule11789\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n}\n}\n},\n \"score\": 20,\n \"type\": \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." + } + }, + { + "name": "Limit total amount in the last 12 hours", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\": \"{{$guid}}_2918A\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityReference\": \"BA3227C223222B5FN65355NR3\",\n \"entityType\": \"balanceAccount\"\n},\n \"aggregationLevel\": \"paymentInstrument\",\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": \"12\",\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"value\": 100000,\n \"currency\": \"EUR\"\n}\n}\n},\n \"type\": \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." + } + }, + { + "name": "Limit international payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"Up to 50 EUR international transactions\",\n \"reference\": \"{{$guid}}_B2634\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityType\": \"balanceAccount\",\n \"entityReference\": \"BA3227C223222B5FN65355NR3\"\n},\n \"interval\": {\n \"type\": \"daily\"\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n},\n \"internationalTransaction\": {\n \"operation\": \"equals\",\n \"value\": true\n}\n},\n \"type\": \"velocity\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactionRules", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactionRules" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)." + } + } + ] + } + ] + } + ], + "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://balanceplatform-api-test.adyen.com/bcl/v2", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_BALANCE_PLATFORM", + "value": "", + "type": "string" + }, + { + "key": "balanceAccountId", + "value": "balanceAccountId_example", + "type": "string" + }, + { + "key": "transactionRuleId", + "value": "transactionRuleId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + }, + { + "key": "sweepId", + "value": "sweepId_example", + "type": "string" + } + ] +} + diff --git a/postman/BinLookupService-v40.json b/postman/BinLookupService-v40.json new file mode 100644 index 0000000..83bdbc8 --- /dev/null +++ b/postman/BinLookupService-v40.json @@ -0,0 +1,297 @@ +{ + "info": { + "name": "Adyen BinLookup API (v40)", + "description": { + "content": "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nThe BinLookup 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://pal-test.adyen.com/pal/servlet/BinLookup/v40/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v40/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "40", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/get3dsAvailability", + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", + "item": [ + { + "name": "Get 3D Secure availability", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." + } + } + ] + }, + { + "name": "/getCostEstimate", + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", + "item": [ + { + "name": "Estimate the transaction cost", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost using an encrypted card number", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"encryptedCardNumber\": \"test_5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal with 3DSecure)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (recurring contract)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"selectedRecurringDetailReference\": \"1234567890123456\",\n \"shopperInteraction\": \"Ecommerce\",\n \"shopperReference\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BinLookup/v40", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/BinLookupService-v50.json b/postman/BinLookupService-v50.json new file mode 100644 index 0000000..5c9d5a6 --- /dev/null +++ b/postman/BinLookupService-v50.json @@ -0,0 +1,297 @@ +{ + "info": { + "name": "Adyen BinLookup API (v50)", + "description": { + "content": "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nThe BinLookup 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://pal-test.adyen.com/pal/servlet/BinLookup/v50/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v50/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "50", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/get3dsAvailability", + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", + "item": [ + { + "name": "Get 3D Secure availability", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." + } + } + ] + }, + { + "name": "/getCostEstimate", + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", + "item": [ + { + "name": "Estimate the transaction cost", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost using an encrypted card number", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"encryptedCardNumber\": \"test_5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal with 3DSecure)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (recurring contract)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"selectedRecurringDetailReference\": \"1234567890123456\",\n \"shopperInteraction\": \"Ecommerce\",\n \"shopperReference\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BinLookup/v50", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/BinLookupService-v52.json b/postman/BinLookupService-v52.json new file mode 100644 index 0000000..db10a2d --- /dev/null +++ b/postman/BinLookupService-v52.json @@ -0,0 +1,297 @@ +{ + "info": { + "name": "Adyen BinLookup API (v52)", + "description": { + "content": "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nThe BinLookup 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://pal-test.adyen.com/pal/servlet/BinLookup/v52/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v52/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "52", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/get3dsAvailability", + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", + "item": [ + { + "name": "Get 3D Secure availability", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." + } + } + ] + }, + { + "name": "/getCostEstimate", + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", + "item": [ + { + "name": "Estimate the transaction cost", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost using an encrypted card number", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"encryptedCardNumber\": \"test_5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal with 3DSecure)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (recurring contract)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"selectedRecurringDetailReference\": \"1234567890123456\",\n \"shopperInteraction\": \"Ecommerce\",\n \"shopperReference\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BinLookup/v52", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/BinLookupService-v53.json b/postman/BinLookupService-v53.json new file mode 100644 index 0000000..89d41d3 --- /dev/null +++ b/postman/BinLookupService-v53.json @@ -0,0 +1,297 @@ +{ + "info": { + "name": "Adyen BinLookup API (v53)", + "description": { + "content": "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nThe BinLookup 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://pal-test.adyen.com/pal/servlet/BinLookup/v53/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v53/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "53", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/get3dsAvailability", + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", + "item": [ + { + "name": "Get 3D Secure availability", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." + } + } + ] + }, + { + "name": "/getCostEstimate", + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", + "item": [ + { + "name": "Estimate the transaction cost", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost using an encrypted card number", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"encryptedCardNumber\": \"test_5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal with 3DSecure)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (recurring contract)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"selectedRecurringDetailReference\": \"1234567890123456\",\n \"shopperInteraction\": \"Ecommerce\",\n \"shopperReference\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BinLookup/v53", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/BinLookupService-v54.json b/postman/BinLookupService-v54.json new file mode 100644 index 0000000..01f95ee --- /dev/null +++ b/postman/BinLookupService-v54.json @@ -0,0 +1,297 @@ +{ + "info": { + "name": "Adyen BinLookup API (v54)", + "description": { + "content": "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nThe BinLookup 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://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "54", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/get3dsAvailability", + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).", + "item": [ + { + "name": "Get 3D Secure availability", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"4111111111111111\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/get3dsAvailability", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "get3dsAvailability" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies whether 3D Secure is available for the specified BIN or card brand. For 3D Secure 2, this endpoint also returns device fingerprinting keys. For more information, refer to [3D Secure 2](https://docs.adyen.com/online-payments/3d-secure/native-3ds2)." + } + } + ] + }, + { + "name": "/getCostEstimate", + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter.", + "item": [ + { + "name": "Estimate the transaction cost", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost using an encrypted card number", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"encryptedCardNumber\": \"test_5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"shopperInteraction\": \"Ecommerce\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (minimal with 3DSecure)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"cardNumber\": \"5101180000000007\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + }, + { + "name": "Estimate the transaction cost (recurring contract)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 1234,\n \"currency\": \"EUR\"\n},\n \"assumptions\": {\n \"assumeLevel3Data\": true,\n \"assume3DSecureAuthenticated\": true\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantDetails\": {\n \"countryCode\": \"NL\",\n \"mcc\": \"7411\",\n \"enrolledIn3DSecure\": true\n},\n \"selectedRecurringDetailReference\": \"1234567890123456\",\n \"shopperInteraction\": \"Ecommerce\",\n \"shopperReference\": \"123456\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getCostEstimate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getCostEstimate" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": ">This API is available only for merchants operating in Australia, the EU, and the UK. Use the Adyen Cost Estimation API to pre-calculate interchange and scheme fee costs. Knowing these costs prior actual payment authorisation gives you an opportunity to charge those costs to the cardholder, if necessary. To retrieve this information, make the call to the `/getCostEstimate` endpoint. The response to this call contains the amount of the interchange and scheme fees charged by the network for this transaction, and also which surcharging policy is possible (based on current regulations). > Since not all information is known in advance (for example, if the cardholder will successfully authenticate via 3D Secure or if you also plan to provide additional Level 2/3 data), the returned amounts are based on a set of assumption criteria you define in the `assumptions` parameter." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/BinLookup/v54", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v37.json b/postman/CheckoutService-v37.json new file mode 100644 index 0000000..7e99da7 --- /dev/null +++ b/postman/CheckoutService-v37.json @@ -0,0 +1,1845 @@ +{ + "info": { + "name": "Adyen Checkout API (v37)", + "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/v37/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/v37/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=37) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "37", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit details for the payment with involved app switch", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\": \"Hee57361f99....\",\n \"details\": {\n \"returnUrlQueryString\": \"ref=eNrNV0mTo7gS&id=An78i...\"\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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v37", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v40.json b/postman/CheckoutService-v40.json new file mode 100644 index 0000000..0369fef --- /dev/null +++ b/postman/CheckoutService-v40.json @@ -0,0 +1,2189 @@ +{ + "info": { + "name": "Adyen Checkout API (v40)", + "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/v40/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/v40/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=40) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "40", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.3.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"browserInfo\": {\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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"recurringDetailReference\": \"8315791039321763\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\"\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 Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit details for the payment with involved app switch", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentData\": \"Hee57361f99....\",\n \"details\": {\n \"returnUrlQueryString\": \"ref=eNrNV0mTo7gS&id=An78i...\"\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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v40", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v41.json b/postman/CheckoutService-v41.json new file mode 100644 index 0000000..9bf29f3 --- /dev/null +++ b/postman/CheckoutService-v41.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v41)", + "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/v41/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/v41/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=41) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "41", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"street\": \"Haarlem\",\n \"city\": \"New York\",\n \"houseNumberOrName\": \"37\",\n \"stateOrProvince\": \"CA\",\n \"postalCode\": \"10BA\"\n},\n \"shopperEmail\": \"s.hopper@test.com\",\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"browserInfo\": {\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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"recurringDetailReference\": \"8315791039321763\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\"\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 Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v41", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v46.json b/postman/CheckoutService-v46.json new file mode 100644 index 0000000..590ced8 --- /dev/null +++ b/postman/CheckoutService-v46.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v46)", + "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/v46/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/v46/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=46) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "46", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4917610000000000\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"holderName\": \"John Smith\",\n \"encryptedSecurityCode\": \"test_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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"browserInfo\": {\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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"recurringDetailReference\": \"8315791039321763\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"shopperInteraction\": \"ContAuth\"\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 Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v46", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v49.json b/postman/CheckoutService-v49.json new file mode 100644 index 0000000..b1a8332 --- /dev/null +++ b/postman/CheckoutService-v49.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v49)", + "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/v49/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/v49/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=49) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "49", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"browserInfo\": {\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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"storeDetails\": true\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v49", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v50.json b/postman/CheckoutService-v50.json new file mode 100644 index 0000000..532eb62 --- /dev/null +++ b/postman/CheckoutService-v50.json @@ -0,0 +1,2406 @@ +{ + "info": { + "name": "Adyen Checkout API (v50)", + "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/v50/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/v50/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=50) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "50", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"browserInfo\": {\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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v50", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v51.json b/postman/CheckoutService-v51.json new file mode 100644 index 0000000..f0087c2 --- /dev/null +++ b/postman/CheckoutService-v51.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v51)", + "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/v51/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/v51/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=51) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "51", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v51", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v52.json b/postman/CheckoutService-v52.json new file mode 100644 index 0000000..1d71031 --- /dev/null +++ b/postman/CheckoutService-v52.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v52)", + "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/v52/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/v52/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=52) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "52", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v52", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v53.json b/postman/CheckoutService-v53.json new file mode 100644 index 0000000..c1c7788 --- /dev/null +++ b/postman/CheckoutService-v53.json @@ -0,0 +1,2363 @@ +{ + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v64.json b/postman/CheckoutService-v64.json new file mode 100644 index 0000000..81ea052 --- /dev/null +++ b/postman/CheckoutService-v64.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v64)", + "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/v64/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/v64/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=64) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "64", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v64", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v65.json b/postman/CheckoutService-v65.json new file mode 100644 index 0000000..b565f9a --- /dev/null +++ b/postman/CheckoutService-v65.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v65)", + "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/v65/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/v65/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=65) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "65", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v65", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v66.json b/postman/CheckoutService-v66.json new file mode 100644 index 0000000..62b5166 --- /dev/null +++ b/postman/CheckoutService-v66.json @@ -0,0 +1,2363 @@ +{ + "info": { + "name": "Adyen Checkout API (v66)", + "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/v66/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/v66/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=66) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "66", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 callenge flow result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit 3D Secure 2 device fingerprinting result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v66", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v67.json b/postman/CheckoutService-v67.json new file mode 100644 index 0000000..fb3349e --- /dev/null +++ b/postman/CheckoutService-v67.json @@ -0,0 +1,2275 @@ +{ + "info": { + "name": "Adyen Checkout API (v67)", + "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/v67/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/v67/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=67) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "67", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 (DEPRECATED)", + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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 3D Secure 2 authentication result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\": {\n \"threeDSResult\": \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\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. " + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v67", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v68.json b/postman/CheckoutService-v68.json new file mode 100644 index 0000000..004e617 --- /dev/null +++ b/postman/CheckoutService-v68.json @@ -0,0 +1,2410 @@ +{ + "info": { + "name": "Adyen Checkout API (v68)", + "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/v68/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/v68/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=68) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "68", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 (DEPRECATED)", + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"additionalData\": {\n \"allow3DS2\": true\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"googlepay\",\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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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 3D Secure 2 authentication result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\": {\n \"threeDSResult\": \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\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. " + } + } + ] + }, + { + "name": "/sessions", + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", + "item": [ + { + "name": "Create a payment session", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Create a payment session including Klarna fields", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"YOUR_ORDER_REFERENCE\",\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 \"gender\": \"UNKNOWN\",\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 \"dateOfBirth\": \"1996-09-04\",\n \"socialSecurityNumber\": \"0108\",\n \"returnUrl\": \"https: //example.org\",\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 {\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}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"TestMerchantCheckout\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v68", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v69.json b/postman/CheckoutService-v69.json new file mode 100644 index 0000000..27cd9ca --- /dev/null +++ b/postman/CheckoutService-v69.json @@ -0,0 +1,2410 @@ +{ + "info": { + "name": "Adyen Checkout API (v69)", + "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/v69/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/v69/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=69) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "69", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"reason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 (DEPRECATED)", + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"authenticationData\": {\n \"threeDSRequestData\": {\n \"nativeThreeDS\": \"preferred\"\n}\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\n \"lastName\": \"Approved\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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 3D Secure 2 authentication result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\": {\n \"threeDSResult\": \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\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. " + } + } + ] + }, + { + "name": "/sessions", + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", + "item": [ + { + "name": "Create a payment session", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Create a payment session including Klarna fields", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"YOUR_ORDER_REFERENCE\",\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 \"gender\": \"UNKNOWN\",\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 \"dateOfBirth\": \"1996-09-04\",\n \"socialSecurityNumber\": \"0108\",\n \"returnUrl\": \"https: //example.org\",\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 {\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}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"TestMerchantCheckout\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v69", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/CheckoutService-v70.json b/postman/CheckoutService-v70.json new file mode 100644 index 0000000..4b9a1d9 --- /dev/null +++ b/postman/CheckoutService-v70.json @@ -0,0 +1,2524 @@ +{ + "info": { + "name": "Adyen Checkout API (v70)", + "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/v70/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/v70/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=70) to find out what changed in this version!", + "type": "text/markdown" + }, + "version": "70", + "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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"paymentReference\": \"\",\n \"reference\": \"\"\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 an authorised amount", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"industryUsage\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 an authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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 authorised payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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 captured payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"lineItems\": \"\",\n \"merchantAccount\": \"\",\n \"merchantRefundReason\": \"\",\n \"reference\": \"\",\n \"splits\": \"\"\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": "Refund or cancel a payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"reference\": \"\"\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": "Classic Checkout SDK", + "item": [ + { + "name": "/paymentSession", + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Set up a payment session (Android)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session with the option to store card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"enableOneClick\": true,\n \"enableRecurring\": true,\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.7.0\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (iOS)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"iOS\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 6200\n},\n \"additionalData\": {\n \"split.api\": \"1\",\n \"split.nrOfItems\": \"2\",\n \"split.totalAmount\": \"6200\",\n \"split.currencyCode\": \"EUR\",\n \"split.item1.amount\": \"6000\",\n \"split.item1.type\": \"MarketPlace\",\n \"split.item1.account\": \"151272963\",\n \"split.item1.reference\": \"6124145\",\n \"split.item1.description\": \"Porcelain Doll: Eliza (20cm)\",\n \"split.item2.amount\": \"200\",\n \"split.item2.type\": \"Commission\",\n \"split.item2.reference\": \"6124146\"\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Android\",\n \"token\": \"TOKEN_YOU_GET_FROM_CHECKOUT_SDK\",\n \"returnUrl\": \"app: //\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"sessionValidity\": \"2017-04-06T13: 09: 13Z\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + }, + { + "name": "Set up a payment session (Web)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 17408\n},\n \"reference\": \"Your order number\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"channel\": \"Web\",\n \"html\": true,\n \"origin\": \"https: //www.yourwebsite.com\",\n \"returnUrl\": \"https: //www.yourshop.com/checkout/result\",\n \"countryCode\": \"NL\",\n \"shopperLocale\": \"nl_NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"sdkVersion\": \"1.9.5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/paymentSession", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "paymentSession" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + }, + { + "name": "/payments/result", + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).", + "item": [ + { + "name": "Verify payment results", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"VALUE_YOU_GET_FROM_CHECKOUT_SDK\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payments/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payments", + "result" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Verifies the payment result using the payload returned from the Checkout SDK. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks)." + } + } + ] + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"givex\",\n \"number\": \"4126491073027401\",\n \"cvc\": \"737\"\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": "Retrieve gift card balance", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"paymentMethod\": {\n \"type\": \"plastix\",\n \"number\": \"4010100000000000000\",\n \"cvc\": \"73737\",\n \"holderName\": \"BALANCE EUR 888\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 (DEPRECATED)", + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"originDomains\": [\"https: //www.your-domain1.com\",\n \"https: //www.your-domain2.com\",\n \"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": "Recurring", + "item": [ + { + "name": "/storedPaymentMethods/{{recurringId}}", + "description": "Deletes the token identified in the path. The token can no longer be used with payment requests.", + "item": [ + { + "name": "Delete a token for stored payment details", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods/{{recurringId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods", + "{{recurringId}}" + ], + "variable": [ + { + "key": "recurringId", + "value": "", + "description": "The unique identifier of the token." + } + ], + "query": [ + { + "key": "shopperReference", + "value": "shopperReference_example" + }, + { + "key": "merchantAccount", + "value": "merchantAccount_example" + } + ] + }, + "description": "Deletes the token identified in the path. The token can no longer be used with payment requests." + } + } + ] + }, + { + "name": "/storedPaymentMethods", + "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. ", + "item": [ + { + "name": "Get tokens for stored payment details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storedPaymentMethods", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storedPaymentMethods" + ], + "variable": [ + ], + "query": [ + { + "key": "shopperReference", + "value": "shopperReference_example" + }, + { + "key": "merchantAccount", + "value": "merchantAccount_example" + } + ] + }, + "description": "Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper's payment. A summary of the stored details is included. " + } + } + ] + } + ] + }, + { + "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", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"cardNumber\": \"411111\",\n \"supportedBrands\": [\"visa\",\n \"mc\",\n \"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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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\": \"CHARITY_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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"YOUR_DONATION_REFERENCE\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"storedPaymentMethodId\": \"8415718415172200\"\n},\n \"returnUrl\": \"https: //your-company.com/...\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"donationAccount\": \"CHARITY_ACCOUNT\",\n \"shopperInteraction\": \"ContAuth\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\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": "/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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 card details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"countryCode\": \"NL\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make a card payment with 3D Secure 2 native authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"{{$guid}}\",\n \"paymentMethod\": {\n \"type\": \"scheme\",\n \"encryptedCardNumber\": \"test_4035501428146300\",\n \"encryptedExpiryMonth\": \"test_03\",\n \"encryptedExpiryYear\": \"test_2030\",\n \"encryptedSecurityCode\": \"test_737\",\n \"holderName\": \"John Smith\"\n},\n \"authenticationData\": {\n \"threeDSRequestData\": {\n \"nativeThreeDS\": \"preferred\"\n}\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 card payment with 3D Secure redirect authentication", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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},\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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\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": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\",\n \"storePaymentMethod\": true,\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 giropay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"giropay\"\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 Google Pay payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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. " + } + }, + { + "name": "Make an iDEAL payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"gender\": \"UNKNOWN\",\n \"lastName\": \"Approved\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\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 {\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. " + } + }, + { + "name": "Make a one-off payment with a token and CVV", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"cardDetails.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. " + } + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 \"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 \"shopperInteraction\": \"ContAuth\",\n \"recurringProcessingModel\": \"CardOnFile\"\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 a token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\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. " + } + }, + { + "name": "Make a Sofort payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"reference\": \"Your order number\",\n \"paymentMethod\": {\n \"type\": \"directEbanking\"\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": "Split a payment between a sub-merchant and a platform account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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 {\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. " + } + }, + { + "name": "Tokenize card details for a subscription", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"Subscription\",\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": "/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 3D Secure 2 authentication result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"details\": {\n \"threeDSResult\": \"eyJ0cmFuc1N0YXR1cyI6IlkifQ==\"\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. " + } + }, + { + "name": "Submit the redirect result", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\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. " + } + } + ] + }, + { + "name": "/sessions", + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.", + "item": [ + { + "name": "Create a payment session", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Create a payment session including Klarna fields", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"YOUR_ORDER_REFERENCE\",\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 \"gender\": \"UNKNOWN\",\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 \"dateOfBirth\": \"1996-09-04\",\n \"socialSecurityNumber\": \"0108\",\n \"returnUrl\": \"https: //example.org\",\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 {\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}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + }, + { + "name": "Tokenize card details for one-off payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"TestMerchantCheckout\",\n \"amount\": {\n \"value\": 100,\n \"currency\": \"EUR\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"returnUrl\": \"https: //your-company.com/checkout?shopperOrder=12xy..\",\n \"reference\": \"YOUR_PAYMENT_REFERENCE\",\n \"countryCode\": \"NL\",\n \"storePaymentMethod\": true,\n \"shopperInteraction\": \"Ecommerce\",\n \"recurringProcessingModel\": \"CardOnFile\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sessions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) and [Web Components](https://docs.adyen.com/online-payments/web-components) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook." + } + } + ] + } + ] + }, + { + "name": "Payment links", + "item": [ + { + "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" + } + ], + "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`." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "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)." + } + } + ] + }, + { + "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" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "idempotencyKey", + "value": "null" + } + ], + "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_UNIQUE_SHOPPER_ID\",\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)." + } + } + ] + } + ] + } + ], + "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/v70", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "paymentPspReference", + "value": "paymentPspReference_example", + "type": "string" + }, + { + "key": "linkId", + "value": "linkId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + }, + { + "key": "recurringId", + "value": "recurringId_example", + "type": "string" + } + ] +} + diff --git a/postman/DataProtectionService-v1.json b/postman/DataProtectionService-v1.json new file mode 100644 index 0000000..c7ddd34 --- /dev/null +++ b/postman/DataProtectionService-v1.json @@ -0,0 +1,91 @@ +{ + "info": { + "name": "Adyen Data Protection API (v1)", + "description": { + "content": "Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR.\n\nUse our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication\nEach request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then 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```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nData Protection Service 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://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure\n```", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/requestSubjectErasure", + "description": "Sends the PSP reference containing the shopper data that should be deleted.", + "item": [ + { + "name": "Submit a Subject Erasure Request.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"forceErasure\": \"\",\n \"merchantAccount\": \"\",\n \"pspReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/requestSubjectErasure", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "requestSubjectErasure" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends the PSP reference containing the shopper data that should be deleted." + } + } + ] + } + ] + } + ], + "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://ca-test.adyen.com/ca/services/DataProtectionService/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/LegalEntityService-v1.json b/postman/LegalEntityService-v1.json new file mode 100644 index 0000000..464c84c --- /dev/null +++ b/postman/LegalEntityService-v1.json @@ -0,0 +1,1332 @@ +{ + "info": { + "name": "Legal Entity Management API (v1)", + "description": { + "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through 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://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Legal entities", + "item": [ + { + "name": "/legalEntities/{{id}}", + "description": "Returns a legal entity.", + "item": [ + { + "name": "Get a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/businessLines", + "description": "Returns the business lines owned by a legal entity.", + "item": [ + { + "name": "Get all business lines under a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "businessLines" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the business lines owned by a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}", + "description": "Updates a legal entity. >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", + "item": [ + { + "name": "Add entity associations to an organization", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322KH223222F5GV2SL953Z3\",\n \"type\": \"uboThroughControl\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Updates a legal entity. >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries." + } + } + ] + }, + { + "name": "/legalEntities", + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", + "item": [ + { + "name": "Create a legal entity for an individual residing in the Netherlands", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for an individual residing in the US", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for a Dutch organization", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"type\": \"signatory\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for an organization in the US", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + } + ] + } + ] + }, + { + "name": "Hosted Onboarding", + "item": [ + { + "name": "/themes", + "description": "Returns a list of hosted onboarding page themes.", + "item": [ + { + "name": "Get a list of hosted onboarding page themes", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of hosted onboarding page themes." + } + } + ] + }, + { + "name": "/themes/{{id}}", + "description": "Returns the details of the theme identified in the path.", + "item": [ + { + "name": "Get an onboarding link theme", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the theme" + } + ], + "query": [ + ] + }, + "description": "Returns the details of the theme identified in the path." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/onboardingLinks", + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.", + "item": [ + { + "name": "Create a hosted onboarding link", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"redirectUrl\": \"https: //your.redirect-url.com/\",\n \"locale\": \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user." + } + } + ] + } + ] + }, + { + "name": "Business lines", + "item": [ + { + "name": "/businessLines/{{id}}", + "description": "Deletes a business line. >\"If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.", + "item": [ + { + "name": "Delete a business line", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Deletes a business line. >\"If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts." + } + } + ] + }, + { + "name": "/businessLines/{{id}}", + "description": "Returns the detail of a business line.", + "item": [ + { + "name": "Get a business line", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Returns the detail of a business line." + } + } + ] + }, + { + "name": "/businessLines", + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.", + "item": [ + { + "name": "Create a business line for a business account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\": \"issueBankAccount\",\n \"industryCode\": \"4531\",\n \"webData\": [{\n \"webAddress\": \"https: //www.adyen.com\"\n}],\n \"legalEntityId\": \"LE322JV223222D5FZ9N74BSGM\",\n \"sourceOfFunds\": {\n \"type\": \"business\",\n \"adyenProcessedFunds\": \"false\",\n \"description\": \"Funds from my flower shop business\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses." + } + }, + { + "name": "Create a business line for receiving payments", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\": \"receivePayments\",\n \"salesChannels\": [\"eCommerce\",\n \"ecomMoto\"],\n \"industryCode\": \"339E\",\n \"legalEntityId\": \"LE322JV223222D5FZ9N74BSGM\",\n \"webData\": [{\n \"webAddress\": \"https: //yoururl.com\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses." + } + } + ] + } + ] + }, + { + "name": "Documents", + "item": [ + { + "name": "/documents/{{id}}", + "description": "Deletes a document.", + "item": [ + { + "name": "Delete a document", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." + } + } + ] + }, + { + "name": "/documents/{{id}}", + "description": "Returns a document.", + "item": [ + { + "name": "Get a document", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + ] + }, + "description": "Returns a document." + } + } + ] + }, + { + "name": "/documents/{{id}}", + "description": "Updates a document.", + "item": [ + { + "name": "Update a document", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"proofOfIndustry\",\n \"description\": \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document." + } + } + ] + }, + { + "name": "/documents", + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. ", + "item": [ + { + "name": "Upload a document", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"legalEntity\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. " + } + } + ] + } + ] + }, + { + "name": "Terms of Service", + "item": [ + { + "name": "/legalEntities/{{id}}/termsOfServiceAcceptanceInfos", + "description": "Returns Terms of Service information for a legal entity.", + "item": [ + { + "name": "Get Terms of Service information for a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfServiceAcceptanceInfos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfServiceAcceptanceInfos" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns Terms of Service information for a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfServiceStatus", + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", + "item": [ + { + "name": "Get Terms of Service status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfServiceStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfServiceStatus" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfService/{{termsofservicedocumentid}}", + "description": "Accepts Terms of Service.", + "item": [ + { + "name": "Accept Terms of Service", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\": \"\",\n \"ipAddress\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfService/{{termsofservicedocumentid}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfService", + "{{termsofservicedocumentid}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfService", + "description": "Returns the Terms of Service document for a legal entity.", + "item": [ + { + "name": "Get the Terms of Service document", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"adyenIssuing\",\n \"language\": \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." + } + } + ] + } + ] + }, + { + "name": "Transfer instruments", + "item": [ + { + "name": "/transferInstruments/{{id}}", + "description": "Deletes a transfer instrument.", + "item": [ + { + "name": "Delete a transfer instrument", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments/{{id}}", + "description": "Returns the details of a transfer instrument.", + "item": [ + { + "name": "Get a transfer instrument", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments/{{id}}", + "description": "Updates a transfer instrument.", + "item": [ + { + "name": "Update a transfer instrument", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments", + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).", + "item": [ + { + "name": "Add a EUR bank account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"NL\",\n \"currencyCode\": \"EUR\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." + } + }, + { + "name": "Add a USD bank account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\": \"LE322JV223222D5GGMHPC2FPL\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"US\",\n \"currencyCode\": \"USD\",\n \"accountNumber\": \"0000000123\",\n \"branchCode\": \"121202211\",\n \"accountType\": \"checking\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." + } + } + ] + } + ] + } + ], + "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://kyc-test.adyen.com/lem/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "termsofservicedocumentid", + "value": "termsofservicedocumentid_example", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + } + ] +} + diff --git a/postman/LegalEntityService-v2.json b/postman/LegalEntityService-v2.json new file mode 100644 index 0000000..2fb1589 --- /dev/null +++ b/postman/LegalEntityService-v2.json @@ -0,0 +1,1467 @@ +{ + "info": { + "name": "Legal Entity Management API (v2)", + "description": { + "content": "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws12345@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\n-H \"Content-Type: application/json\" \\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through 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://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n", + "type": "text/markdown" + }, + "version": "2", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Legal entities", + "item": [ + { + "name": "/legalEntities/{{id}}", + "description": "Returns a legal entity.", + "item": [ + { + "name": "Get a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/businessLines", + "description": "Returns the business lines owned by a legal entity.", + "item": [ + { + "name": "Get all business lines under a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "businessLines" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the business lines owned by a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}", + "description": "Updates a legal entity. >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.", + "item": [ + { + "name": "Add entity associations to an organization", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322KH223222F5GV2SL953Z3\",\n \"type\": \"uboThroughControl\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Updates a legal entity. >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries." + } + }, + { + "name": "Add entity associations to a sole proprietorship", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"soleProprietorship\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Updates a legal entity. >To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries." + } + } + ] + }, + { + "name": "/legalEntities", + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ", + "item": [ + { + "name": "Create a legal entity for an individual residing in the Netherlands", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for an individual residing in the US", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for a Dutch organization", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"type\": \"signatory\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for an organization in the US", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for a Dutch sole proprietor", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\": \"NL\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + }, + { + "name": "Create a legal entity for a sole proprietor in the US", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\": \"US\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. " + } + } + ] + } + ] + }, + { + "name": "Hosted Onboarding", + "item": [ + { + "name": "/themes", + "description": "Returns a list of hosted onboarding page themes.", + "item": [ + { + "name": "Get a list of hosted onboarding page themes", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of hosted onboarding page themes." + } + } + ] + }, + { + "name": "/themes/{{id}}", + "description": "Returns the details of the theme identified in the path.", + "item": [ + { + "name": "Get an onboarding link theme", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/themes/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "themes", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the theme" + } + ], + "query": [ + ] + }, + "description": "Returns the details of the theme identified in the path." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/onboardingLinks", + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.", + "item": [ + { + "name": "Create a hosted onboarding link", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"redirectUrl\": \"https: //your.redirect-url.com/\",\n \"locale\": \"nl-NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/onboardingLinks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "onboardingLinks" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity" + } + ], + "query": [ + ] + }, + "description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user." + } + } + ] + } + ] + }, + { + "name": "Business lines", + "item": [ + { + "name": "/businessLines/{{id}}", + "description": "Deletes a business line. >\"If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.", + "item": [ + { + "name": "Delete a business line", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Deletes a business line. >\"If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts." + } + } + ] + }, + { + "name": "/businessLines/{{id}}", + "description": "Returns the detail of a business line.", + "item": [ + { + "name": "Get a business line", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Returns the detail of a business line." + } + } + ] + }, + { + "name": "/businessLines/{{id}}", + "description": "Updates a business line.", + "item": [ + { + "name": "Update a business line", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"industryCode\": \"55\",\n \"webData\": [{\n \"webAddress\": \"https: //www.example.com\"\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the business line." + } + ], + "query": [ + ] + }, + "description": "Updates a business line." + } + } + ] + }, + { + "name": "/businessLines", + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.", + "item": [ + { + "name": "Create a business line for a business account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"capability\": \"issueBankAccount\",\n \"industryCode\": \"4531\",\n \"webData\": [{\n \"webAddress\": \"https: //www.adyen.com\"\n}],\n \"legalEntityId\": \"LE322JV223222D5FZ9N74BSGM\",\n \"sourceOfFunds\": {\n \"type\": \"business\",\n \"adyenProcessedFunds\": false,\n \"description\": \"Funds from my flower shop business\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/businessLines", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "businessLines" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses." + } + } + ] + } + ] + }, + { + "name": "Documents", + "item": [ + { + "name": "/documents/{{id}}", + "description": "Deletes a document.", + "item": [ + { + "name": "Delete a document", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a document." + } + } + ] + }, + { + "name": "/documents/{{id}}", + "description": "Returns a document.", + "item": [ + { + "name": "Get a document", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document." + } + ], + "query": [ + ] + }, + "description": "Returns a document." + } + } + ] + }, + { + "name": "/documents/{{id}}", + "description": "Updates a document.", + "item": [ + { + "name": "Update a document", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"proofOfIndustry\",\n \"description\": \"Proof of industry doc for Example Company\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the document to be updated." + } + ], + "query": [ + ] + }, + "description": "Updates a document." + } + } + ] + }, + { + "name": "/documents", + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. ", + "item": [ + { + "name": "Upload a document", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"legalEntity\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/documents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "documents" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. " + } + } + ] + } + ] + }, + { + "name": "Terms of Service", + "item": [ + { + "name": "/legalEntities/{{id}}/termsOfServiceAcceptanceInfos", + "description": "Returns Terms of Service information for a legal entity.", + "item": [ + { + "name": "Get Terms of Service information for a legal entity", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfServiceAcceptanceInfos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfServiceAcceptanceInfos" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns Terms of Service information for a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfServiceStatus", + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.", + "item": [ + { + "name": "Get Terms of Service status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfServiceStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfServiceStatus" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the required types of Terms of Service that need to be accepted by a legal entity." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfService/{{termsofservicedocumentid}}", + "description": "Accepts Terms of Service.", + "item": [ + { + "name": "Accept Terms of Service", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"acceptedBy\": \"\",\n \"ipAddress\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfService/{{termsofservicedocumentid}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfService", + "{{termsofservicedocumentid}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + }, + { + "key": "termsofservicedocumentid", + "value": "", + "description": "The unique identifier of the Terms of Service document." + } + ], + "query": [ + ] + }, + "description": "Accepts Terms of Service." + } + } + ] + }, + { + "name": "/legalEntities/{{id}}/termsOfService", + "description": "Returns the Terms of Service document for a legal entity.", + "item": [ + { + "name": "Get the Terms of Service document", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"adyenIssuing\",\n \"language\": \"en\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/legalEntities/{{id}}/termsOfService", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legalEntities", + "{{id}}", + "termsOfService" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the legal entity." + } + ], + "query": [ + ] + }, + "description": "Returns the Terms of Service document for a legal entity." + } + } + ] + } + ] + }, + { + "name": "Transfer instruments", + "item": [ + { + "name": "/transferInstruments/{{id}}", + "description": "Deletes a transfer instrument.", + "item": [ + { + "name": "Delete a transfer instrument", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument to be deleted." + } + ], + "query": [ + ] + }, + "description": "Deletes a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments/{{id}}", + "description": "Returns the details of a transfer instrument.", + "item": [ + { + "name": "Get a transfer instrument", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Returns the details of a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments/{{id}}", + "description": "Updates a transfer instrument.", + "item": [ + { + "name": "Update a transfer instrument", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bankAccount\": \"\",\n \"legalEntityId\": \"\",\n \"type\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "The unique identifier of the transfer instrument." + } + ], + "query": [ + ] + }, + "description": "Updates a transfer instrument." + } + } + ] + }, + { + "name": "/transferInstruments", + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).", + "item": [ + { + "name": "Add a EUR bank account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"NL\",\n \"currencyCode\": \"EUR\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." + } + }, + { + "name": "Add a USD bank account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityId\": \"LE322JV223222D5GGMHPC2FPL\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"US\",\n \"currencyCode\": \"USD\",\n \"accountNumber\": \"0000000123\",\n \"branchCode\": \"121202211\",\n \"accountType\": \"checking\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transferInstruments", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transferInstruments" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)." + } + } + ] + } + ] + } + ], + "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://kyc-test.adyen.com/lem/v2", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "termsofservicedocumentid", + "value": "termsofservicedocumentid_example", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + } + ] +} + diff --git a/postman/ManagementService-v1.json b/postman/ManagementService-v1.json new file mode 100644 index 0000000..6d685d8 --- /dev/null +++ b/postman/ManagementService-v1.json @@ -0,0 +1,7344 @@ +{ + "info": { + "name": "Management API (v1)", + "description": { + "content": "Configure and manage your Adyen company and merchant accounts, stores, and payment terminals.\n## Authentication\nEach request to the Management API must be signed with an API key. [Generate your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) in the Customer Area and then set this key to the `X-API-Key` header value.\n\nTo access the live endpoints, you need to generate a new API key in your live Customer Area.\n## Versioning\n\nManagement API handles versioning as part of the endpoint URL. For example, to send a request to version 1 of the `/companies/{companyId}/webhooks` endpoint, use:\n\n```text\nhttps://management-test.adyen.com/v1/companies/{companyId}/webhooks\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area. Use this API key to make requests to:\n\n```text\nhttps://management-live.adyen.com/v1\n```", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "API key - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/generateApiKey", + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Generate new API key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "generateApiKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Account - merchant level", + "item": [ + { + "name": "/merchants", + "description": "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", + "item": [ + { + "name": "Get a list of merchant accounts", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the list of merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}", + "description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", + "item": [ + { + "name": "Get a merchant account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the merchant account specified in the path. Your API credential must have access to the merchant account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read" + } + } + ] + }, + { + "name": "/merchants", + "description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", + "item": [ + { + "name": "Create a merchant account for an Adyen for Platforms Manage integration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyId\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"legalEntityId\": \"YOUR_LEGAL_ENTITY_ID\",\n \"businessLineId\": \"YOUR_BUSINESS_LINE_ID\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"reference\": \"YOUR_OWN_REFERENCE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a merchant account for the company account specified in the request. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/activate", + "description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asychronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write", + "item": [ + { + "name": "Request to activate a merchant account", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/activate", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "activate" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Sends a request to activate the merchant account identified in the path. You get the result of the activation asychronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write" + } + } + ] + } + ] + }, + { + "name": "Allowed origins - company level", + "item": [ + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Delete an allowed origin", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get a list of allowed origins", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get an allowed origin", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Add an allowed origin for the API credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"https: //www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "API key - company level", + "item": [ + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/generateApiKey", + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Generate new API key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/generateApiKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "generateApiKey" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new API key for the API credential. You can use the new API key a few minutes after generating it. The old API key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Client key - company level", + "item": [ + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/generateClientKey", + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Generate new client key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}", + "generateClientKey" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Users - company level", + "item": [ + { + "name": "/companies/{{companyId}}/users", + "description": "Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Get a list of users", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "username", + "value": "username_example" + } + ] + }, + "description": "Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/companies/{{companyId}}/users/{{userId}}", + "description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Get user details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "users", + "{{userId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "description": "Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/companies/{{companyId}}/users/{{userId}}", + "description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Update user details", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"associatedMerchantAccounts\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "users", + "{{userId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "userId", + "value": "", + "description": "The unique identifier of the user." + } + ], + "query": [ + ] + }, + "description": "Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/companies/{{companyId}}/users", + "description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Create a user", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"username\": \"johnsmith\",\n \"email\": \"john.smith@example.com\",\n \"timeZoneCode\": \"Europe/Amsterdam\",\n \"roles\": [\"Merchant standard role\",\n \"Merchant admin\"],\n \"associatedMerchantAccounts\": [\"{{YOUR_MERCHANT_ACCOUNT}}\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "users" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + } + ] + }, + { + "name": "Terminal actions - terminal level", + "item": [ + { + "name": "/terminals/scheduleActions", + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write", + "item": [ + { + "name": "Schedule installing an Android app", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\": [\"S1E-000150183300032\",\n \"S1E-000150183300033\",\n \"S1F2-000150183300034\"],\n \"storeId\": \"\",\n \"scheduledAt\": \"2021-12-12T20: 21: 22-0100\",\n \"actionDetails\": {\n \"type\": \"InstallAndroidApp\",\n \"appId\": \"ANDA422LZ223223K5F694GCCF732K8\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write" + } + }, + { + "name": "Schedule uninstalling an Android certificate", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\": [\"S1E-000150183300032\",\n \"S1E-000150183300033\",\n \"S1F2-000150183300034\"],\n \"storeId\": \"\",\n \"scheduledAt\": \"2021-12-12T20: 21: 22-0100\",\n \"actionDetails\": {\n \"type\": \"UninstallAndroidCertificate\",\n \"certificateId\": \"ANDC422LZ223223K5F78NVN9SL4VPH\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write" + } + }, + { + "name": "Invalid terminal ID in the request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminalIds\": [\"S1E-000150183300032\",\n \"S1E-000150183300033\",\n \"S1F2-000150183300034\"],\n \"storeId\": \"\",\n \"scheduledAt\": \"2021-12-11T20: 21: 22-0100\",\n \"actionDetails\": {\n \"type\": \"InstallAndroidApp\",\n \"appId\": \"ANDA422LZ223223K5F694GCCF621J7\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/scheduleActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "scheduleActions" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Schedules a [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) by specifying the action and the terminals that the action must be applied to. The following restrictions apply: * You can schedule only one action at a time. For example, to install a new app version and remove an old app version, you have to make two API requests. * The maximum number of terminals in a request is **100**. For example, to apply an action to 250 terminals, you have to divide the terminals over three API requests. * If there is an error with one or more terminal IDs in the request, the action is scheduled for none of the terminals. You need to fix the error and try again. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read and write" + } + } + ] + } + ] + }, + { + "name": "Terminal settings - terminal level", + "item": [ + { + "name": "/terminals/{{terminalId}}/terminalLogos", + "description": "Returns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get the terminal logo", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Returns the logo that is configured for the payment terminal identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/terminals/{{terminalId}}/terminalSettings", + "description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get terminal settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Returns the settings that are configured for the payment terminal identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/terminals/{{terminalId}}/terminalLogos", + "description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Remove logo to restore the logo from a higher level", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Upload terminal logo", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Updates the logo for the payment terminal identified in the path. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (store, merchant account, or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/terminals/{{terminalId}}/terminalSettings", + "description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Add EAP-PEAP and PSK Wi-Fi profiles", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"peap\",\n \"eapCaCert\": {\n \"data\": \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\": \"eap-peap-ca.pem\"\n},\n \"eapIdentity\": \"admin\",\n \"eapIntermediateCert\": {\n \"data\": \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\": \"eap-peap-client.pem\"\n},\n \"eapPwd\": \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-peap-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n},\n {\n \"authType\": \"wpa-psk\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": false,\n \"hiddenSsid\": false,\n \"name\": \"Profile-guest-wifi\",\n \"psk\": \"WIFI_PASSWORD\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Add EAP-TLS Wi-Fi profile", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"tls\",\n \"eapCaCert\": {\n \"data\": \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\": \"eap-tls-ca.pem\"\n},\n \"eapClientCert\": {\n \"data\": \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\": \"eap-tls-client.pem\"\n},\n \"eapClientKey\": {\n \"data\": \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\": \"rsa-private.key\"\n},\n \"eapClientPwd\": \"\",\n \"eapIdentity\": \"admin\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-tls-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals/{{terminalId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals", + "{{terminalId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "terminalId", + "value": "", + "description": "The unique identifier of the payment terminal." + } + ], + "query": [ + ] + }, + "description": "Updates the settings that are configured for the payment terminal identified in the path. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + } + ] + }, + { + "name": "Payout settings - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", + "item": [ + { + "name": "Delete a payout setting", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "payoutSettings", + "{{payoutSettingsId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "description": "Deletes the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/payoutSettings", + "description": "Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read", + "item": [ + { + "name": "Get a list of payout settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the list of payout settings for the merchant account identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read", + "item": [ + { + "name": "Get a payout setting", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "payoutSettings", + "{{payoutSettingsId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "description": "Returns the payout setting identified in the path. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", + "item": [ + { + "name": "Update a payout setting", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/payoutSettings/{{payoutSettingsId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "payoutSettings", + "{{payoutSettingsId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "payoutSettingsId", + "value": "", + "description": "The unique identifier of the payout setting." + } + ], + "query": [ + ] + }, + "description": "Updates the payout setting identified in the path. You can enable or disable the payout setting. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/payoutSettings", + "description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write", + "item": [ + { + "name": "Add a payout setting", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"enabled\": \"\",\n \"enabledFromDate\": \"\",\n \"transferInstrumentId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/payoutSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "payoutSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Sends a request to add a payout setting for the merchant account specified in the path. A payout setting links the merchant account to the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the payout bank account. Adyen verifies the bank account before allowing and enabling the payout setting. If you're accepting payments in multiple currencies, you may add multiple payout settings for the merchant account. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payout account settings read and write" + } + } + ] + } + ] + }, + { + "name": "Webhooks - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Remove a webhook", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks", + "description": "Lists all webhook configurations for the merchant account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", + "item": [ + { + "name": "List all webhooks", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Lists all webhook configurations for the merchant account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", + "item": [ + { + "name": "Get a webhook", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Activate the webhook", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks", + "description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Add a webhook configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"standard\",\n \"url\": \"YOUR_WEBHOOK_URL\",\n \"username\": \"YOUR_USER\",\n \"password\": \"YOUR_PASSWORD\",\n \"active\": \"true\",\n \"sslVersion\": \"TLSv1.2\",\n \"communicationFormat\": \"json\",\n \"acceptsExpiredCertificate\": \"false\",\n \"acceptsSelfSignedCertificate\": \"true\",\n \"acceptsUntrustedRootCertificate\": \"true\",\n \"populateSoapActionHeader\": \"false\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks/{{webhookId}}/generateHmac", + "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Generate an HMAC key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks/{{webhookId}}/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks", + "{{webhookId}}", + "generateHmac" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "" + } + ], + "query": [ + ] + }, + "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/webhooks/{{webhookId}}/test", + "description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Test a webhook notification", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\": {\n \"paymentMethod\": \"visa\",\n \"eventCode\": \"AUTHORISATION\",\n \"amount\": \"10\",\n \"reason\": \"Authorize visa payment\",\n \"success\": true\n},\n \"types\": [\"CUSTOM\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/webhooks/{{webhookId}}/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "webhooks", + "{{webhookId}}", + "test" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Sends sample notifications to test if the webhook is set up correctly. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + } + ] + }, + { + "name": "Client key - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/generateClientKey", + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Generate new client key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/generateClientKey", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "generateClientKey" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the API credential identified in the path. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Allowed origins - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Delete an allowed origin", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. As soon as an allowed origin is removed, we no longer accept client-side requests from that domain. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get a list of allowed origins", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get an allowed origin", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + }, + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Returns the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Add an allowed origin for the API credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"https: //www.eu.mystore.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}", + "allowedOrigins" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Adds a new [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) to the API credential's list of allowed origins. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Terminal orders - company level", + "item": [ + { + "name": "/companies/{{companyId}}/billingEntities", + "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of billing entities", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "billingEntities" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example" + } + ] + }, + "description": "Returns the billing entities of the company identified in the path and all merchant accounts belonging to the company. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/shippingLocations", + "description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of shipping locations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns the shipping locations for the company identified in the path and all merchant accounts belonging to the company. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalModels", + "description": "Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of terminal models", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalModels" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminal models that the company identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalOrders", + "description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of orders", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example" + }, + { + "key": "status", + "value": "status_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalOrders/{{orderId}}", + "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get an order", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalOrders/{{orderId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalOrders", + "{{orderId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalProducts", + "description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of terminal products", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalProducts" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "country", + "value": "country_example" + }, + { + "key": "terminalModelId", + "value": "terminalModelId_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a country-specific list of payment terminal packages and parts that the company identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalOrders/{{orderId}}", + "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Update a terminal order", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shippingLocation\": \"S2-7973536B20662642215526704F302044452F714622375D476169\",\n \"items\": [{\n \"id\": \"TBOX-V400m-684-EU\",\n \"name\": \"V400m Package\",\n \"quantity\": 1\n},\n {\n \"id\": \"PART-175746-EU\",\n \"name\": \"Adyen Test Card\",\n \"quantity\": 1\n},\n {\n \"id\": \"PART-620222-EU\",\n \"name\": \"Receipt Roll\",\n \"quantity\": 5\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalOrders/{{orderId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalOrders", + "{{orderId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/shippingLocations", + "description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Create a shipping location", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"YOUR_COMPANY Rokin depot\",\n \"address\": {\n \"companyName\": \"YOUR_COMPANY\",\n \"streetAddress\": \"Rokin 21\",\n \"postalCode\": \"1012 KS\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"\",\n \"country\": \"NL\"\n},\n \"contact\": {\n \"firstName\": \"Paul\",\n \"lastName\": \"Green\",\n \"phoneNumber\": \"+31 020 1234567\",\n \"email\": \"Paul.Green@company.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "shippingLocations" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Creates a shipping location for the company identified in the path. A shipping location defines an address where orders can be delivered. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalOrders", + "description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Create an order", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\": \"{{$guid}}\",\n \"shippingLocationId\": \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\": \"Company.YOUR_COMPANY\",\n \"items\": [{\n \"id\": \"TBOX-V400m-684-EU\",\n \"name\": \"V400m Package\",\n \"quantity\": 1\n},\n {\n \"id\": \"PART-175746-EU\",\n \"name\": \"Adyen Test Card\",\n \"quantity\": 1\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalOrders" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Creates an order for payment terminal products for the company identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalOrders/{{orderId}}/cancel", + "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Cancel an order", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalOrders/{{orderId}}/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalOrders", + "{{orderId}}", + "cancel" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + } + ] + }, + { + "name": "API credentials - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/apiCredentials", + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get a list of API credentials", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the merchant account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}", + "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get an API credential", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}", + "description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Activate an API credential", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": \"true\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials/{{apiCredentialId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials", + "{{apiCredentialId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Changes the API credential's roles, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/apiCredentials", + "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Add an API credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\"Checkout webservice role\"],\n \"allowedOrigins\": [\"https: //www.mystore.com\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "apiCredentials" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify the roles and allowed origins for the new API credential. The response includes the: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Users - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/users", + "description": "Returns a list of users associated with the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Get a list of users", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "username", + "value": "username_example" + } + ] + }, + "description": "Returns a list of users associated with the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/users/{{userId}}", + "description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Get user details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "users", + "{{userId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "description": "Returns user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/users/{{userId}}", + "description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Update a user", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountGroups\": \"\",\n \"active\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"roles\": \"\",\n \"timeZoneCode\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/users/{{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "users", + "{{userId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "Unique identifier of the merchant." + }, + { + "key": "userId", + "value": "", + "description": "Unique identifier of the user." + } + ], + "query": [ + ] + }, + "description": "Updates user details for the `userId` and the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/users", + "description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write ", + "item": [ + { + "name": "Create a user", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"username\": \"johnsmith\",\n \"email\": \"john.smith@example.com\",\n \"timeZoneCode\": \"Europe/Amsterdam\",\n \"roles\": [\"Merchant standard role\"],\n \"associatedMerchantAccounts\": [\"{{YOUR_MERCHANT_ACCOUNT}}\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "users" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "Unique identifier of the merchant." + } + ], + "query": [ + ] + }, + "description": "Creates a user for the `merchantId` specified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write " + } + } + ] + } + ] + }, + { + "name": "Terminal actions - company level", + "item": [ + { + "name": "/companies/{{companyId}}/androidApps", + "description": "Returns a list of the Android apps that are available for the company identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", + "item": [ + { + "name": "Get a list of Android apps", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/androidApps", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "androidApps" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns a list of the Android apps that are available for the company identified in the path. These apps have been uploaded to Adyen and can be installed or uninstalled on Android payment terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/androidCertificates", + "description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", + "item": [ + { + "name": "Get a list of Android certificates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/androidCertificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "androidCertificates" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns a list of the Android certificates that are available for the company identified in the path. Typically, these certificates enable running apps on Android payment terminals. The certifcates in the list have been uploaded to Adyen and can be installed or uninstalled on Android terminals through [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalActions", + "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", + "item": [ + { + "name": "Get a list of terminal actions", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalActions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalActions" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "status", + "value": "status_example" + }, + { + "key": "type", + "value": "type_example" + } + ] + }, + "description": "Returns the [terminal actions](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) that have been scheduled for the company identified in the path.The response doesn't include actions that are scheduled by Adyen. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalActions/{{actionId}}", + "description": "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write", + "item": [ + { + "name": "Get terminal action", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalActions/{{actionId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalActions", + "{{actionId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "actionId", + "value": "", + "description": "The unique identifier of the terminal action." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the [terminal action](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api) identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal actions read * Management API—Terminal actions read and write" + } + } + ] + } + ] + }, + { + "name": "Payment methods - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings", + "description": "Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", + "item": [ + { + "name": "Get all payment methods", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "storeId", + "value": "storeId_example" + }, + { + "key": "businessLineId", + "value": "businessLineId_example" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "pageNumber", + "value": "56" + } + ] + }, + "description": "Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}", + "description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", + "item": [ + { + "name": "Get payment method details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings", + "{{paymentMethodId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "description": "Returns details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}/getApplePayDomains", + "description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read ", + "item": [ + { + "name": "Get Apple Pay domains", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}/getApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings", + "{{paymentMethodId}}", + "getApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "description": "Returns all Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}", + "description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", + "item": [ + { + "name": "Update a payment method", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"countries\": \"\",\n \"currencies\": \"\",\n \"customRoutingFlags\": \"\",\n \"enabled\": \"\",\n \"shopperStatement\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings", + "{{paymentMethodId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "description": "Updates payment method details for the merchant account and the payment method identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings", + "description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", + "item": [ + { + "name": "Request a payment method", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"visa\",\n \"currencies\": [\"USD\"],\n \"countries\": [\"US\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write " + } + }, + { + "name": "Request to add Swish", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessLineId\": \"BL322KV223222D5F8H2J4BQ6C\",\n \"storeId\": \"ST322LJ223223K5F4SQNR9XL5\",\n \"type\": \"swish\",\n \"swish\": {\n \"swishNumber\": \"1231111111\"\n},\n \"currencies\": [\"SEK\"],\n \"countries\": [\"SE\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Sends a request to add a new payment method to the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write " + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}/addApplePayDomains", + "description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write ", + "item": [ + { + "name": "Add an Apple Pay domain", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domains\": [\"https: //example.com\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/paymentMethodSettings/{{paymentMethodId}}/addApplePayDomains", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "paymentMethodSettings", + "{{paymentMethodId}}", + "addApplePayDomains" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "paymentMethodId", + "value": "", + "description": "The unique identifier of the payment method." + } + ], + "query": [ + ] + }, + "description": "Adds the new domain to the list of Apple Pay domains that are registered with the merchant account and the payment method identified in the path. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/enable-apple-pay#register-merchant-domain). To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read and write " + } + } + ] + } + ] + }, + { + "name": "My API credential", + "item": [ + { + "name": "/me/allowedOrigins/{{originId}}", + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", + "item": [ + { + "name": "Remove allowed origin", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Removes the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles." + } + } + ] + }, + { + "name": "/me", + "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles.", + "item": [ + { + "name": "Get API credential details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns your [API credential](https://docs.adyen.com/development-resources/api-credentials) details based on the API Key you used in the request. You can make this request with any of the Management API roles." + } + } + ] + }, + { + "name": "/me/allowedOrigins", + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles.", + "item": [ + { + "name": "Get allowed origins", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your [API credential](https://docs.adyen.com/development-resources/api-credentials) based on the API key you used in the request. You can make this request with any of the Management API roles." + } + } + ] + }, + { + "name": "/me/allowedOrigins/{{originId}}", + "description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", + "item": [ + { + "name": "Get allowed origin details", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins/{{originId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins", + "{{originId}}" + ], + "variable": [ + { + "key": "originId", + "value": "", + "description": "Unique identifier of the allowed origin." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the [allowed origin](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) specified in the path. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles." + } + } + ] + }, + { + "name": "/me/allowedOrigins", + "description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles.", + "item": [ + { + "name": "Add allowed origin", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"_links\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/me/allowedOrigins", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "me", + "allowedOrigins" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Adds an allowed origin to the list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) of your API credential. The API key from the request is used to identify the [API credential](https://docs.adyen.com/development-resources/api-credentials). You can make this request with any of the Management API roles." + } + } + ] + } + ] + }, + { + "name": "Terminal settings - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/terminalLogos", + "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get the terminal logo", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the merchant account identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalSettings", + "description": "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get terminal settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the payment terminal settings that are configured for the merchant account identified in the path. These settings apply to all terminals under the merchant account unless different values are configured at a lower level (store or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalLogos", + "description": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Remove logo to restore the logo from a higher level", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Upload terminal logo", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo for a specific payment terminal model at the merchant account identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the merchant account, unless a different logo is configured at a lower level (store or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the company account, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalSettings", + "description": "Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Add EAP-PEAP and PSK Wi-Fi profiles", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"peap\",\n \"eapCaCert\": {\n \"data\": \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\": \"eap-peap-ca.pem\"\n},\n \"eapIdentity\": \"admin\",\n \"eapIntermediateCert\": {\n \"data\": \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\": \"eap-peap-client.pem\"\n},\n \"eapPwd\": \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-peap-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n},\n {\n \"authType\": \"wpa-psk\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": false,\n \"hiddenSsid\": false,\n \"name\": \"Profile-guest-wifi\",\n \"psk\": \"WIFI_PASSWORD\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Add EAP-TLS Wi-Fi profile", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"tls\",\n \"eapCaCert\": {\n \"data\": \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\": \"eap-tls-ca.pem\"\n},\n \"eapClientCert\": {\n \"data\": \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\": \"eap-tls-client.pem\"\n},\n \"eapClientKey\": {\n \"data\": \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\": \"rsa-private.key\"\n},\n \"eapClientPwd\": \"\",\n \"eapIdentity\": \"admin\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-tls-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the merchant account identified in the path. These settings apply to all terminals under the merchant account, unless different values are configured at a lower level (store or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + } + ] + }, + { + "name": "Terminals - terminal level", + "item": [ + { + "name": "/terminals", + "description": "Returns the payment terminals that the API credential has access to and that match the query parameters. When using `searchQuery`, other query parameters are ignored. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * POS Terminal Management API * Management API—Terminal settings read", + "item": [ + { + "name": "Get a list of terminals", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/terminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "terminals" + ], + "variable": [ + ], + "query": [ + { + "key": "searchQuery", + "value": "searchQuery_example" + }, + { + "key": "countries", + "value": "countries_example" + }, + { + "key": "merchantIds", + "value": "merchantIds_example" + }, + { + "key": "storeIds", + "value": "storeIds_example" + }, + { + "key": "brandModels", + "value": "brandModels_example" + }, + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the payment terminals that the API credential has access to and that match the query parameters. When using `searchQuery`, other query parameters are ignored. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * POS Terminal Management API * Management API—Terminal settings read" + } + } + ] + } + ] + }, + { + "name": "Webhooks - company level", + "item": [ + { + "name": "/companies/{{companyId}}/webhooks/{{webhookId}}", + "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Remove a webhook", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks", + "description": "Lists all webhook configurations for the company account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", + "item": [ + { + "name": "List all webhooks", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Lists all webhook configurations for the company account. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks/{{webhookId}}", + "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write", + "item": [ + { + "name": "Get a webhook", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks/{{webhookId}}", + "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Activate the webhook", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks/{{webhookId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks", + "{{webhookId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks", + "description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Add a webhook configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"standard\",\n \"url\": \"YOUR_WEBHOOK_URL\",\n \"username\": \"YOUR_USER\",\n \"password\": \"YOUR_PASSWORD\",\n \"active\": \"true\",\n \"sslVersion\": \"TLSv1.2\",\n \"communicationFormat\": \"soap\",\n \"acceptsExpiredCertificate\": \"false\",\n \"acceptsSelfSignedCertificate\": \"true\",\n \"acceptsUntrustedRootCertificate\": \"true\",\n \"populateSoapActionHeader\": \"false\",\n \"filterMerchantAccountType\": \"includeAccounts\",\n \"filterMerchantAccounts\": [\"{{YOUR_MERCHANT_ACCOUNT}}\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account)." + } + ], + "query": [ + ] + }, + "description": "Subscribe to receive webhook notifications about events related to your company account. You can add basic authentication to make sure the data is secure. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks/{{webhookId}}/generateHmac", + "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Generate an HMAC key", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks/{{webhookId}}/generateHmac", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks", + "{{webhookId}}", + "generateHmac" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/webhooks/{{webhookId}}/test", + "description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write", + "item": [ + { + "name": "Test a webhook notification", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"notification\": {\n \"paymentMethod\": \"visa\",\n \"eventCode\": \"AUTHORISATION\",\n \"amount\": \"20\",\n \"reason\": \"Authorize visa payment\",\n \"success\": true\n},\n \"types\": [\"CUSTOM\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/webhooks/{{webhookId}}/test", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "webhooks", + "{{webhookId}}", + "test" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "webhookId", + "value": "", + "description": "Unique identifier of the webhook configuration." + } + ], + "query": [ + ] + }, + "description": "Sends sample notifications to test if the webhook is set up correctly. We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the `merchantIds` array to specify a subset of the merchant accounts for which to send test notifications. We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification. The response describes the result of the test. The `status` field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write" + } + } + ] + } + ] + }, + { + "name": "Account - store level", + "item": [ + { + "name": "/merchants/{{merchantId}}/stores", + "description": "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", + "item": [ + { + "name": "Get a list of stores", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "reference", + "value": "reference_example" + } + ] + }, + "description": "Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores/{{storeId}}", + "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", + "item": [ + { + "name": "Get a store", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{storeId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{storeId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/stores", + "description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", + "item": [ + { + "name": "Get a list of stores", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + }, + { + "key": "reference", + "value": "reference_example" + }, + { + "key": "merchantId", + "value": "merchantId_example" + } + ] + }, + "description": "Returns a list of stores. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}", + "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write", + "item": [ + { + "name": "Get a store", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the store identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores/{{storeId}}", + "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", + "item": [ + { + "name": "Update store address.", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\": {\n \"line1\": \"1776 West Pinewood Avenue\",\n \"line2\": \"Heartland Building\",\n \"line3\": \"\",\n \"postalCode\": \"20251\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{storeId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{storeId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}", + "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", + "item": [ + { + "name": "Update store address.", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"address\": {\n \"line1\": \"1776 West Pinewood Avenue\",\n \"line2\": \"Heartland Building\",\n \"line3\": \"\",\n \"postalCode\": \"20251\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Updates the store identified in the path. You can only update some store parameters. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores", + "description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", + "item": [ + { + "name": "Create a store under the merchant account specified in the path.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"City centre store\",\n \"shopperStatement\": \"Springfield Shop\",\n \"phoneNumber\": \"1813702551707653\",\n \"reference\": \"Spring_store_2\",\n \"address\": {\n \"country\": \"US\",\n \"line1\": \"200 Main Street\",\n \"line2\": \"Building 5A\",\n \"line3\": \"Suite 3\",\n \"city\": \"Springfield\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"20250\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write" + } + } + ] + }, + { + "name": "/stores", + "description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write", + "item": [ + { + "name": "Create a store", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantId\": \"{{YOUR_MERCHANT_ACCOUNT}}_ID\",\n \"description\": \"City centre store\",\n \"shopperStatement\": \"Springfield Shop\",\n \"phoneNumber\": \"+1813702551707653\",\n \"reference\": \"Spring_store_2\",\n \"address\": {\n \"country\": \"US\",\n \"line1\": \"200 Main Street\",\n \"line2\": \"Building 5A\",\n \"line3\": \"Suite 3\",\n \"city\": \"Springfield\",\n \"stateOrProvince\": \"NY\",\n \"postalCode\": \"20250\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates a store for the merchant account specified in the request. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write" + } + } + ] + } + ] + }, + { + "name": "Terminal settings - company level", + "item": [ + { + "name": "/companies/{{companyId}}/terminalLogos", + "description": "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get the terminal logo", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the company identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalSettings", + "description": "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write", + "item": [ + { + "name": "Get terminal settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Returns the payment terminal settings that are configured for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write For [sensitive terminal settings](https://docs.adyen.com/point-of-sale/automating-terminal-management/configure-terminals-api#sensitive-terminal-settings), your API credential must have the following role: * Management API—Terminal settings Advanced read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalLogos", + "description": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Remove logo to restore the logo from a higher level", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Upload terminal logo", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the company identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the company, unless a different logo is configured at a lower level (merchant account, store, or individual terminal). * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from the Adyen PSP level, specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/terminalSettings", + "description": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Add EAP-PEAP and PSK Wi-Fi profiles", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"peap\",\n \"eapCaCert\": {\n \"data\": \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\": \"eap-peap-ca.pem\"\n},\n \"eapIdentity\": \"admin\",\n \"eapIntermediateCert\": {\n \"data\": \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\": \"eap-peap-client.pem\"\n},\n \"eapPwd\": \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-peap-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n},\n {\n \"authType\": \"wpa-psk\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": false,\n \"hiddenSsid\": false,\n \"name\": \"Profile-guest-wifi\",\n \"psk\": \"WIFI_PASSWORD\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Add EAP-TLS Wi-Fi profile", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"tls\",\n \"eapCaCert\": {\n \"data\": \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\": \"eap-tls-ca.pem\"\n},\n \"eapClientCert\": {\n \"data\": \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\": \"eap-tls-client.pem\"\n},\n \"eapClientKey\": {\n \"data\": \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\": \"rsa-private.key\"\n},\n \"eapClientPwd\": \"\",\n \"eapIdentity\": \"admin\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-tls-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the company identified in the path. These settings apply to all terminals under the company, unless different values are configured at a lower level (merchant account, store, or individual terminal). * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from the Adyen PSP level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + } + ] + }, + { + "name": "API credentials - company level", + "item": [ + { + "name": "/companies/{{companyId}}/apiCredentials", + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get a list of API credentials", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the list of [API credentials](https://docs.adyen.com/development-resources/api-credentials) for the company account. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}", + "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Get an API credential", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Returns the [API credential](https://docs.adyen.com/development-resources/api-credentials) identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}", + "description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Activate an API credential", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": \"true\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials/{{apiCredentialId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials", + "{{apiCredentialId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + }, + { + "key": "apiCredentialId", + "value": "", + "description": "Unique identifier of the API credential." + } + ], + "query": [ + ] + }, + "description": "Changes the API credential's roles, merchant account access, or allowed origins. The request has the new values for the fields you want to change. The response contains the full updated API credential, including the new values from the request. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/apiCredentials", + "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write", + "item": [ + { + "name": "Add an API credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\"Checkout webservice role\"],\n \"allowedOrigins\": [\"https: //www.mystore.com\"],\n \"associatedMerchantAccounts\": [\"{{YOUR_MERCHANT_ACCOUNT}}_AU\",\n \"{{YOUR_MERCHANT_ACCOUNT}}_EU\",\n \"{{YOUR_MERCHANT_ACCOUNT}}_US\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/apiCredentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "apiCredentials" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Creates an [API credential](https://docs.adyen.com/development-resources/api-credentials) for the company account identified in the path. In the request, you can specify which merchant accounts the new API credential will have access to, as well as its roles and allowed origins. The response includes several types of authentication details: * [API key](https://docs.adyen.com/development-resources/api-authentication#api-key-authentication): used for API request authentication. * [Client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works): public key used for client-side authentication. * [Username and password](https://docs.adyen.com/development-resources/api-authentication#using-basic-authentication): used for basic authentication. > Make sure you store the API key securely in your system. You won't be able to retrieve it later. If your API key is lost or compromised, you need to [generate a new API key](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/apiCredentials/{apiCredentialId}/generateApiKey). To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—API credentials read and write" + } + } + ] + } + ] + }, + { + "name": "Terminal orders - merchant level", + "item": [ + { + "name": "/merchants/{{merchantId}}/billingEntities", + "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of billing entities", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/billingEntities", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "billingEntities" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example" + } + ] + }, + "description": "Returns the billing entities of the merchant account identified in the path. A billing entity is a legal entity where we charge orders to. An order for terminal products must contain the ID of a billing entity. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/shippingLocations", + "description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of shipping locations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "name", + "value": "name_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns the shipping locations for the merchant account identified in the path. A shipping location includes the address where orders can be delivered, and an ID which you need to specify when ordering terminal products. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalModels", + "description": "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of terminal models", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalModels", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalModels" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Returns the payment terminal models that merchant account identified in the path has access to. The response includes the terminal model ID, which can be used as a query parameter when getting a list of terminals or a list of products for ordering. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalOrders", + "description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of orders", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "" + } + ], + "query": [ + { + "key": "customerOrderReference", + "value": "customerOrderReference_example" + }, + { + "key": "status", + "value": "status_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a list of terminal products orders for the merchant account identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalOrders/{{orderId}}", + "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get an order", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalOrders/{{orderId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalOrders", + "{{orderId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalProducts", + "description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Get a list of terminal products", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalProducts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalProducts" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + { + "key": "country", + "value": "country_example" + }, + { + "key": "terminalModelId", + "value": "terminalModelId_example" + }, + { + "key": "offset", + "value": "56" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns a country-specific list of payment terminal packages and parts that the merchant account identified in the path has access to. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalOrders/{{orderId}}", + "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Update a terminal order", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shippingLocation\": \"S2-73536B20665526704F30792642212044452F714622375D477270\",\n \"items\": [{\n \"id\": \"TBOX-V400m-684-EU\",\n \"name\": \"V400m Package\",\n \"quantity\": 1\n},\n {\n \"id\": \"PART-287001-EU\",\n \"name\": \"Bluetooth Charging Base - V400m\",\n \"quantity\": 2\n},\n {\n \"id\": \"PART-620222-EU\",\n \"name\": \"Receipt Roll\",\n \"quantity\": 20\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalOrders/{{orderId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalOrders", + "{{orderId}}" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Updates the terminal products order identified in the path. Updating is only possible while the order has the status **Placed**. The request body only needs to contain what you want to change. However, to update the products in the `items` array, you must provice the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/shippingLocations", + "description": "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Create a shipping location", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{YOUR_MERCHANT_ACCOUNT}} Barcelona depot\",\n \"address\": {\n \"companyName\": \"YOUR_COMPANY\",\n \"streetAddress\": \"El quinto pino 42\",\n \"postalCode\": \"08012\",\n \"city\": \"Barcelona\",\n \"stateOrProvince\": \"\",\n \"country\": \"ES\"\n},\n \"contact\": {\n \"firstName\": \"Rita\",\n \"lastName\": \"Perengano\",\n \"phoneNumber\": \"+34 93 1234567\",\n \"email\": \"Rita.Perengano@company.com\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/shippingLocations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "shippingLocations" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Creates a shipping location for the merchant account identified in the path. A shipping location defines an address where orders can be shipped to. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalOrders", + "description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Create an order", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"customerOrderReference\": \"{{$guid}}\",\n \"shippingLocationId\": \"S2-6A6C2E3432747D4F2F2C3455485E3836457D\",\n \"billingEntityId\": \"MerchantAccount.{{YOUR_MERCHANT_ACCOUNT}}\",\n \"items\": [{\n \"id\": \"PART-287001-EU\",\n \"name\": \"Bluetooth Charging Base - V400m\",\n \"quantity\": 2\n},\n {\n \"id\": \"PART-620222-EU\",\n \"name\": \"Receipt Roll\",\n \"quantity\": 20\n}]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalOrders", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalOrders" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + } + ], + "query": [ + ] + }, + "description": "Creates an order for payment terminal products for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/terminalOrders/{{orderId}}/cancel", + "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write", + "item": [ + { + "name": "Cancel an order", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/terminalOrders/{{orderId}}/cancel", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "terminalOrders", + "{{orderId}}", + "cancel" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "orderId", + "value": "", + "description": "The unique identifier of the order." + } + ], + "query": [ + ] + }, + "description": "Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write" + } + } + ] + } + ] + }, + { + "name": "Account - company level", + "item": [ + { + "name": "/companies", + "description": "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", + "item": [ + { + "name": "Get a list of company accounts", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies" + ], + "variable": [ + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read" + } + } + ] + }, + { + "name": "/companies/{{companyId}}", + "description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", + "item": [ + { + "name": "Get a company account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + ] + }, + "description": "Returns the company account specified in the path. Your API credential must have access to the company account. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read" + } + } + ] + }, + { + "name": "/companies/{{companyId}}/merchants", + "description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read", + "item": [ + { + "name": "Get a list of merchant accounts", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/companies/{{companyId}}/merchants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "companies", + "{{companyId}}", + "merchants" + ], + "variable": [ + { + "key": "companyId", + "value": "", + "description": "The unique identifier of the company account." + } + ], + "query": [ + { + "key": "pageNumber", + "value": "56" + }, + { + "key": "pageSize", + "value": "56" + } + ] + }, + "description": "Returns the list of merchant accounts under the company account specified in the path. The list only includes merchant accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Account read" + } + } + ] + } + ] + }, + { + "name": "Terminal settings - store level", + "item": [ + { + "name": "/merchants/{{merchantId}}/stores/{{reference}}/terminalLogos", + "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get the terminal logo", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores/{{reference}}/terminalSettings", + "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get terminal settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}/terminalLogos", + "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get the terminal logo", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Returns the logo that is configured for a specific payment terminal model at the store identified in the path. The logo is returned as a Base64-encoded string. You need to Base64-decode the string to get the actual image file. This logo applies to all terminals of that model under the store unless a different logo is configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}/terminalSettings", + "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write", + "item": [ + { + "name": "Get terminal settings", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Returns the payment terminal settings that are configured for the store identified in the path. These settings apply to all terminals under the store unless different values are configured for an individual terminal. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores/{{reference}}/terminalLogos", + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Remove logo to restore the logo from a higher level", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Upload terminal logo", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalLogos" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/merchants/{{merchantId}}/stores/{{reference}}/terminalSettings", + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Add EAP-PEAP and PSK Wi-Fi profiles", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"peap\",\n \"eapCaCert\": {\n \"data\": \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\": \"eap-peap-ca.pem\"\n},\n \"eapIdentity\": \"admin\",\n \"eapIntermediateCert\": {\n \"data\": \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\": \"eap-peap-client.pem\"\n},\n \"eapPwd\": \"EAP_PEAP_PASSWORD\",\n \"name\": \"Profile-eap-peap-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n},\n {\n \"authType\": \"wpa-psk\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": false,\n \"name\": \"Profile-guest-wifi\",\n \"psk\": \"WIFI_PASSWORD\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Add EAP-TLS Wi-Fi profile", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"tls\",\n \"eapCaCert\": {\n \"data\": \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\": \"eap-tls-ca.pem\"\n},\n \"eapClientCert\": {\n \"data\": \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\": \"eap-tls-client.pem\"\n},\n \"eapClientKey\": {\n \"data\": \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\": \"rsa-private.key\"\n},\n \"eapClientPwd\": \"\",\n \"eapIdentity\": \"admin\",\n \"name\": \"Profile-eap-tls-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/merchants/{{merchantId}}/stores/{{reference}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "merchants", + "{{merchantId}}", + "stores", + "{{reference}}", + "terminalSettings" + ], + "variable": [ + { + "key": "merchantId", + "value": "", + "description": "The unique identifier of the merchant account." + }, + { + "key": "reference", + "value": "", + "description": "The reference that identifies the store." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}/terminalLogos", + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Remove logo to restore the logo from a higher level", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Upload terminal logo", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"data\": \"LOGO_FILE_CONVERTED_TO_A_BASE-64_ENCODED_STRING\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalLogos", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalLogos" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + { + "key": "model", + "value": "model_example" + } + ] + }, + "description": "Updates the logo that is configured for a specific payment terminal model at the store identified in the path. You can update the logo for only one terminal model at a time. This logo applies to all terminals of the specified model under the store, unless a different logo is configured for an individual terminal. * To change the logo, specify the image file as a Base64-encoded string. * To restore the logo inherited from a higher level (merchant or company account), specify an empty logo value. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + }, + { + "name": "/stores/{{storeId}}/terminalSettings", + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write", + "item": [ + { + "name": "Add EAP-PEAP and PSK Wi-Fi profiles", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"peap\",\n \"eapCaCert\": {\n \"data\": \"MD1rKS05M2JqRVFNQ...RTtLH1tLWo=\",\n \"name\": \"eap-peap-ca.pem\"\n},\n \"eapIdentity\": \"admin\",\n \"eapIntermediateCert\": {\n \"data\": \"PD3tUS1CRDdJTiGDR...EFoLS0tLQg=\",\n \"name\": \"eap-peap-client.pem\"\n},\n \"eapPwd\": \"EAP_PEAP_PASSWORD\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-peap-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n},\n {\n \"authType\": \"wpa-psk\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": false,\n \"hiddenSsid\": false,\n \"name\": \"Profile-guest-wifi\",\n \"psk\": \"WIFI_PASSWORD\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + }, + { + "name": "Add EAP-TLS Wi-Fi profile", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"wifiProfiles\": {\n \"profiles\": [{\n \"authType\": \"wpa-eap\",\n \"autoWifi\": false,\n \"bssType\": \"infra\",\n \"channel\": 0,\n \"defaultProfile\": true,\n \"eap\": \"tls\",\n \"eapCaCert\": {\n \"data\": \"LS0tLS05M2JqRVFNQ...EUtLS0tLQo=\",\n \"name\": \"eap-tls-ca.pem\"\n},\n \"eapClientCert\": {\n \"data\": \"LS0tLS1CRUdJTiBDR...EUtLS0tLQo=\",\n \"name\": \"eap-tls-client.pem\"\n},\n \"eapClientKey\": {\n \"data\": \"AAAB3NzaC1...Rtah3KLFwPU=\",\n \"name\": \"rsa-private.key\"\n},\n \"eapClientPwd\": \"\",\n \"eapIdentity\": \"admin\",\n \"hiddenSsid\": false,\n \"name\": \"Profile-eap-tls-1\",\n \"ssid\": \"your-network\",\n \"wsec\": \"ccmp\"\n}],\n \"settings\": {\n \"band\": \"2.4GHz\",\n \"roaming\": true,\n \"timeout\": 5\n}\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/stores/{{storeId}}/terminalSettings", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stores", + "{{storeId}}", + "terminalSettings" + ], + "variable": [ + { + "key": "storeId", + "value": "", + "description": "The unique identifier of the store." + } + ], + "query": [ + ] + }, + "description": "Updates payment terminal settings for the store identified in the path. These settings apply to all terminals under the store, unless different values are configured for an individual terminal. * To change a parameter value, include the full object that contains the parameter, even if you don't want to change all parameters in the object. * To restore a parameter value inherited from a higher level, include the full object that contains the parameter, and specify an empty value for the parameter or omit the parameter. * Objects that are not included in the request are not updated. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal settings read and write" + } + } + ] + } + ] + } + ], + "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://management-test.adyen.com/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "webhookId", + "value": "webhookId_example", + "type": "string" + }, + { + "key": "payoutSettingsId", + "value": "payoutSettingsId_example", + "type": "string" + }, + { + "key": "orderId", + "value": "orderId_example", + "type": "string" + }, + { + "key": "terminalId", + "value": "terminalId_example", + "type": "string" + }, + { + "key": "storeId", + "value": "storeId_example", + "type": "string" + }, + { + "key": "userId", + "value": "userId_example", + "type": "string" + }, + { + "key": "reference", + "value": "reference_example", + "type": "string" + }, + { + "key": "originId", + "value": "originId_example", + "type": "string" + }, + { + "key": "apiCredentialId", + "value": "apiCredentialId_example", + "type": "string" + }, + { + "key": "merchantId", + "value": "merchantId_example", + "type": "string" + }, + { + "key": "paymentMethodId", + "value": "paymentMethodId_example", + "type": "string" + }, + { + "key": "YOUR_COMPANY_ACCOUNT", + "value": "", + "type": "string" + }, + { + "key": "actionId", + "value": "actionId_example", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + }, + { + "key": "companyId", + "value": "companyId_example", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v30.json b/postman/PayoutService-v30.json new file mode 100644 index 0000000..6b4f023 --- /dev/null +++ b/postman/PayoutService-v30.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v30)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v30/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v30/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "30", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v30", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v40.json b/postman/PayoutService-v40.json new file mode 100644 index 0000000..c8be9c6 --- /dev/null +++ b/postman/PayoutService-v40.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v40)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v40/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v40/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "40", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v40", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v50.json b/postman/PayoutService-v50.json new file mode 100644 index 0000000..6dbc70e --- /dev/null +++ b/postman/PayoutService-v50.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v50)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v50/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v50/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "50", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v50", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v51.json b/postman/PayoutService-v51.json new file mode 100644 index 0000000..64ab1e5 --- /dev/null +++ b/postman/PayoutService-v51.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v51)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v51/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v51/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "51", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v51", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v52.json b/postman/PayoutService-v52.json new file mode 100644 index 0000000..e0fea5c --- /dev/null +++ b/postman/PayoutService-v52.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v52)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v52/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v52/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "52", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v52", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v64.json b/postman/PayoutService-v64.json new file mode 100644 index 0000000..502e405 --- /dev/null +++ b/postman/PayoutService-v64.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v64)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v64/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v64/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "64", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v64", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v67.json b/postman/PayoutService-v67.json new file mode 100644 index 0000000..8df331a --- /dev/null +++ b/postman/PayoutService-v67.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v67)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v67/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v67/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "67", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v67", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/PayoutService-v68.json b/postman/PayoutService-v68.json new file mode 100644 index 0000000..9154c04 --- /dev/null +++ b/postman/PayoutService-v68.json @@ -0,0 +1,526 @@ +{ + "info": { + "name": "Adyen Payout API (v68)", + "description": { + "content": "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nPayments 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://pal-test.adyen.com/pal/servlet/Payout/v68/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v68/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "68", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Initialization", + "item": [ + { + "name": "/storeDetail", + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "item": [ + { + "name": "Store payout details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"bank\": {\n \"bankName\": \"AbnAmro\",\n \"bic\": \"ABNANL2A\",\n \"countryCode\": \"NL\",\n \"iban\": \"NL32ABNA0515071439\",\n \"ownerName\": \"Adyen\",\n \"bankCity\": \"Amsterdam\",\n \"taxId\": \"bankTaxId\"\n},\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"billingAddress\": {\n \"houseNumberOrName\": \"17\",\n \"street\": \"Teststreet 1\",\n \"city\": \"Amsterdam\",\n \"stateOrProvince\": \"NY\",\n \"country\": \"US\",\n \"postalCode\": \"12345\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetail", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetail" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call." + } + } + ] + }, + { + "name": "/storeDetailAndSubmitThirdParty", + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout and stores details", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"RECURRING,PAYOUT\"\n},\n \"amount\": {\n \"value\": 2000,\n \"currency\": \"EUR\"\n},\n \"bank\": {\n \"bankName\": \"Wirecard\",\n \"iban\": \"DE87123456781234567890\",\n \"countryCode\": \"DE\",\n \"ownerName\": \"Simon Hopper\"\n},\n \"reference\": \"Your Reference Here\",\n \"shopperEmail\": \"s.hopper@test.com\",\n \"shopperIP\": \"61.294.12.12\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Neteller", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"neteller\",\n \"additionalData\": {\n \"tokenDataType\": \"Neteller\",\n \"account\": \"myNetellerAccount\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to PayPal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1750\n},\n \"selectedBrand\": \"paypal\",\n \"additionalData\": {\n \"tokenDataType\": \"PayPal\",\n \"emailId\": \"EmailUsedForPayPalAccount@example.com\",\n \"paypal.payerId\": \"AK5HCWWRUV2KL\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Paysafecard", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"selectedBrand\": \"paysafecard\",\n \"additionalData\": {\n \"emailId\": \"EmailUsedForPaysafecardAccount@example.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperIP\": \"61.294.12.12\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + }, + { + "name": "Submit a payout to Skrill", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 100\n},\n \"selectedBrand\": \"moneybookers\",\n \"additionalData\": {\n \"tokenDataType\": \"MoneyBookers\",\n \"email\": \"name@adyen.com\"\n},\n \"shopperName\": {\n \"firstName\": \"Test\",\n \"gender\": \"FEMALE\",\n \"lastName\": \"Test2\"\n},\n \"dateOfBirth\": \"1982-07-17\",\n \"entityType\": \"NaturalPerson\",\n \"nationality\": \"NL\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"Test Payout\",\n \"shopperEmail\": \"test@company.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/storeDetailAndSubmitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "storeDetailAndSubmitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + }, + { + "name": "/submitThirdParty", + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "item": [ + { + "name": "Submit a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"recurring\": {\n \"contract\": \"PAYOUT\"\n},\n \"reference\": \"PayoutPayment-0001\",\n \"shopperEmail\": \"shopper@email.com\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"shopperName\": {\n \"firstName\": \"Adyen\",\n \"gender\": \"MALE\",\n \"lastName\": \"Test\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"entityType\": \"Company\",\n \"nationality\": \"NL\",\n \"selectedRecurringDetailReference\": \"LATEST\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/submitThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "submitThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls." + } + } + ] + } + ] + }, + { + "name": "Instant payouts", + "item": [ + { + "name": "/payout", + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "item": [ + { + "name": "Instant card payout (B2C)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + }, + { + "name": "Instant card payout (P2P)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 2500,\n \"currency\": \"USD\"\n},\n \"card\": {\n \"number\": \"4111111111111111\",\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"John Smith\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"fundSource\": {\n \"additionalData\": {\n \"fundingSource\": \"DEBIT\"\n},\n \"billingAddress\": {\n \"houseNumberOrName\": \"121\",\n \"street\": \"Brannan Street\",\n \"city\": \"Beverly Hills\",\n \"postalCode\": \"90210\",\n \"stateOrProvince\": \"CA\",\n \"country\": \"US\"\n},\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Payer Name\",\n \"number\": \"4400000000000008\"\n},\n \"shopperName\": {\n \"firstName\": \"Payer\",\n \"lastName\": \"Name\"\n}\n},\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"P9999999999999999\",\n \"shopperName\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n},\n \"shopperStatement\": \"Payer Name\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"NL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/payout", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "payout" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards." + } + } + ] + } + ] + }, + { + "name": "Reviewing", + "item": [ + { + "name": "/confirmThirdParty", + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.", + "item": [ + { + "name": "Confirm a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/confirmThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "confirmThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint." + } + } + ] + }, + { + "name": "/declineThirdParty", + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "item": [ + { + "name": "Cancel a payout", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"originalReference\": \"9913140798220028\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/declineThirdParty", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "declineThirdParty" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Payout/v68", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v25.json b/postman/RecurringService-v25.json new file mode 100644 index 0000000..af4eddb --- /dev/null +++ b/postman/RecurringService-v25.json @@ -0,0 +1,270 @@ +{ + "info": { + "name": "Adyen Recurring API (v25)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v25/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v25/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "25", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v25", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v30.json b/postman/RecurringService-v30.json new file mode 100644 index 0000000..d3caafc --- /dev/null +++ b/postman/RecurringService-v30.json @@ -0,0 +1,270 @@ +{ + "info": { + "name": "Adyen Recurring API (v30)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v30/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "30", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v30", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v40.json b/postman/RecurringService-v40.json new file mode 100644 index 0000000..9061586 --- /dev/null +++ b/postman/RecurringService-v40.json @@ -0,0 +1,315 @@ +{ + "info": { + "name": "Adyen Recurring API (v40)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v40/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v40/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "40", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/createPermit", + "description": "Create permits for a recurring contract, including support for defining restrictions.", + "item": [ + { + "name": "Create new permits linked to a recurring contract.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." + } + } + ] + }, + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v40", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v49.json b/postman/RecurringService-v49.json new file mode 100644 index 0000000..a2f6949 --- /dev/null +++ b/postman/RecurringService-v49.json @@ -0,0 +1,315 @@ +{ + "info": { + "name": "Adyen Recurring API (v49)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v49/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v49/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "49", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/createPermit", + "description": "Create permits for a recurring contract, including support for defining restrictions.", + "item": [ + { + "name": "Create new permits linked to a recurring contract.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." + } + } + ] + }, + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v49", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v67.json b/postman/RecurringService-v67.json new file mode 100644 index 0000000..5d3c101 --- /dev/null +++ b/postman/RecurringService-v67.json @@ -0,0 +1,360 @@ +{ + "info": { + "name": "Adyen Recurring API (v67)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v67/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v67/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "67", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/createPermit", + "description": "Create permits for a recurring contract, including support for defining restrictions.", + "item": [ + { + "name": "Create new permits linked to a recurring contract.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." + } + } + ] + }, + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/disablePermit", + "description": "Disable a permit that was previously linked to a recurringDetailReference.", + "item": [ + { + "name": "Disable an existing permit.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disablePermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disablePermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disable a permit that was previously linked to a recurringDetailReference." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v67", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/RecurringService-v68.json b/postman/RecurringService-v68.json new file mode 100644 index 0000000..672a369 --- /dev/null +++ b/postman/RecurringService-v68.json @@ -0,0 +1,360 @@ +{ + "info": { + "name": "Adyen Recurring API (v68)", + "description": { + "content": "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\n-H \"Content-Type: application/json\" \\n...\n```\n\n## Versioning\nRecurring 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://pal-test.adyen.com/pal/servlet/Recurring/v68/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "type": "text/markdown" + }, + "version": "68", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/createPermit", + "description": "Create permits for a recurring contract, including support for defining restrictions.", + "item": [ + { + "name": "Create new permits linked to a recurring contract.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"permits\": \"\",\n \"recurringDetailReference\": \"\",\n \"shopperReference\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createPermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createPermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Create permits for a recurring contract, including support for defining restrictions." + } + } + ] + }, + { + "name": "/disable", + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).", + "item": [ + { + "name": "Disable a recurring contract", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"recurringDetailReference\": \"8314442372419167\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disable" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disables stored payment details to stop charging a shopper with this particular recurring detail ID. For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/)." + } + } + ] + }, + { + "name": "/disablePermit", + "description": "Disable a permit that was previously linked to a recurringDetailReference.", + "item": [ + { + "name": "Disable an existing permit.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"token\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/disablePermit", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "disablePermit" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Disable a permit that was previously linked to a recurringDetailReference." + } + } + ] + }, + { + "name": "/listRecurringDetails", + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).", + "item": [ + { + "name": "List recurring details of the specified contract value", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"recurring\": {\n \"contract\": \"RECURRING\"\n},\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/listRecurringDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "listRecurringDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Lists the stored payment details for a shopper, if there are any available. The recurring detail ID can be used with a regular authorisation request to charge the shopper. A summary of the payment detail is returned for presentation to the shopper. For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/)." + } + } + ] + }, + { + "name": "/notifyShopper", + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india).", + "item": [ + { + "name": "Request issuer to notify shopper of upcoming recurring payment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"storedPaymentMethodId\": \"8415995487234100\",\n \"shopperReference\": \"YOUR_SHOPPER_REFERENCE\",\n \"amount\": {\n \"currency\": \"INR\",\n \"value\": 1000\n},\n \"billingDate\": \"2021-03-16\",\n \"reference\": \"Example reference\",\n \"displayedReference\": \"exampleDisplayedReference\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/notifyShopper", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "notifyShopper" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to [Recurring card payments in India](https://docs.adyen.com/payment-methods/cards/cards-recurring-india)." + } + } + ] + }, + { + "name": "/scheduleAccountUpdater", + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory.", + "item": [ + { + "name": "Schedule AccountUpdater with card data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"card\": {\n \"expiryMonth\": \"03\",\n \"expiryYear\": \"2030\",\n \"holderName\": \"Adyen Test\",\n \"number\": \"4111111111111111\"\n}\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + }, + { + "name": "Schedule AccountUpdater with token data", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"reference\": \"{{$guid}}\",\n \"shopperReference\": \"YOUR_UNIQUE_SHOPPER_ID\",\n \"selectedRecurringDetailReference\": \"8814232895168272\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/scheduleAccountUpdater", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "scheduleAccountUpdater" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "When making the API call, you can submit either the credit card information, or the recurring detail reference and the shopper reference: * If the card information is provided, all the sub-fields for `card` are mandatory. * If the recurring detail reference is provided, the fields for `shopperReference` and `selectedRecurringDetailReference` are mandatory." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/Recurring/v68", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/StoredValueService-v46.json b/postman/StoredValueService-v46.json new file mode 100644 index 0000000..d6cf9e0 --- /dev/null +++ b/postman/StoredValueService-v46.json @@ -0,0 +1,316 @@ +{ + "info": { + "name": "Adyen Stored Value API (v46)", + "description": { + "content": "A set of API endpoints to manage stored value products.", + "type": "text/markdown" + }, + "version": "46", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/changeStatus", + "description": "Changes the status of the provided payment method to the specified status.", + "item": [ + { + "name": "Changes the status of the payment method.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"status\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/changeStatus", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "changeStatus" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Changes the status of the provided payment method to the specified status." + } + } + ] + }, + { + "name": "/checkBalance", + "description": "Checks the balance of the provided payment method.", + "item": [ + { + "name": "Checks the balance.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/checkBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "checkBalance" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Checks the balance of the provided payment method." + } + } + ] + }, + { + "name": "/issue", + "description": "Issues a new card of the given payment method.", + "item": [ + { + "name": "Issues a new card.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/issue", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "issue" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Issues a new card of the given payment method." + } + } + ] + }, + { + "name": "/load", + "description": "Loads the payment method with the specified funds.", + "item": [ + { + "name": "Loads the payment method.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"loadType\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/load", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "load" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Loads the payment method with the specified funds." + } + } + ] + }, + { + "name": "/mergeBalance", + "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod", + "item": [ + { + "name": "Merge the balance of two cards.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": \"\",\n \"merchantAccount\": \"\",\n \"paymentMethod\": \"\",\n \"recurringDetailReference\": \"\",\n \"reference\": \"\",\n \"shopperInteraction\": \"\",\n \"shopperReference\": \"\",\n \"sourcePaymentMethod\": \"\",\n \"store\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/mergeBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "mergeBalance" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod" + } + } + ] + }, + { + "name": "/voidTransaction", + "description": "Voids the referenced stored value transaction.", + "item": [ + { + "name": "Voids a transaction.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"merchantAccount\": \"\",\n \"originalReference\": \"\",\n \"reference\": \"\",\n \"store\": \"\",\n \"tenderReference\": \"\",\n \"uniqueTerminalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/voidTransaction", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "voidTransaction" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Voids the referenced stored value transaction." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/servlet/StoredValue/v46", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/TestCardService-v1.json b/postman/TestCardService-v1.json new file mode 100644 index 0000000..35ae7e3 --- /dev/null +++ b/postman/TestCardService-v1.json @@ -0,0 +1,91 @@ +{ + "info": { + "name": "Adyen Test Cards API (v1)", + "description": { + "content": "The Test Cards API provides endpoints for generating custom test card numbers. For more information, refer to [Custom test cards](https://docs.adyen.com/development-resources/testing/create-test-cards) documentation.", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/createTestCardRanges", + "description": "Creates one or more test card ranges.", + "item": [ + { + "name": "Creates one or more test card ranges.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accountCode\": \"\",\n \"accountTypeCode\": \"\",\n \"testCardRanges\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/createTestCardRanges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "createTestCardRanges" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Creates one or more test card ranges." + } + } + ] + } + ] + } + ], + "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://pal-test.adyen.com/pal/services/TestCard/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/TfmAPIService-v1.json b/postman/TfmAPIService-v1.json new file mode 100644 index 0000000..6ea39bc --- /dev/null +++ b/postman/TfmAPIService-v1.json @@ -0,0 +1,476 @@ +{ + "info": { + "name": "POS Terminal Management API (v1)", + "description": { + "content": "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api).\n\n## Authentication\nEach request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then 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```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nTerminal Management 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://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```\nWhen using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`.\nIf you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`.", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "/assignTerminals", + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.", + "item": [ + { + "name": "Assign a terminal to the company inventory", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"terminals\": [\"P400Plus-275479597\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." + } + }, + { + "name": "Assign a terminal to the inventory of a merchant account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"merchantInventory\": true,\n \"terminals\": [\"P400Plus-275479597\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." + } + }, + { + "name": "Assign a terminal to a store", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\",\n \"terminals\": [\"P400Plus-275479597\"]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/assignTerminals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "assignTerminals" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory." + } + } + ] + }, + { + "name": "/findTerminal", + "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to.", + "item": [ + { + "name": "Find where a terminal is assigned to", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\": \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/findTerminal", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "findTerminal" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the company account, merchant account, or store that a payment terminal is assigned to." + } + } + ] + }, + { + "name": "/getStoresUnderAccount", + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store.", + "item": [ + { + "name": "Get all the stores under a company", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." + } + }, + { + "name": "Get all the stores under a merchant account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getStoresUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getStoresUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of stores associated with a company account or a merchant account, including the status of each store." + } + } + ] + }, + { + "name": "/getTerminalDetails", + "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.", + "item": [ + { + "name": "Get information about a specific terminal", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"terminal\": \"M400-401972715\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalDetails", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalDetails" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report." + } + } + ] + }, + { + "name": "/getTerminalsUnderAccount", + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).", + "item": [ + { + "name": "Get all the terminals under a company account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." + } + }, + { + "name": "Get all the terminals under a merchant account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." + } + }, + { + "name": "Get all the terminals assigned to a store", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"companyAccount\": \"{{YOUR_COMPANY_ACCOUNT}}\",\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\",\n \"store\": \"YOUR_STORE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/getTerminalsUnderAccount", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "getTerminalsUnderAccount" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded)." + } + } + ] + } + ] + } + ], + "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://postfmapi-test.adyen.com/postfmapi/terminal/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "YOUR_COMPANY_ACCOUNT", + "value": "", + "type": "string" + }, + { + "key": "YOUR_MERCHANT_ACCOUNT", + "value": "", + "type": "string" + } + ] +} + diff --git a/postman/TransferService-v1.json b/postman/TransferService-v1.json new file mode 100644 index 0000000..2823a15 --- /dev/null +++ b/postman/TransferService-v1.json @@ -0,0 +1,260 @@ +{ + "info": { + "name": "Transfers API (v1)", + "description": { + "content": "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v1/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n", + "type": "text/markdown" + }, + "version": "1", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Transactions", + "item": [ + { + "name": "/transactions", + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", + "item": [ + { + "name": "Get all transactions", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "value": "balancePlatform_example" + }, + { + "key": "paymentInstrumentId", + "value": "paymentInstrumentId_example" + }, + { + "key": "accountHolderId", + "value": "accountHolderId_example" + }, + { + "key": "balanceAccountId", + "value": "balanceAccountId_example" + }, + { + "key": "cursor", + "value": "cursor_example" + }, + { + "key": "createdSince", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "createdUntil", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable." + } + } + ] + }, + { + "name": "/transactions/{{id}}", + "description": "Returns a transaction.", + "item": [ + { + "name": "Get a transaction", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "Unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "description": "Returns a transaction." + } + } + ] + } + ] + }, + { + "name": "Transfers", + "item": [ + { + "name": "/transfers", + "description": "Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.", + "item": [ + { + "name": "Transfer funds to another balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n},\n \"destination\": {\n \"balanceAccountId\": \"BAB1234567890ABC123456789\"\n},\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Pay out to a transfer instrument", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source\": {\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\"\n},\n \"destination\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a transfer request to move funds within your balance platform, or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/v1/post/transferInstruments). Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + } + ] + } + ] + } + ], + "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://balanceplatform-api-test.adyen.com/btl/v1", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + } + ] +} + diff --git a/postman/TransferService-v2.json b/postman/TransferService-v2.json new file mode 100644 index 0000000..915cdcb --- /dev/null +++ b/postman/TransferService-v2.json @@ -0,0 +1,299 @@ +{ + "info": { + "name": "Transfers API (v2)", + "description": { + "content": "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v2/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n", + "type": "text/markdown" + }, + "version": "2", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Transactions", + "item": [ + { + "name": "/transactions", + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", + "item": [ + { + "name": "Get all transactions", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "value": "balancePlatform_example" + }, + { + "key": "paymentInstrumentId", + "value": "paymentInstrumentId_example" + }, + { + "key": "accountHolderId", + "value": "accountHolderId_example" + }, + { + "key": "balanceAccountId", + "value": "balanceAccountId_example" + }, + { + "key": "cursor", + "value": "cursor_example" + }, + { + "key": "createdSince", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "createdUntil", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable." + } + } + ] + }, + { + "name": "/transactions/{{id}}", + "description": "Returns a transaction.", + "item": [ + { + "name": "Get a transaction", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "Unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "description": "Returns a transaction." + } + } + ] + } + ] + }, + { + "name": "Transfers", + "item": [ + { + "name": "/transfers", + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.", + "item": [ + { + "name": "Make a SEPA funds transfer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"bankAccount\": {\n \"iban\": \"NL13TEST0123456789\",\n \"ownerName\": {\n \"fullName\": \"A. Klaassen\"\n}\n}\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Transfer funds to another balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"balanceAccountId\": \"BAB1234567890ABC123456789\"\n},\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Pay out to a transfer instrument", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + } + ] + } + ] + } + ], + "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://balanceplatform-api-test.adyen.com/btl/v2", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + } + ] +} + diff --git a/postman/TransferService-v3.json b/postman/TransferService-v3.json new file mode 100644 index 0000000..6998bcb --- /dev/null +++ b/postman/TransferService-v3.json @@ -0,0 +1,377 @@ +{ + "info": { + "name": "Transfers API (v3)", + "description": { + "content": "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers 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://balanceplatform-api-test.adyen.com/btl/v3/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n", + "type": "text/markdown" + }, + "version": "3", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Transactions", + "item": [ + { + "name": "/transactions", + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable.", + "item": [ + { + "name": "Get all transactions", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions" + ], + "variable": [ + ], + "query": [ + { + "key": "balancePlatform", + "value": "balancePlatform_example" + }, + { + "key": "paymentInstrumentId", + "value": "paymentInstrumentId_example" + }, + { + "key": "accountHolderId", + "value": "accountHolderId_example" + }, + { + "key": "balanceAccountId", + "value": "balanceAccountId_example" + }, + { + "key": "cursor", + "value": "cursor_example" + }, + { + "key": "createdSince", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "createdUntil", + "value": "2013-10-20T19:20:30+01:00" + }, + { + "key": "limit", + "value": "56" + } + ] + }, + "description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable." + } + } + ] + }, + { + "name": "/transactions/{{id}}", + "description": "Returns a transaction.", + "item": [ + { + "name": "Get a transaction", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transactions/{{id}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transactions", + "{{id}}" + ], + "variable": [ + { + "key": "id", + "value": "", + "description": "Unique identifier of the transaction." + } + ], + "query": [ + ] + }, + "description": "Returns a transaction." + } + } + ] + } + ] + }, + { + "name": "Transfers", + "item": [ + { + "name": "/transfers", + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.", + "item": [ + { + "name": "Make a cross border transfer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\",\n \"address\": {\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"postalCode\": \"94678\",\n \"stateOrProvince\": \"CA\",\n \"street\": \"Brannan Street\",\n \"street2\": \"274\"\n}\n}\n},\n \"accountIdentification\": {\n \"type\": \"numberAndBic\",\n \"accountNumber\": \"123456789\",\n \"bic\": \"BOFAUS3NXXX\"\n}\n},\n \"priority\": \"wire\",\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Make a SEPA funds transfer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Make a US local funds transfer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"USD\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"011000138\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Transfer funds to another balance account", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"internal\",\n \"counterparty\": {\n \"balanceAccountId\": \"BA32272223222B5LPRFDW7J9G\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + }, + { + "name": "Pay out to a transfer instrument", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/transfers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "transfers" + ], + "variable": [ + ], + "query": [ + ] + }, + "description": "Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you." + } + } + ] + } + ] + } + ], + "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://balanceplatform-api-test.adyen.com/btl/v3", + "type": "string" + }, + { + "key": "X-API-Key", + "value": "", + "type": "string" + }, + { + "key": "id", + "value": "id_example", + "type": "string" + } + ] +} + diff --git a/runDocker.sh b/runDocker.sh new file mode 100755 index 0000000..468f9ee --- /dev/null +++ b/runDocker.sh @@ -0,0 +1,10 @@ +#!/bin/sh + +if [ ! -d /adyen-openapi ]; then + git clone https://github.com/Adyen/adyen-openapi.git +fi + +docker run --volume $(pwd):/usr/src/app --entrypoint /usr/src/app/generateAll.sh gcatanese/openapi-generator-postman-v2 + +# clean up +rm -rf adyen-openapi \ No newline at end of file