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.

Servers

https://balanceplatform-api-test.adyen.com/btl/v4

Query parameters

Name	Type	Required	Description
`createdSince`	String	Yes	Only include transfers that have been created on or after this point in time. The value must be in ISO 8601 format and not earlier than 6 months before the `createdUntil` date. For example, 2021-05-30T15:07:40Z.
`category`	String	No	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. Possible values: `"topUp"` `"bank"` `"card"` `"grants"` `"migration"` `"platformPayment"` `"issuedCard"` `"internal"` `"upgrade"`
`limit`	Integer	No	The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.
`balancePlatform`	String	No	The unique identifier of the balance platform. Required if you don't provide a `balanceAccountId` or `accountHolderId`.
`reference`	String	No	The reference you provided in the POST /transfers request
`accountHolderId`	String	No	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`.
`balanceAccountId`	String	No	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`.
`createdUntil`	String	Yes	Only include transfers that have been created on or before this point in time. The value must be in ISO 8601 format and not later than 6 months after the `createdSince` date. For example, 2021-05-30T15:07:40Z.
`cursor`	String	No	The `cursor` returned in the links of the previous response.
`paymentInstrumentId`	String	No	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.

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.