Get all transactions

get/transactions

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

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

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.

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.

The cursor returned in the links of the previous response.

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.

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.

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.

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 moreShow less
_linksobject
Contains links to the next and previous page whenever applicable.
Show children Hide children
nextobject
Contains a link to the next page.
Show children Hide children
hrefstring
The link to the resource.
prevobject
Contains a link to the previous page.
Show children Hide children
hrefstring
The link to the resource.
dataarray[object]
Contains the transactions that match the query parameters.
Show children Hide children
accountHolderIdstring
Unique identifier of the account holder.
amountobject
Contains information about the amount of the transaction.
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.
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.
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.
mccstring
The merchant category code.
merchantIdstring
The merchant identifier.
nameLocationobject
Contains the merchant's name and location.
Show children Hide children
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 merchant postal code.
transferInstrumentIdstring
The unique identifier of the counterparty 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.
eventIdstringDeprecated in version 3
This field will be removed in version 4.
The PSP reference of the transaction in the journal.
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.
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.
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.
Show more Show 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.
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 more Show 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.
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 more Show 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.
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 more Show 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.
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 all transactions

Query Parameters

Response parameters

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error