ADadyen
Transactions

Get a transaction

Changed on

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

Returns a transaction.

get/transactions/{id}

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/btl/v3
  • URL
    https://balanceplatform-api-test.adyen.com/btl/v3/transactions/{id}
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

Path parameters

idstring required

The unique identifier of the transaction.

Response

OK - the request has succeeded.

accountHolderIdstring required

Unique identifier of the account holder.

balanceAccountIdstring required

Unique identifier of the balance account.

balancePlatformstring required

The unique identifier of the balance platform.

bookingDatestring date-time required

The date the transaction was booked into the balance account.

category'bank' | 'card' | 'grants' | 'interest' | 'internal' | 'issuedCard' | 'migration' | 'platformPayment' | 'topUp' | 'upgrade'

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.

createdAtstring date-time required

The date the transaction was created.

creationDatestring date-time

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.

eventIdstring

The PSP reference of the transaction in the journal.

idstring required

The unique identifier of the transaction.

paymentInstrumentIdstring

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

referencestring required

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.

status'booked' | 'pending' required

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.

type'atmWithdrawal' | 'atmWithdrawalReversal' | 'balanceAdjustment' | 'balanceMigration' | 'balanceRollover' | 'bankDirectDebit' | 'bankTransfer' | 'capitalFundsCollection' | 'capture' | 'captureReversal' | 'cardTransfer' | 'cashOutFee' | 'cashOutFunding' | 'cashOutInstruction' | 'cashoutFee' | 'cashoutFunding' | 'cashoutRepayment' | 'chargeback' | 'chargebackCorrection' | 'chargebackReversal' | 'chargebackReversalCorrection' | 'depositCorrection' | 'fee' | 'fxBuy' | 'fxSell' | 'grant' | 'installment' | 'installmentReversal' | 'interestPayout' | 'internalDirectDebit' | 'internalTransfer' | 'invoiceDeduction' | 'leftover' | 'manualCorrection' | 'miscCost' | 'payment' | 'paymentCost' | 'refund' | 'refundReversal' | 'repayment' | 'reserveAdjustment' | 'secondChargeback' | 'secondChargebackCorrection' | 'subsidization'

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 date-time required

The date the transfer amount becomes available in the balance account.

Changes

  • v359603902985dRevision changes
    • warning

      added the new fxBuy enum value to the response property for the response status

    • warning

      added the new fxSell enum value to the response property for the response status

  • v3e124e4fc0aa3Revision changes
    • info

      added discriminator to // response property for the response status