# List balance transactions

Retrieves a list of balance transactions for the given account.

Endpoint: GET /balance-transactions
Version: 1.1.0
Security: secretApiKeyAuth

## Header parameters:

  - `Account` (string)
    The linked accountId (use this to list balance transactions for a specific sub account)
    Example: "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"

## Query parameters:

  - `limit` (integer)
    Control how many items are returned in the result list. The max limit we allow is 50.
    Example: 20

  - `startsAfter` (string)
    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.
    Example: "bltxn_01FCTS1XMKH9FF43CAFA4CXT3P"

  - `payoutId` (string)
    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.
    Example: "po_01FCTS1XMKH9FF43CAFA4CXT3P"

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The unique ID for the balance transaction
    Example: "bltxn_01FCTS1XMKH9FF43CAFA4CXT3P"

  - `items.type` (string)
    Enum: "TransactionApproval", "TransactionCapture", "TransactionRefund", "TransactionChargeback", "TransactionChargebackReversal", "PlatformFee", "PlatformFeeRefund", "SplitPayment", "SplitPaymentRefund", "TransferIn", "TransferOut", "Payout", "PayoutReversal", "PlatformChargeback", "PlatformChargebackReversal", "Adjustment"

  - `items.amount` (integer)
    The total amount on the transaction
    Example: 575

  - `items.currency` (string)
    The ISO currency code of the transaction. The transaction will impact the balance matching this currency.
    Example: "GBP"

  - `items.description` (string,null)
    An optional field which we may populate on particular transactions to provide additional information.

  - `items.feeTotal` (integer,null)
    The total amount of fees allocated to this transaction. Note that fees may be added incrementally up until the transaction reaches the Available status. After this point you can consider the value in this field final.
    Example: 5

  - `items.net` (integer,null)
    The total net from this transaction. This amount will be the value allocated to the available amount in the balance of this transaction currency.
    Example: 572

  - `items.status` (string)
    A status representing the current stage this transaction is in. These can be categorised as follows:
 - Pending - transactions which must go through clearing before being made available (e.g. TransactionCapture)
 - Cleared - pending transactions which have successfully been cleared such as those requiring settlement with the card schemes
 - Available - transactions which have cleared and have now been made available or those which immediately impact your available balance such as payouts and transfers
    Enum: "Pending", "Cleared", "Available"

  - `items.origin` (object)

  - `items.origin.id` (string)
    The unique ID of the related resource that subsequently created this balance transaction. For example, when capturing a payment, you can expect the associated transaction ID of the capture to be populated here.
    Example: "txn_01FCTS1XMKH9FF43CAFA4CXT3P_01FCTS1XMKH9FF43CAFA4CXT3P"

  - `items.origin.amount` (integer)
    The total amount on the related resource.
Note that this can differ to the amount on the balance transaction itself if the transaction represents a fee-only. For example, TransactionApproval's whereby there is no amount to net on the transaction but a fee is deducted.
    Example: 575

  - `items.origin.accountId` (string,null)
    Populated if the related resource resides under a particular sub account, otherwise omitted.

  - `items.availableAt` (integer)
    The epoch timestamp (seconds) when the transaction is expected to be made available. At this point the net amount will be allocated to your available balances

Note that this timestamp is an approximation and the actual allocation may complete on or after this time.
    Example: 1631696701

  - `items.createdTimestamp` (integer)
    The epoch timestamp (seconds) when the transaction was created
    Example: 1631696701

  - `items.lastUpdatedTimestamp` (integer)
    The epoch timestamp (seconds) when the transaction was last updated
    Example: 1631696701

  - `paginationToken` (string)
    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: "bltxn_01FCTS1XMKH9FF43CAFA4CXT3P"

## Response 400 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"

## Response 500 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"