Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Payment Reports

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

Query parameters

payment_intent_idstring
Example:PI1945730395043532800

The unique ID of a payment intent.

settlement_batch_idstring
Example:SB1947180993781698560

Identifier of the settlement batch.

settled_start_timestring
Example:2025-07-01

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).

settled_end_timestring
Example:2025-07-31

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).

page_numberinteger required
Example:1

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

page_sizeinteger required
Example:10

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

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring 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.

Response

List of settlements retrieved successfully

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "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",
      "payment_intent_id": "PI1234567890123456789",
      "payment_method": "card",
      "transaction_create_date": "2024-03-01T00:00:00+08:00",
      "transaction_date": "2024-03-01T00:00:00+08:00",
      "exchange_rate": "1",
      "settlement_status": "SUCCEEDED",
      "settlement_batch_id": "SB1947180993781698560",
      "settlement_create_date": "2024-03-01T00:00:00+08:00",
      "settlement_date": "2024-03-01T00:00:00+08:00"
    }
  ]
}