Adyen

Adyen Payout API

> The Payout API is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the [Transfers…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

> The Payout API is deprecated and no longer supports new integrations. Do one of the following:
>- If you are building a new integration, use the Transfers API instead.
> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.
>
> With the Transfers API, you can:
> - Handle multiple payout use cases with a single API.
> - Use new payout functionalities, such as instant payouts to bank accounts.
> - Receive webhooks with more details and defined transfer states.
>
> For more information about the payout features of the Transfers API, see our Payouts documentation.

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

Payout 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.

Endpoints 6

Initialization

  • POSTStore payout details/storeDetail> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the Transfers…
  • POSTStore details and submit a payout/storeDetailAndSubmitThirdParty> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the POST…
  • POSTSubmit a payout/submitThirdParty> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the POST…

Reviewing

  • POSTConfirm a payout/confirmThirdParty> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the Transfers…
  • POSTCancel a payout/declineThirdParty> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the Transfers…

Instant payouts

  • POSTMake an instant card payout/payout> This endpoint is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the POST…

API details

Base URL
https://pal-test.adyen.com/pal/servlet/Payout/v68
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
6 operations on 6 pathsPOST 6
Main resources
Initialization 3Reviewing 2Instant payouts 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 68

How to test the Adyen Payout API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Adyen Payout API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Store payout details” (POST /storeDetail), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Adyen Payout API?

> The Payout API is deprecated and no longer supports new integrations. Do one of the following: >- If you are building a new integration, use the [Transfers… It is listed under Payments and has 6 endpoints.

Who publishes the Adyen Payout API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Adyen Payout API?

Requests go to https://pal-test.adyen.com/pal/servlet/Payout/v68. Endpoint paths are added to this base URL.

How do I authenticate with the Adyen Payout API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Adyen Payout API have?

6 operations on 6 paths (6 POST). The largest groups are Initialization, Reviewing, Instant payouts.

Is forking the Adyen Payout API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.