Get list of settlements
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>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements"
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-idempotency-key': '<x-idempotency-key>', 'x-auth-token': '<api-key>'}
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.uqpaytech.com/api/v2/payment/settlements")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/settlements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
]
}Payment Reports
Get list of settlements
查询结算列表,支持可选的筛选条件。
使用说明
- 如果同时省略
settled_start_time和settled_end_time,接口将返回默认时间窗口内的第一页结算记录:从今天往前一个月起至今天(含当天)。 - 指定日期范围时,必须同时提供
settled_start_time和settled_end_time。两者间隔不得超过一个月,且settled_end_time必须大于或等于settled_start_time。
GET
/
v2
/
payment
/
settlements
Get list of settlements
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>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements"
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-idempotency-key': '<x-idempotency-key>', 'x-auth-token': '<api-key>'}
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/settlements"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.uqpaytech.com/api/v2/payment/settlements")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/settlements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
]
}授权
UQPAY 提供的登录 API Token。
请求头
指定代表哪个子账户发起该请求。应设置为 account_id,可通过 List Connected Accounts 获取。若省略或为空,则使用主账户执行请求。
更多信息见 Connected Accounts。
用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。
查询参数
PaymentIntent 的唯一 ID。
示例:
"PI1945730395043532800"
结算批次的标识符。
示例:
"SB1947180993781698560"
用于按 settlement_date 筛选的起始日期(含),格式为 YYYY-MM-DD。时间基于 UTC+8。
示例:'2025-07-01' 表示 settlement_date ≥ 2025-07-01T00:00:00(UTC+8)。
示例:
"2025-07-01"
用于按 settlement_date 筛选的结束日期(含),格式为 YYYY-MM-DD。时间基于 UTC+8。
示例:'2025-07-31' 表示 settlement_date ≤ 2025-07-31T23:59:59(UTC+8)。
示例:
"2025-07-31"
用于获取下一批条目的页码,取值必须大于 1。
必填范围:
x >= 1示例:
1
每页返回的最大条目数,取值范围 1 - 100。
必填范围:
1 <= x <= 100示例:
10

