Get a transfer
Returns a transfer.
Path Parameters
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 lessaccountHolderobjectThe account holder associated with the balance account used 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 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.
categoryDataThe relevant data according to the transfer category.
counterpartyobjectThe other party in the transfer.
balanceAccountIdstringUnique identifier of the balance account.
bankAccountobjectContains information about the bank account.
accountHolderobjectInformation about the owner of the bank account.
addressobjectAddress of the bank account owner.
citystringThe name of the city.
countrystringThe two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.
line1stringFirst line of the street address.
line2stringSecond line of the street address.
postalCodestringThe postal code. Maximum length:
- 5 digits for an address in the US.
- 10 characters for an address in all other countries.
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. Should not be before January 1, 1900.
Allowed only when
type
is individual.firstNamestringFirst name of the individual.
Allowed only when
type
is individual.fullNamestringThe name of the entity.
lastNamestringLast name of the individual.
Allowed only when
type
is individual.referencestringMax length: 150A 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.
typestringThe type of entity that owns the bank account.
Possible values: individual, organization, or unknown.
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.
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.
transferInstrumentIdstringUnique identifier of the 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] & $ % # @ ~ = + - _ ' " ! ?
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.
bookingDatestringThe date when the transfer request was sent.
estimatedArrivalTimestringThe estimated time the beneficiary should have access to the funds.
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 the balance mutation 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.
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 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.
referenceForBeneficiarystringMax length: 80A 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.
sequenceNumberintegerThe 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.
statusstringThe result of the transfer.
For example, authorised, refused, or error.
trackingobjectThe tracking information for the transfer.
estimatedArrivalTimestringThe estimated time the beneficiary should have access to the funds.
statusstringThe tracking status 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.
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.
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.
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.
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.