Transactions

Get all transactions

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

Returns all the transactions related to a balance account, account holder, or balance platform.

When making this request, you must include at least one of the following:

balanceAccountId
accountHolderId
balancePlatform.

This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results.

get/transactions

Query parameters

balancePlatformstring

The unique identifier of the balance platform.

Required if you don't provide a balanceAccountId or accountHolderId.

paymentInstrumentIdstring

The unique identifier of the payment instrument.

To use this parameter, you must also provide a balanceAccountId, accountHolderId, or balancePlatform.

The paymentInstrumentId must be related to the balanceAccountId or accountHolderId that you provide.

accountHolderIdstring

The unique identifier of the account holder.

Required if you don't provide a balanceAccountId or balancePlatform.

If you provide a balanceAccountId, the accountHolderId must be related to the balanceAccountId.

balanceAccountIdstring

The unique identifier of the balance account.

Required if you don't provide an accountHolderId or balancePlatform.

If you provide an accountHolderId, the balanceAccountId must be related to the accountHolderId.

cursorstring

The cursor returned in the links of the previous response.

createdSincestring date-time required

Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.

createdUntilstring date-time required

Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, 2021-05-30T15:07:40Z.

sortOrder'asc' | 'desc'

Determines the sort order of the returned transactions. The sort order is based on the creation date of the transaction.

Possible values:

asc: Ascending order, from oldest to most recent.
desc: Descending order, from most recent to oldest.

Default value: asc.

limitinteger

The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.

Response

OK - the request has succeeded.

Changes

Changed in 21 of the 51 revisions of this API.134934

Sep 23, 2026v359603902985d2See the full diff
- ●
  added the new fxBuy enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new fxSell enum value to the // response property for the response status
  response-property-enum-value-added
Jun 4, 2026v3e124e4fc0aa31See the full diff
- ○
  added discriminator to //// response property for the response status
  response-property-discriminator-added
Jun 1, 2026v32188d062ff1b4See the full diff
- ▲
  the /// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the /// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the /// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the /// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
Apr 30, 2026v3215760574f4511See the full diff
- ●
  added the new subsidization enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
Nov 19, 2025v314eeca298eb11See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Sep 12, 2025v3e805ba875d261See the full diff
- ▲
  the ///////// response property's maxLength was increased from 15 to 17 for the response status
  response-property-max-length-increased
Jul 29, 2025v3d1dbdbeb28e14See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Jul 4, 2025v35045523564fd2See the full diff
- ●
  added the new auBsbCode enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new caRoutingNumber enum value to the ////////// response property for the response status
  response-property-enum-value-added
Jun 24, 2025v33f4fe228eef71See the full diff
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
May 21, 2025v325e7e713daa52See the full diff
- ●
  added the new interest enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new interestPayout enum value to the // response property for the response status
  response-property-enum-value-added

Full history (21 revisions)