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

Query Parameters

Required

Optional

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

The cursor returned in the links of the previous response.

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.

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.

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.

The reference you provided in the POST /transfers request

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.

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.

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.

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
_linksobject
Contains links to the next and previous page whenever applicable.
Show children Hide children
nextobject
Contains a link to the next page.
Show children Hide children
hrefstring
The link to the resource.
prevobject
Contains a link to the previous page.
Show children Hide children
hrefstring
The link to the resource.
dataarray[object]
Contains the transfers that match the query parameters.
Show children Hide children
accountHolderobject
The account holder associated with the balance account used in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
amountobject
The amount of the transfer.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
balanceAccountobject
Contains information about the balance account involved in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
balancePlatformstring
The unique identifier of the balance platform.
balancesarray[object]
The list of the latest balance statuses in the transfer.
Show children Hide children
balanceinteger
The amount in the payment's currency that is debited or credited on the balance accounting register.
currencystring
The three-character ISO currency code.
receivedinteger
The amount in the payment's currency that is debited or credited on the received accounting register.
reservedinteger
The amount in the payment's currency that is debited or credited on the reserved accounting register.
categorystring
The category 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.

categoryData
The relevant data according to the transfer category.
counterpartyobject
The other party in the transfer.
Show children Hide children
balanceAccountIdstring
Unique identifier of the balance account.
bankAccountobject
Contains information about the bank account.
Show children Hide children
accountHolderobject
Information about the owner of the bank account.
Show children Hide children
addressobject
Address of the bank account owner.
Show children Hide children
citystring
The name of the city.
countrystring
The two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1string
First line of the street address.
line2string
Second line of the street address.
postalCodestring
The postal code. Maximum length:

5 digits for an address in the US.

10 characters for an address in all other countries.

stateOrProvincestring
The two-letter ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

dateOfBirthstring
The date of birth of the individual in ISO-8601 format. For example, YYYY-MM-DD. Should not be before January 1, 1900.

Allowed only when type is individual.
firstNamestring
First name of the individual.

Allowed only when type is individual.
fullNamestring
The name of the entity.
lastNamestring
Last name of the individual.

Allowed only when type is individual.
referencestring
Max length: 150
A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID.
typestring
The type of entity that owns the bank account.

Possible values: individual, organization, or unknown.
accountIdentification
Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer.
merchantobject
Contains information about the merchant.
Show children Hide children
acquirerIdstring
The unique identifier of the merchant's acquirer.
citystring
The city where the merchant is located.
countrystring
The country where the merchant is located.
mccstring
The merchant category code.
merchantIdstring
The merchant identifier.
namestring
The name of the merchant's shop or service.
postalCodestring
The merchant postal code.
transferInstrumentIdstring
Unique identifier of the transfer instrument.
creationDatestring
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
descriptionstring
Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.

Supported characters: [a-z] [A-Z] [0-9] / - ? : ( ) . , ' + Space

Supported characters for regular and fast transfers to a US counterparty: [a-z] [A-Z] [0-9] & $ % # @ ~ = + - _ ' " ! ?
directionstring
The direction of the transfer.

Possible values: incoming, outgoing.
eventsarray[object]
The list of events leading up to the current status of the transfer.
Show children Hide children
amountobject
The original journal amount.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
amountAdjustmentsarray[object]
The amount adjustments in this transfer.
Show children Hide children
amountobject
The adjustment amount.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
amountAdjustmentTypestring
The type of markup that is applied to an authorised payment.

Possible values: exchange, forexMarkup, authHoldReserve, atmMarkup.
basepointsinteger
The basepoints associated with the applied markup.
bookingDatestring
The date when the transfer request was sent.
estimatedArrivalTimestring
The estimated time the beneficiary should have access to the funds.
idstring
The unique identifier of the transfer event.
modificationobject
Payment modification.
Show children Hide children
directionstring
The direction of the money movement.
idstring
Our reference for the modification.
referencestring
Your reference for the modification, used internally within your platform.
statusstring
The status of the transfer event.
typestring
The type of transfer modification.
mutationsarray[object]
The list of the balance mutation per event.
Show children Hide children
balanceinteger
The amount in the payment's currency that is debited or credited on the balance accounting register.
currencystring
The three-character ISO currency code.
receivedinteger
The amount in the payment's currency that is debited or credited on the received accounting register.
reservedinteger
The amount in the payment's currency that is debited or credited on the reserved accounting register.
originalAmountobject
The amount in the original currency.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
reasonstring
The reason for the transfer status.
statusstring
The status of the transfer event.
transactionIdstring
The id of the transaction that is related to this accounting event. Only sent for events of type accounting where the balance changes.
typestring
The type of the transfer event. Possible values: accounting, tracking.
updateDatestring
The date when the tracking status was updated.
valueDatestring
A future date, when the funds are expected to be deducted from or credited to the balance account.
idstring
The ID of the resource.
paymentInstrumentobject
Contains information about the payment instrument used in the transfer.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
tokenTypestring
The type of wallet the network token is associated with.
reasonstring
Additional information about the status of the transfer.
referencestring
Max length: 80
Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
referenceForBeneficiarystring
Max length: 80
A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.

Supported characters: a-z, A-Z, 0-9. The maximum length depends on the category.

internal: 80 characters

bank: 35 characters when transferring to an IBAN, 15 characters for others.

sequenceNumberinteger
The sequence number of the transfer notification. The numbers start from 1 and increase with each new notification for a specific transfer.

It can help you restore the correct sequence of events even if they arrive out of order.
statusstring
The result of the transfer.

For example, authorised, refused, or error.
trackingobject
The tracking information for the transfer.
Show children Hide children
estimatedArrivalTimestring
The estimated time the beneficiary should have access to the funds.
statusstring
The tracking status of the transfer.
transactionRulesResultobject
Contains the results of the evaluation of the transaction rules.
Show children Hide children
advicestring
The advice given by the Risk analysis.
allHardBlockRulesPassedboolean
Indicates whether the transaction passed the evaluation for all hardblock rules
scoreinteger
The score of the Risk analysis.
triggeredTransactionRulesarray[object]
Array containing all the transaction rules that the transaction triggered.
Show children Hide children
reasonstring
An explanation about why the transaction rule failed.
transactionRuleobject
Contains information about the transaction rule.
Show children Hide children
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
outcomeTypestring
The outcome type of the rule.
referencestring
The reference for the resource.
scoreinteger
The score of the rule in case it's a scoreBased rule.
transactionRuleSourceobject
Contains the type and ID of the resource to which the transaction rule is linked.
Show children Hide children
idstring
ID of the resource, when applicable.
typestring
Indicates the type of resource for which the transaction rule is defined.

Possible values:

PaymentInstrumentGroup

PaymentInstrument

BalancePlatform

EntityUsageConfiguration

PlatformRule: The transaction rule is a platform-wide rule imposed by Adyen.

typestring
The type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.
401 - Unauthorized
Authentication required.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show more Show less
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
Show children Hide children
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get all transfers

Query Parameters

Response parameters

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error