Get a transaction

get/transactions/{id}

API Version

Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.

Returns a transaction.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/btl/v2/transactions/{id}

Path Parameters

Required

Optional

The unique identifier of the transaction.

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.
accountHolderIdstring
Unique identifier of the account holder.
amountobject
Contains information about the amount of the transaction.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
balanceAccountIdstring
Unique identifier of the balance account.
balancePlatformstring
The unique identifier of the balance platform.
bookingDatestring
The date the transaction was booked into the balance account.
categorystring
The category of the transaction indicating the type of activity.

Possible values:

platformPayment: The transaction is a payment or payment modification made with an Adyen merchant account.

internal: The transaction resulted from an internal adjustment such as a deposit correction or invoice deduction.

bank: The transaction is a bank-related activity, such as sending a payout or receiving funds.

issuedCard: The transaction is a card-related activity, such as using an Adyen-issued card to pay online.

counterpartyobject
Contains information about the other party in the transaction.
balanceAccountIdstring
The unique identifier of the balance account.
bankAccountobject
Contains information about the bank account.
addressobject
The address of the bank account owner.
citystring
Max length: 3000
The name of the city. Maximum length: 3000 characters.
countrystring
The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

houseNumberOrNamestring
Max length: 3000
The number or name of the house. Maximum length: 3000 characters.
postalCodestring
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
stateOrProvincestring
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

streetstring
Max length: 3000
The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

ibanstring
The international bank account number as defined in the ISO-13616 standard.
ownerNameobject
The name of the bank account owner.
firstNamestring
The first name.
fullNamestring
The full name.
infixstring
The infix in the name, if any.
lastNamestring
The last name.
merchantobject
Contains information about the merchant.
acquirerIdstring
The unique identifier of the merchant's acquirer.
mccstring
The merchant category code.
merchantIdstring
The unique identifier of the merchant.
nameLocationobject
Contains the name and location of the merchant.
citystring
The city where the merchant is located.
countrystring
The country where the merchant is located in three-letter country code format.
countryOfOriginstring
The home country in three-digit country code format, used for government-controlled merchants such as embassies.
namestring
The name of the merchant's shop or service.
rawDatastring
The raw data.
statestring
The state where the merchant is located.
postalCodestring
The postal code of the merchant.
transferInstrumentIdstring
The unique identifier of the transfer instrument.
createdAtstring
The date the transaction was created.
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
The description from the /transfers request.
idstring
The unique identifier of the transaction.
instructedAmountobject
The amount that the sender instructed their bank to send. This can be higher than amount.value when their bank deducts costs for the transfer.
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
paymentInstrumentIdstring
The unique identifier of the payment instrument that was used for the transaction.
referencestring
The reference from the /transfers request. If you haven't provided any, Adyen generates a unique reference.
referenceForBeneficiarystring
The reference sent to or received from the counterparty.

For outgoing funds, this is the referenceForBeneficiary from the /transfers request.

For incoming funds, this is the reference from the sender.

statusstring
The status of the transaction.

Possible values:

pending: The transaction is still pending.

booked: The transaction has been booked to the balance account.

transferIdstring
Unique identifier of the related transfer.
typestring
The type of the transaction.

Possible values: payment, capture, captureReversal, refund refundReversal, chargeback, chargebackReversal, secondChargeback, atmWithdrawal, atmWithdrawalReversal, internalTransfer, manualCorrection, invoiceDeduction, depositCorrection, bankTransfer, miscCost, paymentCost, fee
valueDatestring
The date the transfer amount becomes available in the balance account.
401 - Unauthorized
Authentication required.
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.
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.
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.
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.
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.
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.
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.
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 a transaction

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error