Get all 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.
Query Parameters
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_linksobjectContains links to the next and previous page whenever applicable.
nextobjectContains a link to the next page.
hrefstringThe link to the resource.
prevobjectContains a link to the previous page.
hrefstringThe link to the resource.
dataarray[object]Contains the transfers that match the query parameters.
accountHolderobjectThe account holder associated with the balance account involved in the transfer.
descriptionstringThe description of the resource.
idstringThe unique identifier of the resource.
referencestringThe reference for the resource.
balanceAccountobjectContains information about the balance account involved in the transfer.
descriptionstringThe description of the resource.
idstringThe unique identifier of the resource.
referencestringThe reference for the resource.
balancePlatformstringThe unique identifier of the balance platform.
balancesarray[object]The list of the latest balance statuses in the transfer.
balanceintegerThe amount in the payment's currency that is debited or credited on the balance accounting register.
currencystringThe three-character ISO currency code.
receivedintegerThe amount in the payment's currency that is debited or credited on the received accounting register.
reservedintegerThe amount in the payment's currency that is debited or credited on the reserved accounting register.
categorystringThe category of the transfer.
Possible values:
-
bank: a transfer involving a transfer instrument or a bank account.
-
card: a transfer involving a third-party card.
-
internal: a transfer between balance accounts within your platform.
-
issuedCard: a transfer initiated by an Adyen-issued card.
-
platformPayment: funds movements related to payments that are acquired for your users.
categoryDataThe relevant data according to the transfer category.
counterpartyobjectThe other party in the transfer.
balanceAccountIdstringThe unique identifier of the counterparty balance account.
bankAccountobjectContains information about the counterparty bank account.
accountHolderobjectInformation about the owner of the bank account.
addressobjectThe address of the bank account or card owner.
citystringMin length: 3The name of the city.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
countrystringThe two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1stringFirst line of the street address.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
line2stringSecond line of the street address.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
postalCodestringMin length: 3The postal code. Maximum length:
- 5 digits for an address in the US.
- 10 characters for an address in all other countries.
Supported characters: [a-z] [A-Z] [0-9] and Space.
stateOrProvincestringThe 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.
dateOfBirthstringThe date of birth of the individual in ISO-8601 format. For example, YYYY-MM-DD.
Allowed only when
type
is individual.firstNamestringThe first name of the individual.
Supported characters: [a-z] [A-Z] - . / — and space.
This parameter is:
- Allowed only when
type
is individual. - Required when
category
is card.
fullNamestringThe full name of the entity that owns the bank account or card.
Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \ + & ! ? @ ( ) " ' and space.
Required when
category
is bank.lastNamestringThe last name of the individual.
Supported characters: [a-z] [A-Z] - . / — and space.
This parameter is:
- Allowed only when
type
is individual. - Required when
category
is card.
referencestringMax length: 150A unique reference to identify the party or counterparty involved in the transfer. For example, your client's unique wallet or payee ID.
Required when you include
cardIdentification.storedPaymentMethodId
.typestringThe type of entity that owns the bank account or card.
Possible values: individual, organization, or unknown.
Required when
category
is card. In this case, the value must be individual.accountIdentificationContains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer.
cardobjectContains information about the counterparty card.
cardHolderobjectContains information about the cardholder.
addressobjectThe address of the bank account or card owner.
citystringMin length: 3The name of the city.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
countrystringThe two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1stringFirst line of the street address.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
line2stringSecond line of the street address.
Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
postalCodestringMin length: 3The postal code. Maximum length:
- 5 digits for an address in the US.
- 10 characters for an address in all other countries.
Supported characters: [a-z] [A-Z] [0-9] and Space.
stateOrProvincestringThe 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.
dateOfBirthstringThe date of birth of the individual in ISO-8601 format. For example, YYYY-MM-DD.
Allowed only when
type
is individual.firstNamestringThe first name of the individual.
Supported characters: [a-z] [A-Z] - . / — and space.
This parameter is:
- Allowed only when
type
is individual. - Required when
category
is card.
fullNamestringThe full name of the entity that owns the bank account or card.
Supported characters: [a-z] [A-Z] [0-9] , . ; : - — / \ + & ! ? @ ( ) " ' and space.
Required when
category
is bank.lastNamestringThe last name of the individual.
Supported characters: [a-z] [A-Z] - . / — and space.
This parameter is:
- Allowed only when
type
is individual. - Required when
category
is card.
referencestringMax length: 150A unique reference to identify the party or counterparty involved in the transfer. For example, your client's unique wallet or payee ID.
Required when you include
cardIdentification.storedPaymentMethodId
.typestringThe type of entity that owns the bank account or card.
Possible values: individual, organization, or unknown.
Required when
category
is card. In this case, the value must be individual.cardIdentificationobjectContains the identification details of the card.
expiryMonthstringMin length: 2Max length: 2The expiry month of the card.
Format: two digits. Add a leading zero for single-digit months. For example:
- 03 = March
- 11 = November
expiryYearstringMin length: 4Max length: 4The expiry year of the card.
Format: four digits. For example: 2020
issueNumberstringMin length: 1Max length: 2The issue number of the card. Applies only to some UK debit cards.
numberstringMin length: 4Max length: 19The card number without any separators.
For security, the response only includes the last four digits of the card number.
startMonthstringMin length: 2Max length: 2The month when the card was issued. Applies only to some UK debit cards.
Format: two digits. Add a leading zero for single-digit months. For example:
- 03 = March
- 11 = November
startYearstringMin length: 4Max length: 4The year when the card was issued. Applies only to some UK debit cards.
Format: four digits. For example: 2020
storedPaymentMethodIdstringThe unique token created to identify the counterparty.
merchantobjectContains information about the merchant.
acquirerIdstringThe unique identifier of the merchant's acquirer.
citystringThe city where the merchant is located.
countrystringThe country where the merchant is located.
mccstringThe merchant category code.
merchantIdstringThe merchant identifier.
namestringThe name of the merchant's shop or service.
postalCodestringThe merchant postal code.
transferInstrumentIdstringThe unique identifier of the counterparty transfer instrument.
creationDatestringThe date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
descriptionstringYour 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] & $ % # @ ~ = + - _ ' " ! ?
directDebitInformationobjectThe details of the direct debit.
dateOfSignaturestringThe date when the direct debit mandate was accepted by your user, in ISO-8601 format.
dueDatestringThe date when the funds are deducted from your user's balance account.
mandateIdstringYour unique identifier for the direct debit mandate.
sequenceTypestringIdentifies the direct debit transfer's type. Possible values: OneOff, First, Recurring, Final.
directionstringThe direction of the transfer.
Possible values: incoming, outgoing.
eventsarray[object]The list of events leading up to the current status of the transfer.
amountAdjustmentsarray[object]The amount adjustments in this transfer.
amountAdjustmentTypestringThe type of markup that is applied to an authorised payment.
Possible values: exchange, forexMarkup, authHoldReserve, atmMarkup.
basepointsintegerThe basepoints associated with the applied markup.
arnstringScheme unique arn identifier useful for tracing captures, chargebacks, refunds, etc.
bookingDatestringThe date when the transfer request was sent.
estimatedArrivalTimestringThe estimated time when the beneficiary should have access to the funds.
externalReasonobjectThe external reason for the transfer status.
codestringThe reason code.
descriptionstringThe description of the reason code.
namespacestringThe namespace for the reason code.
idstringThe unique identifier of the transfer event.
modificationobjectPayment modification.
directionstringThe direction of the money movement.
idstringOur reference for the modification.
referencestringYour reference for the modification, used internally within your platform.
statusstringThe status of the transfer event.
typestringThe type of transfer modification.
mutationsarray[object]The list of balance mutations per event.
balanceintegerThe amount in the payment's currency that is debited or credited on the balance accounting register.
currencystringThe three-character ISO currency code.
receivedintegerThe amount in the payment's currency that is debited or credited on the received accounting register.
reservedintegerThe amount in the payment's currency that is debited or credited on the reserved accounting register.
originalAmountobjectThe amount in the original currency.
valueintegerThe amount of the transaction, in minor units.
reasonstringThe reason for the transfer status.
statusstringThe status of the transfer event.
trackingDataAdditional information for the tracking event.
transactionIdstringThe id of the transaction that is related to this accounting event. Only sent for events of type accounting where the balance changes.
typestringThe type of the transfer event. Possible values: accounting, tracking.
updateDatestringThe date when the tracking status was updated.
valueDatestringA future date, when the funds are expected to be deducted from or credited to the balance account.
idstringThe ID of the resource.
paymentInstrumentobjectContains information about the payment instrument used in the transfer.
descriptionstringThe description of the resource.
idstringThe unique identifier of the resource.
referencestringThe reference for the resource.
tokenTypestringThe type of wallet that the network token is associated with.
reasonstringAdditional information about the status of the transfer.
referencestringMax length: 80Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
referenceForBeneficiarystringA 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.
reviewobjectContains status updates related to additional reviews.
numberOfApprovalsCompletedintegerShows the number of approvals completed for the transfer.
numberOfApprovalsRequiredintegerShows the number of approvals required to process the transfer.
scaOnApprovalstringShows the status of the Strong Customer Authentication (SCA) process.
Possible values: required, completed, notApplicable.
sequenceNumberintegerThe sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer.
The sequence number can help you restore the correct sequence of events even if they arrive out of order.
statusstringThe result of the transfer.
For example, authorised, refused, or error.
trackingThe latest tracking information of the transfer.
transactionRulesResultobjectContains the results of the evaluation of the transaction rules.
advicestringThe advice given by the Risk analysis.
allHardBlockRulesPassedbooleanIndicates whether the transaction passed the evaluation for all hardblock rules
scoreintegerThe score of the Risk analysis.
triggeredTransactionRulesarray[object]Array containing all the transaction rules that the transaction triggered.
reasonstringAn explanation about why the transaction rule failed.
transactionRuleobjectContains information about the transaction rule.
descriptionstringThe description of the resource.
idstringThe unique identifier of the resource.
outcomeTypestringThe outcome type of the rule.
referencestringThe reference for the resource.
scoreintegerThe score of the rule in case it's a scoreBased rule.
transactionRuleSourceobjectContains the type and ID of the resource to which the transaction rule is linked.
idstringID of the resource, when applicable.
typestringIndicates 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.
typestringThe type of transfer or transaction. For example, refund, payment, internalTransfer, bankTransfer.
-
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
routingDetailsarray[object]Detailed explanation of each attempt to route the transfer with the priorities from the request.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
prioritystringThe priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with
category
bank.Possible values:
-
regular: for normal, low-value transactions.
-
fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.
-
wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.
-
instant: for instant funds transfers in SEPA countries.
-
crossBorder: for high-value transfers to a recipient in a different country.
-
internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
titlestringA short, human-readable summary of the problem type.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
-
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
routingDetailsarray[object]Detailed explanation of each attempt to route the transfer with the priorities from the request.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
prioritystringThe priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with
category
bank.Possible values:
-
regular: for normal, low-value transactions.
-
fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.
-
wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.
-
instant: for instant funds transfers in SEPA countries.
-
crossBorder: for high-value transfers to a recipient in a different country.
-
internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
titlestringA short, human-readable summary of the problem type.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
-
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
routingDetailsarray[object]Detailed explanation of each attempt to route the transfer with the priorities from the request.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
prioritystringThe priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with
category
bank.Possible values:
-
regular: for normal, low-value transactions.
-
fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.
-
wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.
-
instant: for instant funds transfers in SEPA countries.
-
crossBorder: for high-value transfers to a recipient in a different country.
-
internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
titlestringA short, human-readable summary of the problem type.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA 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 moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
routingDetailsarray[object]Detailed explanation of each attempt to route the transfer with the priorities from the request.
detailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
prioritystringThe priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with
category
bank.Possible values:
-
regular: for normal, low-value transactions.
-
fast: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.
-
wire: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.
-
instant: for instant funds transfers in SEPA countries.
-
crossBorder: for high-value transfers to a recipient in a different country.
-
internal: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
titlestringA short, human-readable summary of the problem type.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
-