Get list of 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.

GET /v2/payment/settlements

Get list of settlements

cURL

curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/settlements \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>'

200

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "settlement_id": "ST1945730404245835776",
      "account_id": "a7b92a19-bfc3-4c8b-8a4f-cfcf74cab345",
      "account_name": "UQPAY PTE. LTD.",
      "source_type": "PAYMENT",
      "transaction_type": "PAYMENT",
      "merchant_order_id": "<string>",
      "payment_intent_id": "PI1234567890123456789",
      "payment_method": "card",
      "transaction_create_date": "2024-03-01T00:00:00+08:00",
      "transaction_amount": "7.77",
      "transaction_currency": "SGD",
      "transaction_date": "2025-07-17T14:20:50+08:00",
      "settlement_amount": "7.77",
      "settlement_currency": "SGD",
      "net_settlement_amount": "8.11",
      "exchange_rate": "1",
      "fee_currency": "SGD",
      "interchange_fee": "0",
      "scheme_fee": "0",
      "transcation_fee": "0.34",
      "return_fee": "0",
      "total_fee_amount": "0.34",
      "settlement_status": "SUCCEEDED",
      "settlement_batch_id": "SB1947180993781698560",
      "settlement_create_date": "2025-07-17T14:20:52+08:00",
      "settlement_date": "2025-07-21T14:25:01+08:00"
    }
  ]
}

授权

x-auth-token · string · header · 必填

The API token for login provided by UQPay.

请求头

x-on-behalf-of · string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-key · string<uuid> · 必填

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

查询参数

payment_intent_id · string

The unique ID of a payment intent.

示例:

"PI1945730395043532800"

settlement_batch_id · string

Identifier of the settlement batch.

示例:

"SB1947180993781698560"

settled_start_time · string

Inclusive start date used to filter by settlement_date, in YYYY-MM-DD format. Time is based on UTC+8.

Example: '2025-07-01' means settlement_date ≥ 2025-07-01T00:00:00 (UTC+8).

示例:

"2025-07-01"

settled_end_time · string

Inclusive end date used to filter by settlement_date, in YYYY-MM-DD format. Time is based on UTC+8.

Example: '2025-07-31' means settlement_date ≤ 2025-07-31T23:59:59 (UTC+8).

示例:

"2025-07-31"

page_number · integer · 必填

The page number to retrieve the next set of items. The number has to be greater than 1.

必填范围: x >= 1

示例:

1

page_size · integer · 必填

The maximum number of items to return per page. This number can be between 1 - 100

必填范围: 1 <= x <= 100

示例:

10

响应

200 - application/json

List of settlements retrieved successfully

total_pages · integer

The total pages of available items.

示例:

10

total_items · integer

The total counts of available items.

示例:

105

data · object[]

Show child attributes