Adyen Payout API

https://pal-test.adyen.com/pal/servlet/Payout/v68
Click to copy

A set of API endpoints that allow you to store payout details, confirm, or decline a payout.

For more information, refer to Online payouts.

Authentication

To use the Payout API, you need to have two API credentials: 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.

If using an API key, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Alternatively, you can use the username and password to connect to the API using basic authentication.

The following example shows how to authenticate your request with basic authentication when submitting a payout:

curl
-U "storePayout@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \
-H "Content-Type: application/json" \
...

Versioning

Payments API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://pal-test.adyen.com/pal/servlet/Payout/v68/payout

Going live

To authenticate to the live endpoints, you need API credentials from your live Customer Area.

The live endpoint URLs contain a prefix which is unique to your company account:


https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payout/v68/payout

Get your {PREFIX} from your live Customer Area under Developers > API URLs > Prefix.

post/confirmThirdParty
Confirm a payout
post/declineThirdParty
Cancel a payout
post/payout
Make an instant card payout
post/storeDetail
Store payout details
post/storeDetailAndSubmitThirdParty
Store details and submit a payout
post/submitThirdParty
Submit a payout