---
title: "Get list of settlements"
method: GET
path: "/v2/payment/settlements"
tags: ["Payment Reports"]
---

# Get list of settlements

`GET /v2/payment/settlements`

Retrieve a list of settlements with optional filtering

#### Usage Guidelines
- If `settled_start_time` and `settled_end_time` are both omitted, the API returns the first page of settlements within the default window: from one month before today up to today (inclusive).
- When specifying the date range, both `settled_start_time` and `settled_end_time` must be provided. The interval between them must not exceed one month, and `settled_end_time` must be greater than or equal to `settled_start_time`.

## Query parameters

- `payment_intent_id` string
- `settlement_batch_id` string
- `settled_start_time` string
- `settled_end_time` string
- `page_number` integer, required
- `page_size` integer, required

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Response `200`

List of settlements retrieved successfully

- object
  - `total_pages` integer — The total pages of available items.
  - `total_items` integer — The total counts of available items.
  - `data` SettlementObjectResponse[]
    - `settlement_id` string — Unique identifier of the settlement (UUID).
    - `account_id` string — UUID of the account associated with the settlement.
    - `account_name` string — Name of the account.
    - `source_type` string — Source type of the transaction record.
    - `transaction_type` string — Type of transaction.
    - `merchant_order_id` string — The merchant reference id created in merchant's system that corresponds to this PaymentIntent
    - `payment_intent_id` string — The ID of the payment intent.
    - `payment_method` 'card' | 'alipaycn' | 'alipayhk' | 'unionpay' | 'wechatpay' — Payment method used for the transaction. - `card`: Card payment (Visa, Mastercard, UnionPay). - `alipaycn`: Alipay (mainland China). - `alipayhk`: AlipayHK (Hong Kong). - `unionpay`: UnionPay QR code payment. - `wechatpay`: WeChat Pay.
    - `transaction_create_date` string, date/time
    - `transaction_amount` string
    - `transaction_currency` string — Three-letter currency code
    - `transaction_date` string, date/time
    - `settlement_amount` string
    - `settlement_currency` string — Three-letter currency code
    - `net_settlement_amount` string
    - `exchange_rate` string — Exchange rate applied from `transaction_currency` to `settlement_currency`, if applicable.
    - `fee_currency` string — Three-letter currency code
    - `interchange_fee` string — The fee amount.
    - `scheme_fee` string — The fee amount.
    - `transcation_fee` string — The fee amount.
    - `return_fee` string — The fee amount.
    - `total_fee_amount` string — The fee amount.
    - `settlement_status` 'SUCCEEDED' — The status of the settlement. Only `SUCCEEDED` will be returned.
    - `settlement_batch_id` string — Identifier of the settlement batch.
    - `settlement_create_date` string, date/time
    - `settlement_date` string, date/time

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)