Manage transfer instruments

A transfer instrument is an API resource that represents an external bank account. You can use transfer instruments to send funds to and receive funds from bank accounts outside of your platform. These transfers can be made on-demand or generated by automated sweeps.

There are two main types of transfer instruments:

• Your users' bank accounts: These are the bank accounts of the account holders on your platform.
• Your payout accounts: These are your own company's bank accounts that you add to your platform. Adyen uses these accounts to settle funds to you. In an Adyen for Platforms integration, these are the transfer instruments that are connected to your liable account.

This page explains how to create, view, update, and delete transfer instruments for your users using the API, and how to manage your platform's payout accounts in the Customer Area.

Requirements

Manage transfer instruments with the API

Use the Legal Entity Management API to manage the transfer instruments that belong to you users or your platform. With the API you can:

• Create a transfer instrument
• View transfer instruments
• Update a transfer instrument
• Delete a transfer instrument

Create a transfer instrument

To create a transfer instrument:

1. Make a POST /transferInstruments request specifying the following:

   Parameter	Required	Description
   type		Set to bankAccount.
   legalEntityId		Unique identifier of the legal entity that has the contractual relationship with your platform and owns the bank account. For sole proprietorships, this is the legal entity ID of the individual owner.
   bankAccount		Object that contains required information about the legal entity's bank account. The required parameters of this object depend on the location of your bank. Refer to bankAccount/accountIdentification in the API Explorer to confirm which parameters are valid for each location.

   Here is an example request to add a transfer instrument for a bank account in the US:

2. Read the response. It contains the transfer instrument resource, identified by its unique id.

3. Look for problems in the response. The problems array contains information about which bank account verifications had issues. See Remediating actions for a list of possible remediating action codes and what they mean.

The result is a new transfer instrument with a unique ID. Use this ID to create a sweep, or as a target for a manual transfer.

View transfer instruments

To view transfer instrument details:

1. Make a GET /transferInstruments/{id} specifying unique transferInstrumentId of the transfer instrument you want to view.

   Path parameter	Required	Description
   /transferInstruments/{id}		The unique identifier of the transfer instrument to retrieve.

2. Read the response. A successful response, indicated by a 200 HTTP reponse code, contains the transfer instrument object with information about the bank account, such as the account number, account holder name, and verification status.

Update a transfer instrument

To update a transfer instrument:

1. Make a PATCH /transferInstruments/{id} specifying the unique transferInstrumentId of the account you want to update. Only provide values for the fields you want to modify. If you are updating the bankAccount object, check bankAccount/accountIdentification in the API Explorer to confirm which parameters are valid for each location.

   Parameter	Required	Description
   /transferInstruments/{id}		The unique identifier of the transfer instrument to update.

   The following example shows how to update the bank account with a new IBAN.

2. Read the response. A successful response, indicated by a 200 http response code, contains the complete, updated transfer instrument object.

3. Look for problems in the response. The problems array contains information about which bank account verifications had issues. See Remediating actions for a list of possible remediating action codes and what they mean.

The result is an updated bank account that has the same transfer instrument ID. This means that sweeps and transfer requests that target the existing ID still work as expected.

Delete a transfer instrument

To delete a transfer instrument, make a DELETE request to the /transferInstruments/{id} endpoint.

Parameter	Required	Description
id		The unique identifier of the transfer instrument to be deleted.

Here is an example request to delete a transfer instrument:

You cannot undo a delete request. If you need the same account added back, create a new transfer instrument. Any future manual transfers or automated sweeps that use the deleted ID will fail.

Payout accounts

Your platform's payout accounts are transfer instruments that are connected to your liable account. Adyen uses these payout accounts to settle funds to your company's bank accounts. This account is typically set up for you when you get started with Adyen.

You can create multiple payout accounts for your platform. When you need to make changes to your payout accounts, you can use the Customer Area or use the API. The Customer Area is only available to manage your platform's payout accounts, not your users' transfer instruments.

Add a payout account in the Customer Area

You can create payout accounts for your company in the Customer Area. Use this to create your first payout account, or add payout accounts in additional currencies.

To add a payout account:

1. Log in to your Customer Area.
2. Navigate to Finance > Payout accounts
3. Select Add payout account.
4. Select your prefered verification method to either log in to your bank, or enter it manually alongside a bank statement

Adyen makes the payout account available as soon as it passes verification. If you logged in with your bank, verification happens instantly. You can use the payout account when its status is valid.

Edit or remove a payout account in the Customer Area

To manage your payout accounts:

1. Log in to your Customer Area.
2. Navigate to Finance > Payout accounts
3. Find the payout account you want to change and select the Remove or Edit from the options dropdown.

Edits to transfer instruments take effect instantly. When you delete a transfer instrument, it stops recieving payouts. If you need restore the same account, create a new transfer instrument. Manual transfers or automated sweeps that use the deleted ID will begin to fail.

See also

• Manage legal entities
• Manage balance accounts
• Pay out to your users
• Top up balance accounts