Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Balance Transactions

List balance transactions

Retrieves a list of balance transactions for the given account.

get/balance-transactions

Query parameters

limitinteger
Example:20

Control how many items are returned in the result list. The max limit we allow is 50.

startsAfterstring
Example:bltxn_01FCTS1XMKH9FF43CAFA4CXT3P

A token to identify the previous item to start querying after. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

payoutIdstring
Example:po_01FCTS1XMKH9FF43CAFA4CXT3P

You may specify a Payout ID to retrieve all transactions which made up a particular payout.

Note that this is only available for accounts on Automated payouts. For Manual payouts if specified, this will return an empty result set. Also consider that if you switch between payout frequency (Manual to Automatic) then the initial payout after switching is not supported here.

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this to list balance transactions for a specific sub account)

Response

Successfully retrieved the balance transactions

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return.

Example response

{
  "items": [
    {
      "id": "bltxn_01FCTS1XMKH9FF43CAFA4CXT3P",
      "type": "TransactionCapture",
      "amount": 575,
      "currency": "GBP",
      "feeTotal": 5,
      "net": 572,
      "status": "Available",
      "origin": {
        "id": "txn_01FCTS1XMKH9FF43CAFA4CXT3P_01FCTS1XMKH9FF43CAFA4CXT3P",
        "amount": 575
      },
      "availableAt": 1631696701,
      "createdTimestamp": 1631696701,
      "lastUpdatedTimestamp": 1631696701
    }
  ],
  "paginationToken": "bltxn_01FCTS1XMKH9FF43CAFA4CXT3P"
}