To keep track of funds movements in your balance platform, you can use the Transfers API API. With this API, you can query the /transactions endpoint for your whole balance platform, a particular account holder, or balance account. On this page you can:
- Get updates through webhooks.
- Make API requests to keep track of transactions.
Requirements
| Requirement | Description |
|---|---|
| Integration type | You must have an Adyen for Platforms, Issuing, or Payouts integration. |
| API credentials | You must have the credentials and the following roles for the Transfers API. Ensure that you have asked your Adyen contact to assign the following role to your API credential::
|
With the Transactions API, you can query the transactions for your whole balance platform, a particular account holder, or balance account.
Get a list of transactions
To get a list of transactions, related to a balance account, account holder, or balance platform:
-
Make a GET /transactions request with the following query parameters.
Parameter Required Description balancePlatform, accountHolderId, or balanceAccountId 
You must include at least one of the following in your request: - balancePlatform: The unique identifier of the balance platform.
- accountHolderId: The unique identifier of the account holder.
- balanceAccountId: The unique identifier of the balance account.
createdSince Transactions created after this date and time are included in the response. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z. createdUntil Transactions created before this date and time are included in the response. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z. limit The number of items returned per page. sortOrder The transactions sorting order. cursor The cursor returned in the linksof the previous response.paymentInstrumentId The unique identifier of the payment instrument. -
The response includes:
data: an array containing all the transactions that match the query parameters._links: an object containing links to the next or previous page when applicable. To page through the results, add thecursorvalue as a query parameter in your next request.
-
If you only want to get details of a particular transaction, include the
transactionIdin your GET /transactions/{id} request.
Identify incoming and outgoing funds
Refer to the following fields and objects of the API response to find out if a transaction is outgoing or incoming.
| Field | Incoming funds | Outgoing funds |
|---|---|---|
| amount | Has a positive value, meaning funds are added to the balance account. | Has a negative value, meaning funds are deducted from the balance account. |
| /data.transfer.reference | The reference from the sender, if they sent any. | The reference that you sent in the /transfers request. |
| status | The status of the transaction. It can be:
|
The status of the transaction. It can be:
|
Booking and value dates
For every transaction returned in the API response, you receive two date fields: the bookingDate and the valueDate.
These fields indicate when the funds are recorded and when they are deducted from your balance account. For example, when you make a payment that the merchant has not yet captured, the funds are reserved but are not yet deducted. In this scenario, the dates will be:
- bookingDate: The date when the funds are recorded as reserved or pending in the balance account.
- valueDate: The date when the funds are deducted from or made available in the balance account.
Funds are always deducted at the booked stage for outgoing transfers.