Create a transfer instrument

post /transferInstruments

Creates a transfer instrument.

A transfer instrument is a bank account or other payment details 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).

Endpoint destination URL

https://kyc-test.adyen.com/lem/v2/transferInstruments
Click to copy

Request parameters

bankAccount

Contains information about the legal entity's bank account. Required when type is bankAccount.

legalEntityId string Required

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

recurringDetail

Contains information about the legal entity's previously stored payment details. Required when type is recurringDetail.

type string Required

The type of transfer instrument.

Possible values: bankAccount, recurringDetail.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy