List Payouts
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-sandbox.uqpaytech.com/api/v1/payouts', 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/v1/payouts",
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>"
],
]);
$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/v1/payouts"
req, _ := http.NewRequest("GET", url, nil)
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/v1/payouts")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total_pages": 10,
"total_items": 105,
"data": [
{
"unique_request_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_currency": "USD",
"payout_amount": "1000.00",
"fee_paid_by": "SHARED",
"fee_currency": "USD",
"fee_amount": "1.00",
"payout_date": "2024-03-01",
"short_reference_id": "P220406-LLCVLRM",
"payout_reference": "026073150",
"payout_reason": "Audiovisual services",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_status": "READY_TO_SEND",
"create_time": "2024-03-01T00:00:00+08:00",
"update_time": "2024-03-01T00:00:00+08:00",
"complete_time": "2024-03-01T00:00:00+08:00",
"failure_returned_amount": "1000.00",
"failure_reason": "",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"conversion": {
"currency_pair": "USDEUR",
"client_rate": "1.355957"
}
}
]
}Payouts
List Payouts
获取 payout 交易列表。可通过指定创建日期范围或 payout 状态来筛选返回结果。
使用说明:
- 如果
start_time和end_time均省略,API 默认返回最近 30 天的 payout。 - 如果仅提供
end_time,则获取截至end_time前 30 天内的 payout。
GET
/
v1
/
payouts
List Payouts
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-sandbox.uqpaytech.com/api/v1/payouts', 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/v1/payouts",
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>"
],
]);
$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/v1/payouts"
req, _ := http.NewRequest("GET", url, nil)
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/v1/payouts")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"total_pages": 10,
"total_items": 105,
"data": [
{
"unique_request_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_currency": "USD",
"payout_amount": "1000.00",
"fee_paid_by": "SHARED",
"fee_currency": "USD",
"fee_amount": "1.00",
"payout_date": "2024-03-01",
"short_reference_id": "P220406-LLCVLRM",
"payout_reference": "026073150",
"payout_reason": "Audiovisual services",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_status": "READY_TO_SEND",
"create_time": "2024-03-01T00:00:00+08:00",
"update_time": "2024-03-01T00:00:00+08:00",
"complete_time": "2024-03-01T00:00:00+08:00",
"failure_returned_amount": "1000.00",
"failure_reason": "",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"conversion": {
"currency_pair": "USDEUR",
"client_rate": "1.355957"
}
}
]
}授权
由 UQPAY 提供的登录 API Token。
查询参数
每页返回的最大条目数。必须在 10 到 100 之间(含)。
必填范围:
1 <= x <= 100示例:
10
用于获取特定一组条目的页码。必须 大于等于 1。
必填范围:
x >= 1示例:
1
该 payout 的状态 该 payout 的状态。
READY_TO_SEND:payout 已通过校验,准备处理。PENDING:payout 正在由系统处理中。REJECTED:payout 因未满足校验或合规要求而被拒绝。FAILED:payout 处理过程中发生错误,无法完成。COMPLETED:payout 已成功处理,资金已转出。
可用选项:
READY_TO_SEND, PENDING, REJECTED, FAILED, COMPLETED created_time 的开始时间,ISO8601 格式(含)。
示例:
"2024-03-01T00:00:00+08:00"
created_time 的结束时间,ISO8601 格式(含)。
示例:
"2024-03-01T00:00:00+08:00"

