Adyen Payout API

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.

Both of these API credentials must be authenticated with basic authentication.The following example shows how to authenticate your request 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.

Use this page to mock Adyen Payout API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Adyen Payout API, which will allow you to keep building and testing even if the actual API you isn't currently available.