**Version: 202601**

# List settlements

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

Returns a paginated list of settlement detail records, optionally filtered by transaction type, currency, region, and settlement time range.

## Request

**Query Parameters**

- `cursor` string

  Cursor for pagination
- `page_size` int32

  Page size (1-100, default 10)
- `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
- `currency` string

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

  Filter settlements initiated at or after this Unix timestamp (e.g., 1730548810)
- `settlement_time_max` string

  Filter settlements initiated at or before this Unix timestamp (e.g., 1730548810)
- `region` string

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

## Responses

**200**

OK

**application/json**

**Schema | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `list` object[]

    List of settlement detail records

    *   Array \[

    - `store_id` string

      Store ID associated with the settlement
    - `currency` string

      Currency of the settlement account
    - `trans_type` string

      Transaction type. Refer to valid trans\_type values in the request parameters
    - `trans_id` string

      Unique transaction ID for the settlement
    - `fee_amount` string

      Fee amount associated with the transaction
    - `settlement_amount` string

      Total settlement amount
    - `reserve_amount` string

      Reserve amount for the transaction
    - `settlement_time` string

      Settlement time in Unix timestamp format
    - `merchant_id` string

      Merchant ID associated with the settlement
    *   \]
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records

```json
{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "store_id": "string",
        "currency": "string",
        "trans_type": "string",
        "trans_id": "string",
        "fee_amount": "string",
        "settlement_amount": "string",
        "reserve_amount": "string",
        "settlement_time": "string",
        "merchant_id": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}
```