Retrieve Payout
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/payout/{payout_id} \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/{payout_id}"
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/payout/{payout_id}', 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/payout/{payout_id}",
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/payout/{payout_id}"
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/payout/{payout_id}")
.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/payout/{payout_id}")
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{
"payout_id": "PO1968582687224500224",
"payout_currency": "SGD",
"payout_amount": "100.00",
"payout_fee": "<string>",
"debited_amount": "<string>",
"transfer_amount": "<string>",
"statement_descriptor": "UQPAY PAYOUT",
"payout_status": "INITIATED",
"create_time": "2025-09-18T15:47:41+08:00",
"internal_note": "Payment to supplier",
"completed_time": ""
}Payment Payouts
Retrieve Payout
查询指定出款单的详细信息
GET
/
v2
/
payment
/
payout
/
{payout_id}
Retrieve Payout
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/payout/{payout_id} \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/{payout_id}"
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/payout/{payout_id}', 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/payout/{payout_id}",
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/payout/{payout_id}"
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/payout/{payout_id}")
.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/payout/{payout_id}")
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{
"payout_id": "PO1968582687224500224",
"payout_currency": "SGD",
"payout_amount": "100.00",
"payout_fee": "<string>",
"debited_amount": "<string>",
"transfer_amount": "<string>",
"statement_descriptor": "UQPAY PAYOUT",
"payout_status": "INITIATED",
"create_time": "2025-09-18T15:47:41+08:00",
"internal_note": "Payment to supplier",
"completed_time": ""
}授权
UQPAY 提供的登录 API Token。
请求头
指定代表哪个子账户发起该请求。应设置为 account_id,可通过 List Connected Accounts 获取。若省略或为空,则使用主账户执行请求。
更多信息见 Connected Accounts。
用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。
路径参数
出款单 ID
示例:
"PO1234567890123456789"
响应
200 - application/json
成功获取出款
出款 UUID
示例:
"PO1968582687224500224"
三位币种代码
示例:
"SGD"
请求中提交的出款金额。
示例:
"100.00"
此次出款收取的手续费,币种为 payout_currency。
从你的余额中扣除的总金额。
- 手续费从出款金额中扣除:
debited_amount = payout_amount - 手续费单独收取:
debited_amount = payout_amount + payout_fee
发送至下游出款服务商的金额。
- 手续费从出款金额中扣除:
transfer_amount = payout_amount - payout_fee - 手续费单独收取:
transfer_amount = payout_amount
向收款方银行展示的出款参考信息
Maximum string length:
15示例:
"UQPAY PAYOUT"
出款状态枚举。
INITIATED:出款已发起。PROCESSING:出款正在处理中(银行处理中)。COMPLETED:出款已成功完成。FAILED:出款失败。FAILED_REFUNDED:出款失败,资金已退回。
可用选项:
INITIATED, PROCESSING, COMPLETED, FAILED, FAILED_REFUNDED 示例:
"INITIATED"
出款创建时间
示例:
"2025-09-18T15:47:41+08:00"
出款备注信息
示例:
"Payment to supplier"
出款完成时间
示例:
""

