Track transactions related to third-party transfers

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:

Requirements

Use cases

By leveraging this API, you can monitor and manage both internal and external transfers efficiently, ensuring accurate record keeping. Examples of these types of transfers are:

• A payment from a purchase in your balance platform.
• A payout to one of your users.

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:

1. 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 links of the previous response.
   paymentInstrumentId		The unique identifier of the payment instrument.

2. 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 the cursor value as a query parameter in your next request.

3. If you only want to get details of a particular transaction, include the transactionId in 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.

Both incoming and outgoing transactions can be a result of external or internal transfers. The following subsections show example responses for external and internal transactions

External transactions

These transactions result from external transfers. For example:

• An outgoing transfer that your user makes to pay their suppliers.
• An incoming transfer that your user receives from a business-related transaction.

Internal transactions

These transactions result from internal transfers. For example:

• Internal transfers between balance accounts.
• Internal direct debits.

Booking and value dates

For every transaction returned in the API response, you receive two date fields: the bookingDate and the valueDate.

The dates in these fields may be different when a fund transfer is pending. For example, when you transfer funds from an Adyen business account after bank cutoff times, the funds are reserved but are not yet deducted. In this scenario, the dates will be:

• bookingDate: The date when Adyen receives the transfer request.
• valueDate: A future date, when the funds are expected to be deducted from the balance account.

The transaction will also have a pending status.

When the funds are finally deducted from the account at the specified valueDate, the status of the transaction changes to booked.