Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.
Returns a transaction.
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.
The request has succeeded.
Show more Show lessContains information about the amount of the transaction.
The amount of the transaction, in minor units.
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.
Contains information about the other party in the transaction.
Unique identifier of the balance account.
Contains information about the bank account.
Information about the owner of the bank account.
Address of the bank account owner.
The postal code. Maximum length:
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.
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.
Contains information about the merchant.
Contains the merchant's name and location.
The country where the merchant is located in three-letter country code format.
The home country in three-digit country code format, used for government-controlled merchants such as embassies.
Unique identifier of the transfer instrument.
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
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.
The amount of the transaction, in minor units.
The unique identifier of the payment instrument that was used for the transaction.
The reference
from the /transfers
request. If you haven't provided any, Adyen generates a unique reference.
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.
The status of the transaction.
Possible values:
pending: The transaction is still pending.
booked: The transaction has been booked to the balance account.
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