Get all transactions

get /transactions

Was this page helpful?

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

Returns all the transactions 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.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/btl/v3/transactions

Query parameters

Required Optional

limit integer

The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.

createdUntil string Required

Only include transactions 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.

createdSince string Required

Only include transactions 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.

cursor string

The cursor returned in the links of the previous response.

balanceAccountId string

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.

accountHolderId string

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.

paymentInstrumentId string

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.

balancePlatform string

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 more Show less
_links object

Contains links to the next and previous page whenever applicable.

Show children Hide children

next object

Contains a link to the next page.

Show children Hide children

href string

prev object

Contains a link to the previous page.

Show children Hide children

href string

data array [object]

Contains the transactions that match the query parameters.

Show children Hide children

accountHolderId string

Unique identifier of the account holder.

amount object

Contains information about the amount of the transaction.

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

balanceAccountId string

Unique identifier of the balance account.

balancePlatform string

The unique identifier of the balance platform.

bookingDate string

The date the transaction was booked into the balance account.

category string

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.

counterparty object

Contains information about the other party in the transaction.

Show children Hide children

balanceAccountId string

Unique identifier of the balance account.

bankAccount object

Contains information about the bank account.

Show children Hide children

accountHolder object

Information about the owner of the bank account.

Show children Hide children

address object

Address of the bank account owner.

Show children Hide children

city string

The name of the city.

country string

The two-character ISO 3166-1 alpha-2 country code. For example, US, NL, or GB.

line1 string

First line of the street address.

line2 string

Second line of the street address.

postalCode string

The postal code. Maximum length:

5 digits for an address in the US.

10 characters for an address in all other countries.

stateOrProvince string

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.

dateOfBirth string

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

firstName string

First name of the individual.

Allowed only when type is individual.

fullName string

The name of the entity.

lastName string

Last name of the individual.

Allowed only when type is individual.

reference string

A 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.

type string

The type of entity that owns the bank account.

Possible values: individual, organization, or unknown.

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.

merchant object

Contains information about the merchant.

Show children Hide children

acquirerId string

The unique identifier of the merchant's acquirer.

mcc string

The merchant category code.

merchantId string

The merchant identifier.

nameLocation object

Contains the merchant's name and location.

Show children Hide children

city string

The city where the merchant is located.

country string

The country where the merchant is located in three-letter country code format.

countryOfOrigin string

The home country in three-digit country code format, used for government-controlled merchants such as embassies.

name string

The name of the merchant's shop or service.

rawData string

The raw data.

state string

The state where the merchant is located.

postalCode string

The merchant postal code.

transferInstrumentId string

Unique identifier of the transfer instrument.

createdAt string

The date the transaction was created.

creationDate string

The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.

description string

The description from the /transfers request.

eventId string

The PSP reference of the transaction in the journal.

id string

The unique identifier of the transaction.

instructedAmount object

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.

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

paymentInstrumentId string

The unique identifier of the payment instrument that was used for the transaction.

reference string

The reference from the /transfers request. If you haven't provided any, Adyen generates a unique reference.

referenceForBeneficiary string

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.

status string

The status of the transaction.

Possible values:

pending: The transaction is still pending.

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

transferId string

Unique identifier of the related transfer.

type string

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

valueDate string

The date the transfer amount becomes available in the balance account.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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 more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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 more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [object]

Detailed explanation of each validation error, when applicable.

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [object]

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get all transactions

Endpoint destination URL

Query parameters

Response parameters

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error