Get a transfer

get/transfers/{id}

Returns the details of a specified transfer.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/btl/v4/transfers/{id}

Path Parameters

Required

Optional

Unique identifier of the transfer.

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
accountHolderobject
The account holder associated with 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.
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 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 a Adyen-issued card.

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

topUp: an incoming transfer initiated by your user to top up their balance account.

categoryData
The relevant data according to the transfer category.
counterpartyobject
The other party in the transfer.
Show children Hide children
balanceAccountIdstring
The unique identifier of the counterparty balance account.
bankAccountobject
Contains information about the counterparty bank account.
Show children Hide children
accountHolderobject
Information about the owner of the bank account.
Show children Hide children
addressobject
The address of the bank account or card owner.
Show children Hide children
citystring
Min length: 3
The name of the city.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
countrystring
The two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1string
First line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
line2string
Second line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
postalCodestring
Min length: 3
The 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.

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.

Allowed only when type is individual.
firstNamestring
The 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.

fullNamestring
The 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.
lastNamestring
The 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.

referencestring
Max length: 150
A 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.
typestring
The 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.
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.
cardobject
Contains information about the counterparty card.
Show children Hide children
cardHolderobject
Contains information about the cardholder.
Show children Hide children
addressobject
The address of the bank account or card owner.
Show children Hide children
citystring
Min length: 3
The name of the city.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
countrystring
The two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1string
First line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
line2string
Second line of the street address.

Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \ | and Space.
postalCodestring
Min length: 3
The 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.

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.

Allowed only when type is individual.
firstNamestring
The 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.

fullNamestring
The 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.
lastNamestring
The 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.

referencestring
Max length: 150
A 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.
typestring
The 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.
cardIdentificationobject
Contains the identification details of the card.
Show children Hide children
expiryMonthstring
Min length: 2Max length: 2
The expiry month of the card.

Format: two digits. Add a leading zero for single-digit months. For example:

03 = March

11 = November

expiryYearstring
Min length: 4Max length: 4
The expiry year of the card.

Format: four digits. For example: 2020
issueNumberstring
Min length: 1Max length: 2
The issue number of the card. Applies only to some UK debit cards.
numberstring
Min length: 4Max length: 19
The card number without any separators.

For security, the response only includes the last four digits of the card number.
startMonthstring
Min length: 2Max length: 2
The 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

startYearstring
Min length: 4Max length: 4
The year when the card was issued. Applies only to some UK debit cards.

Format: four digits. For example: 2020
storedPaymentMethodIdstring
The unique token created to identify the counterparty.

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
The unique identifier of the counterparty 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] & $ % # @ ~ = + - _ ' " ! ?
directDebitInformationobject
The details of the direct debit.
Show children Hide children
dateOfSignaturestring
The date when the direct debit mandate was accepted by your user, in ISO-8601 format.
dueDatestring
The date when the funds are deducted from your user's balance account.
mandateIdstring
Your unique identifier for the direct debit mandate.
sequenceTypestring
Identifies the direct debit transfer's type. Possible values: OneOff, First, Recurring, Final.
directionstring
The direction of the transfer.

Possible values: incoming, outgoing.
eventIdstring
The event id listed under events, that triggered the notification.
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.
arnstring
Scheme unique arn identifier useful for tracing captures, chargebacks, refunds, etc.
bookingDatestring
The date when the transfer request was sent.
estimatedArrivalTimestring
The estimated time when the beneficiary should have access to the funds.
eventsDataarray
A list of event data.
externalReasonobject
The external reason for the transfer status.
Show children Hide children
codestring
The reason code.
descriptionstring
The description of the reason code.
namespacestring
The namespace for the reason code.
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 balance mutations 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.
trackingData
Additional information for the tracking 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
The date when the funds are expected to be deducted from or credited to the balance account. This date can be in either the past or future.
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 that 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
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.

reviewobject
Contains status updates related to additional reviews.
Show children Hide children
numberOfApprovalsCompletedinteger
Shows the number of approvals completed for the transfer.
numberOfApprovalsRequiredinteger
Shows the number of approvals required to process the transfer.
scaOnApprovalstring
Shows the status of the Strong Customer Authentication (SCA) process.

Possible values: required, completed, notApplicable.
sequenceNumberinteger
The 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.
statusstring
The result of the transfer.

For example, authorised, refused, or error.
tracking
The latest tracking information 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 moreShow 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.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The 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).

titlestring
A short, human-readable summary of the problem type.
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 moreShow 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.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The 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).

titlestring
A short, human-readable summary of the problem type.
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 moreShow 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.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The 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).

titlestring
A short, human-readable summary of the problem type.
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 moreShow 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.
routingDetailsarray[object]
Detailed explanation of each attempt to route the transfer with the priorities from the request.
Show children Hide children
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
prioritystring
The 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).

titlestring
A short, human-readable summary of the problem type.
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 a transfer

Path Parameters

Response parameters

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error