v1

latestOpenAPI 3.1.02026-07-202961265.4 KB
Transfer instruments

Create a transfer instrument

Creates a transfer instrument.

A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses.

When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

post/transferInstruments

Headers

x-requested-verification-codestring

Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.

Request body

legalEntityIdstring required

The unique identifier of the legal entity that owns the transfer instrument.

type'bankAccount' | 'recurringDetail' required

The type of transfer instrument.

Possible value: bankAccount.

Response

OK - the request has succeeded.

idstring required

The unique identifier of the transfer instrument.

legalEntityIdstring required

The unique identifier of the legal entity that owns the transfer instrument.

type'bankAccount' | 'recurringDetail' required

The type of transfer instrument.

Possible value: bankAccount.