Number of APIs: 6
A set of API endpoints that allow you to store payout details, confirm, or decline a payout. For more information, refer to Online payouts. 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 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: Payments API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: For example:
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 Authentication
X-API-Key
header with the API key as the value, for example:curl
-H "Content-Type: application/json" \n-H "X-API-Key: YOUR_API_KEY" \n...
curl
-U "storePayout@Company.YOUR_COMPANY_ACCOUNT":"YOUR_BASIC_AUTHENTICATION_PASSWORD" \n-H "Content-Type: application/json" \n...
Versioning
vXX
, where XX is the version number.
https://pal-test.adyen.com/pal/servlet/Payout/v68/payout
Going live
{PREFIX}
from your live Customer Area under Developers > API URLs > Prefix.
POST {{baseUrl}}/storeDetail
POST {{baseUrl}}/storeDetailAndSubmitThirdParty
POST {{baseUrl}}/payout
POST {{baseUrl}}/confirmThirdParty
POST {{baseUrl}}/declineThirdParty
POST {{baseUrl}}/submitThirdParty
ENDPOINTS