jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Setup with scripts to generate, and first actual generation (#1)

Browse Source 
* Sets up project
* Creates iterative script to run in Docker image
This commit is contained in:
julien Lengrand-Lambert
2023-02-15 11:52:23 +01:00
committed by GitHub
parent c2226a03e5
commit f2214c134a
54 changed files with 58868 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1 @@
@jlengrand @gcatanese

3
.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
adyen-openapi
.idea
.DS_Store

35
README.md
View File

@@ -1 +1,34 @@
# adyen-postman
# 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.

39
generateAll.sh Executable file
View File

@@ -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

BIN
images/import-postman.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.5 MiB

0
postman/.keep Normal file
View File

91
postman/BalanceControlService-v1.json Normal file
View File

@@ -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"
}
]
}

1728
postman/BalancePlatformService-v2.json Normal file
View File

File diff suppressed because it is too large Load Diff

297
postman/BinLookupService-v40.json Normal file
View File

@@ -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"
}
]
}

297
postman/BinLookupService-v50.json Normal file
View File

@@ -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"
}
]
}

297
postman/BinLookupService-v52.json Normal file
View File

@@ -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"
}
]
}

297
postman/BinLookupService-v53.json Normal file
View File

@@ -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"
}
]
}

297
postman/BinLookupService-v54.json Normal file
View File

@@ -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"
}
]
}

1845
postman/CheckoutService-v37.json Normal file
View File

File diff suppressed because it is too large Load Diff

2189
postman/CheckoutService-v40.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v41.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v46.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v49.json Normal file
View File

File diff suppressed because it is too large Load Diff

2406
postman/CheckoutService-v50.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v51.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v52.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v53.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v64.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v65.json Normal file
View File

File diff suppressed because it is too large Load Diff

2363
postman/CheckoutService-v66.json Normal file
View File

File diff suppressed because it is too large Load Diff

2275
postman/CheckoutService-v67.json Normal file
View File

File diff suppressed because it is too large Load Diff

2410
postman/CheckoutService-v68.json Normal file
View File

File diff suppressed because it is too large Load Diff

2410
postman/CheckoutService-v69.json Normal file
View File

File diff suppressed because it is too large Load Diff

2524
postman/CheckoutService-v70.json Normal file
View File

File diff suppressed because it is too large Load Diff

91
postman/DataProtectionService-v1.json Normal file
View File

@@ -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\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"pspReference\": \"<string>\"\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"
}
]
}

1332
postman/LegalEntityService-v1.json Normal file
View File

File diff suppressed because it is too large Load Diff

1467
postman/LegalEntityService-v2.json Normal file
View File

File diff suppressed because it is too large Load Diff

7344
postman/ManagementService-v1.json Normal file
View File

File diff suppressed because it is too large Load Diff

526
postman/PayoutService-v30.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v40.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v50.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v51.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v52.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v64.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v67.json Normal file
View File

@@ -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"
}
]
}

526
postman/PayoutService-v68.json Normal file
View File

@@ -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"
}
]
}

270
postman/RecurringService-v25.json Normal file
View File

@@ -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"
}
]
}

270
postman/RecurringService-v30.json Normal file
View File

@@ -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"
}
]
}

315
postman/RecurringService-v40.json Normal file
View File

@@ -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\": \"<string>\",\n \"permits\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"shopperReference\": \"<string>\"\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"
}
]
}

315
postman/RecurringService-v49.json Normal file
View File

@@ -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\": \"<string>\",\n \"permits\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"shopperReference\": \"<string>\"\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"
}
]
}

360
postman/RecurringService-v67.json Normal file
View File

@@ -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\": \"<string>\",\n \"permits\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"shopperReference\": \"<string>\"\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\": \"<string>\",\n \"token\": \"<string>\"\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"
}
]
}

360
postman/RecurringService-v68.json Normal file
View File

@@ -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\": \"<string>\",\n \"permits\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"shopperReference\": \"<string>\"\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\": \"<string>\",\n \"token\": \"<string>\"\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"
}
]
}

316
postman/StoredValueService-v46.json Normal file
View File

@@ -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\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"shopperInteraction\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"status\": \"<string>\",\n \"store\": \"<string>\"\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\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"shopperInteraction\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"store\": \"<string>\"\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\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"shopperInteraction\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"store\": \"<string>\"\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\": \"<string>\",\n \"loadType\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"shopperInteraction\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"store\": \"<string>\"\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\": \"<string>\",\n \"merchantAccount\": \"<string>\",\n \"paymentMethod\": \"<string>\",\n \"recurringDetailReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"shopperInteraction\": \"<string>\",\n \"shopperReference\": \"<string>\",\n \"sourcePaymentMethod\": \"<string>\",\n \"store\": \"<string>\"\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\": \"<string>\",\n \"originalReference\": \"<string>\",\n \"reference\": \"<string>\",\n \"store\": \"<string>\",\n \"tenderReference\": \"<string>\",\n \"uniqueTerminalId\": \"<string>\"\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"
}
]
}

91
postman/TestCardService-v1.json Normal file
View File

@@ -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\": \"<string>\",\n \"accountTypeCode\": \"<string>\",\n \"testCardRanges\": \"<string>\"\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"
}
]
}

476
postman/TfmAPIService-v1.json Normal file
View File

@@ -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"
}
]
}

260
postman/TransferService-v1.json Normal file
View File

@@ -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"
}
]
}

299
postman/TransferService-v2.json Normal file
View File

@@ -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"
}
]
}

377
postman/TransferService-v3.json Normal file
View File

@@ -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"
}
]
}

10
runDocker.sh Executable file
View File

@@ -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