---
title: "List balance transactions"
method: GET
path: "/balance-transactions"
tags: ["Balance Transactions"]
---

# List balance transactions

`GET /balance-transactions`

Retrieves a list of balance transactions for the given account.

## Query parameters

- `limit` integer
- `startsAfter` string
- `payoutId` string

## Headers

- `Account` string

## Response `200`

Successfully retrieved the balance transactions

- BalanceTransactions
  - `items` BalanceTransaction[]
    - `id` string — The unique ID for the balance transaction
    - `type` 'TransactionApproval' | 'TransactionCapture' | 'TransactionRefund' | 'TransactionChargeback' | 'TransactionChargebackReversal' | 'PlatformFee' | 'PlatformFeeRefund' | 'SplitPayment' | 'SplitPaymentRefund' | 'TransferIn' | 'TransferOut' | 'Payout' | 'PayoutReversal' | 'PlatformChargeback' | 'PlatformChargebackReversal' | 'Adjustment' | 'ConversionBuy' | 'ConversionSell' | 'ConversionPlatformFee'
    - `amount` integer — The total amount on the transaction
    - `currency` string — The ISO currency code of the transaction. The transaction will impact the balance matching this currency.
    - `description` string, nullable — An optional field which we may populate on particular transactions to provide additional information.
    - `feeTotal` integer, nullable — 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.
    - `net` integer, nullable — The total net from this transaction. This amount will be the value allocated to the `available` amount in the balance of this transaction currency.
    - `status` 'Pending' | 'Cleared' | 'Available' — 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
    - `origin` BalanceTransactionOrigin
      - `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.
      - `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.
      - `accountId` string, nullable — Populated if the related resource resides under a particular sub account, otherwise omitted.
    - `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.
    - `createdTimestamp` integer — The epoch timestamp (seconds) when the transaction was created
    - `lastUpdatedTimestamp` integer — The epoch timestamp (seconds) when the transaction was last updated
  - `paginationToken` string, 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.

## Other responses

- `400` — One or more inputs are invalid
- `500` — An unexpected error occurred when executing this request

---

[API](https://skmtc.net/ryftpay/apis/ryft-payment-api.md) · [All operations](https://skmtc.net/ryftpay/apis/ryft-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ryftpay/ryft-payment-api/revisions/778890ee7e72/schema)