Sign in
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 39 revisions of this API.383411

  • v19e3fb59b98911See the full diff
    • ○

      added the new optional query request parameter sortOrder

      new-optional-request-parameter

  • v17d50c61d15a02See the full diff
    • ●

      added the new interest enum value to the data/items/category response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new interestPayout enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

  • v1442da14d7ff03See the full diff
    • ●

      added the new cashoutFee enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cashoutFunding enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cashoutRepayment enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

  • v13cbb09de4cb81See the full diff
    • ●

      added the new capitalFundsCollection enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

  • v12b890cadd3682See the full diff
    • ●

      added the new bankDirectDebit enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new internalDirectDebit enum value to the data/items/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 data/items/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

  • v16a461735ce658See the full diff
    • ●

      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 data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cashOutFee enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cashOutFunding enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cashOutInstruction enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new chargebackCorrection enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new chargebackReversalCorrection enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new secondChargebackCorrection enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new upgrade enum value to the data/items/category response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property data/items/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

  • v1c361708577d01See the full diff
    • ○

      added the optional property data/items/creationDate to the response with the 200 status

      response-optional-property-added

  • v1b59d8300b5071See the full diff
    • ●

      added the new cardTransfer enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added