Get all transfers

get/transfers

Returns 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 following:

  • balanceAccountId
  • accountHolderId
  • balancePlatform.

This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results.

Endpoint destination URL
https://balanceplatform-api-test.adyen.com/btl/v4/transfers
Click to copy

Query Parameters

limitinteger

The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.

cursorstring

The cursor returned in the links of the previous response.

createdUntilstringRequired

Only include transfers that have been created on or before this point in time. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.

createdSincestringRequired

Only include transfers that have been created on or after this point in time. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.

categorystring

The type of transfer.

Possible values:

  • bank: Transfer to a transfer instrument or a bank account.

  • internal: Transfer to another balance account within your platform.

  • issuedCard: Transfer initiated by a Adyen-issued card.

  • platformPayment: Fund movements related to payments that are acquired for your users.

referencestring

The reference you provided in the POST /transfers request

paymentInstrumentIdstring

The unique identifier of the payment instrument.

To use this parameter, you must also provide a balanceAccountId, accountHolderId, or balancePlatform.

The paymentInstrumentId must be related to the balanceAccountId or accountHolderId that you provide.

balanceAccountIdstring

The unique identifier of the balance account.

Required if you don't provide an accountHolderId or balancePlatform.

If you provide an accountHolderId, the balanceAccountId must be related to the accountHolderId.

accountHolderIdstring

The unique identifier of the account holder.

Required if you don't provide a balanceAccountId or balancePlatform.

If you provide a balanceAccountId, the accountHolderId must be related to the balanceAccountId.

balancePlatformstring

The unique identifier of the balance platform.

Required if you don't provide a balanceAccountId or accountHolderId.

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 moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less