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/v4/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.
accountHolderobject
Contains information about the account holder associated with the balanceAccount.
descriptionstring
The description of the resource.
idstring
The unique identifier of the resource.
referencestring
The reference for the resource.
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.
balanceAccountobject
Contains information about the balance account involved in the transaction.
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.
bookingDatestring
The date the transaction was booked into the balance account.
creationDatestring
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2025-03-19T10:15:30+01:00.
descriptionstring
The description from the /transfers request.
idstring
The unique identifier of the transaction.
paymentInstrumentobject
Contains information about the payment instrument that was used for the transaction.
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.
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.

transferobject
Contains information about the transfer related to the transaction.
categoryData
The relevant data according to the transfer category.
idstring
The ID of the resource.
referencestring
The reference from the /transfers request. If you haven't provided any, Adyen generates a unique reference.
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