**Version: 202601**

# List balances

**GET** `/openapi/2026-01/shoplazza-payment/balance/details`

Returns a paginated list of balance transaction details for the specified account type (available, pending, or fixed reserve).

## Request

**Query Parameters**

- `balance_type` string

  Type of balance account to query:

  *   `available`: available balance (acc\_settle)
  *   `pending`: pending/unsettled balance (acc\_payment)
  *   `fixed_reserve`: fixed reserve balance (acc\_fixed\_reserve)
- `region` string

  Region of the merchant account (e.g., US, HK). Defaults to the merchant's default region
- `currency` string

  Currency of the balance account. Defaults to the merchant's default currency. Must match the specified region
- `cursor` string

  Cursor for pagination
- `page_size` int32

  Page size (1-100, default 10)
- `trans_type` string

  Filter by transaction event type. Only applicable when balance\_type is "available"; ignored when balance\_type is "pending" or "fixed\_reserve":

  *   `batch_settlement`: batch settlement of completed payments
  *   `funds_reserved`: funds moved into the rolling or fixed reserve
  *   `released_reserve`: reserve released back to the available balance
  *   `return_funds`: refund-related funds returned
  *   `balance_debit`: balance debited
  *   `pay_in`: funds paid into the available balance
  *   `adjustment`: manual or system balance adjustment
  *   `payout`: payout sent to the merchant's bank account
  *   `payout_fee`: fee charged on a payout
  *   `active_account_fee`: active account service fee
  *   `withdrawal_exchange_fee`: currency exchange fee on withdrawal
- `trans_time_min` string

  Filter transactions that occurred at or after this Unix timestamp (e.g., 1730548810)
- `trans_time_max` string

  Filter transactions that occurred at or before this Unix timestamp (e.g., 1730548810)

## Responses

**200**

OK

**application/json**

**Schema | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `list` object[]

    List of balance transaction detail records

    *   Array \[

    - `trans_time` string

      Time when the transaction occurred (e.g., 2018-11-02T12:30:10Z)
    - `trans_id` string

      Associated business transaction ID
    - `trans_type` string

      Type of settlement transaction to filter by:

      *   `payment`: payment settlement
      *   `reserve_release`: scheduled release of reserved funds
      *   `chargeback`: chargeback debit
      *   `chargeback_win`: chargeback won; funds credited back
      *   `refund`: refund settlement
      *   `refund_reversal`: reversal of a previous refund
      *   `ship_ins_comm_transfer`: shipping insurance commission transferred in
      *   `ship_ins_comm_reversal`: reversal of a shipping insurance commission transfer
      *   `adjustment`: manual or system settlement adjustment
      *   `debit_negative_balance`: debit to cover a negative balance
      *   `debit_negative_balance_reversal`: reversal of a negative-balance debit
    - `trans_amount` string

      Transaction amount; positive values represent credits and negative values represent debits
    - `currency` string

      Currency code of the transaction (e.g., USD, EUR)
    - `balance_before` string

      Account balance before this transaction was applied
    - `balance_after` string

      Account balance after this transaction was applied
    - `description` string

      Human-readable description of the transaction
    *   \]
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records

```json
{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "trans_time": "string",
        "trans_id": "string",
        "trans_type": "string",
        "trans_amount": "string",
        "currency": "string",
        "balance_before": "string",
        "balance_after": "string",
        "description": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}
```