Transactions

Get a transaction

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}

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.

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' | 'grant' | 'installment' | 'installmentReversal' | 'interestPayout' | 'internalDirectDebit' | 'internalTransfer' | 'invoiceDeduction' | 'leftover' | 'manualCorrection' | 'miscCost' | 'payment' | 'paymentCost' | 'refund' | 'refundReversal' | 'repayment' | 'reserveAdjustment' | 'secondChargeback' | 'secondChargebackCorrection'

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

Changed in 19 of the 39 revisions of this API.34349

    • added the new interest enum value to the category response property for the response status 200

      response-property-enum-value-added

    • added the new interestPayout enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashoutFee enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashoutFunding enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashoutRepayment enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new capitalFundsCollection enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new bankDirectDebit enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new internalDirectDebit enum value to the type response property for the response status 200

      response-property-enum-value-added

  • v1b6626bee4e9b11See the full diff
    • added the new topUp enum value to the category response property for the response status 200

      response-property-enum-value-added

    • the endpoint scheme security clientKey was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property response/paths from the response with the 401 status

      response-optional-property-removed

    • removed the optional property response/paths from the response with the 403 status

      response-optional-property-removed

    • removed the optional property response/paths from the response with the 422 status

      response-optional-property-removed

    • removed the optional property response/paths from the response with the 500 status

      response-optional-property-removed

    • removed the optional property response/rootPath from the response with the 401 status

      response-optional-property-removed

    • removed the optional property response/rootPath from the response with the 403 status

      response-optional-property-removed

    • removed the optional property response/rootPath from the response with the 422 status

      response-optional-property-removed

    • removed the optional property response/rootPath from the response with the 500 status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1e8d0f4dc4d4081See the full diff
    • added the new balanceMigration enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashOutFee enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashOutFunding enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new cashOutInstruction enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new chargebackCorrection enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new chargebackReversalCorrection enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new secondChargebackCorrection enum value to the type response property for the response status 200

      response-property-enum-value-added

    • added the new upgrade enum value to the category response property for the response status 200

      response-property-enum-value-added

    • added the optional property counterparty/merchant/acquirerId to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property creationDate to the response with the 200 status

      response-optional-property-added

    • added the new cardTransfer enum value to the type response property for the response status 200

      response-property-enum-value-added

  • v127fc86f6c35021See the full diff
    • added the new card enum value to the category response property for the response status 200

      response-property-enum-value-added

    • added the new migration enum value to the category response property for the response status 200

      response-property-enum-value-added

    • the endpoint scheme security BasicAuth was added to the API

      api-security-added