Adyen

Transfers API

>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. The Transfers API provides…

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

>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.

The Transfers API provides endpoints that you can use to transfer funds, whether when paying out to a transfer instrument for marketplaces or platforms, sending funds to third parties for users with business bank accounts, or to request a payout for a grant offer. The API also supports use cases for getting transactions for business bank accounts and getting outstanding balances for one or more grants on your platform.

Authentication

Each request to the Transfers API must be signed with an API key. Generate an API key in your Customer Area if you have a platform setup or marketplace setup.

If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.

To connect to the API, 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" \
...

Roles and permissions

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

Versioning

The Transfers 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://balanceplatform-api-test.adyen.com/btl/v4/transfers

Going live

When going live, generate an API key in your live Customer Area if you have an Adyen for Platforms integration or live Balance Platform Customer Area if you have an Adyen Issuing integration. You can then use the API key to send requests to https://balanceplatform-api-live.adyen.com/btl/v4.

Endpoints 12

Transfers

  • GETGet all transfers/transfers?balancePlatform=string&accountHolderId=string&balanceAccountId=string&paymentInstrumentId=string&reference=string&category=bank&createdSince=2024-01-01T00:00:00Z&createdUntil=2024-01-01T00:00:00Z&sortOrder=asc&cursor=string&limit=0Returns all the transfers related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the…
  • POSTTransfer funds/transfers>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer…
  • POSTApprove initiated transfers/transfers/approveInitiates the approval of a list of transfers that triggered an additional review. Adyen sends the outcome of the approval request through webhooks. To use…
  • POSTCancel initiated transfers/transfers/cancelInitiates the cancellation of a list of transfers that triggered an additional review. Adyen sends the outcome of the cancel request through webhooks. To use…
  • GETGet a transfer/transfers/:idReturns the details of a specified transfer.
  • POSTReturn a transfer/transfers/:transferId/returnsInitiates the return of previously transferred funds without creating a new transferId.

Transactions

  • GETGet all transactions/transactions?balancePlatform=string&paymentInstrumentId=string&accountHolderId=string&balanceAccountId=string&cursor=string&createdSince=2024-01-01T00:00:00Z&createdUntil=2024-01-01T00:00:00Z&sortOrder=asc&limit=0>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions…
  • GETGet a transaction/transactions/:id>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.

Capital

  • GETGet a capital account/grants?counterpartyAccountHolderId=stringDeprecated. Returns a list of grants with status and outstanding balances.
  • POSTRequest a grant payout/grantsDeprecated. Requests the payout of the selected grant offer.
  • GETGet grant reference details/grants/:idDeprecated. Returns the details of a capital account specified in the path.

CashOut

  • POSTInitiate a cashout/cashoutsInitiates a cashout request.

API details

Base URL
https://balanceplatform-api-test.adyen.com/btl/v4
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
An API key in the clientKey query parameter
Operations
12 operations on 10 pathsGET 6POST 6
3 marked deprecated
Main resources
Transfers 6Capital 3Transactions 2CashOut 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 4

How to test the Transfers 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 Transfers 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 “Get all transfers” (GET /transfers?balancePlatform=string&accountHolderId=string&balanceAccountId=string&paymentInstrumentId=string&reference=string&category=bank&createdSince=2024-01-01T00:00:00Z&createdUntil=2024-01-01T00:00:00Z&sortOrder=asc&cursor=string&limit=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Transfers API?

>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. The Transfers API provides… It is listed under Payments and has 12 endpoints.

Who publishes the Transfers 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 Transfers API?

Requests go to https://balanceplatform-api-test.adyen.com/btl/v4. Endpoint paths are added to this base URL.

How do I authenticate with the Transfers API?

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

How many endpoints does the Transfers API have?

12 operations on 10 paths (6 GET, 6 POST). The largest groups are Transfers, Capital, Transactions, CashOut.

Is forking the Transfers 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.