POST /transferInstruments
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).
Servers
- https://kyc-test.adyen.com/lem/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-requested-verification-code |
String | No |
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 fields
| Name | Type | Required | Description |
|---|---|---|---|
bankAccount |
Object | Yes |
Contains information about the legal entity's bank account. |
bankAccount.bankName |
String | No |
The name of the banking institution where the bank account is held. |
bankAccount.accountType |
String | No |
The type of bank account. |
bankAccount.trustedSource |
Boolean | No |
Identifies if the bank account was created through instant bank verification. |
bankAccount.countryCode |
String | No |
The two-character ISO 3166-1 alpha-2 country code where the bank account is registered. For example, NL. |
bankAccount.accountIdentification |
Object | No |
Identification of the bank account. |
type |
String | Yes |
The type of transfer instrument. Possible value: bankAccount. Possible values:
|
legalEntityId |
String | Yes |
The unique identifier of the legal entity that owns the transfer instrument. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.