curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts/{id}"
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/{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/v1/payouts/{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>"
],
]);
$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/{id}"
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/{id}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/payouts/{id}")
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{
"unique_request_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"amount_payer_pays": "1000.00",
"payout_currency": "USD",
"payout_amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"source_currency": "USD",
"source_amount": "1000.00",
"amount_beneficiary_receives": "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",
"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",
"payout_method": "LOCAL",
"payer": {
"payer_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
"entity_type": "COMPANY",
"country": "SG",
"company_name": "UQPAY",
"first_name": "John",
"last_name": "Doe",
"city": "Singapore",
"address": "123 Main St",
"state": "CA",
"postal_code": "123456",
"date_birth": "2001-01-28",
"identification_type": "PASSPORT",
"identification_value": "12345678"
},
"beneficiary": {
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM",
"entity_type": "COMPANY",
"payment_method": "LOCAL",
"email": "example@uqpay.com",
"beneficiary_status": "ACTIVE",
"summary": "John Doe",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"nickname": "John Doe",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"first_name": "John",
"last_name": "Doe",
"id_number": "110101199001011234",
"create_time": "2024-03-01T00:00:00+08:00",
"update_time": "2024-03-01T00:00:00+08:00",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"failure_returned_amount": "1000.00",
"failure_reason": "",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"conversion": {
"currency_pair": "USDEUR",
"client_rate": "1.355957"
}
}Retrieve Payout
通过指定 payout_id 获取某笔特定 payout。
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts/{id}"
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/{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/v1/payouts/{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>"
],
]);
$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/{id}"
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/{id}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/payouts/{id}")
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{
"unique_request_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"amount_payer_pays": "1000.00",
"payout_currency": "USD",
"payout_amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"source_currency": "USD",
"source_amount": "1000.00",
"amount_beneficiary_receives": "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",
"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",
"payout_method": "LOCAL",
"payer": {
"payer_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
"entity_type": "COMPANY",
"country": "SG",
"company_name": "UQPAY",
"first_name": "John",
"last_name": "Doe",
"city": "Singapore",
"address": "123 Main St",
"state": "CA",
"postal_code": "123456",
"date_birth": "2001-01-28",
"identification_type": "PASSPORT",
"identification_value": "12345678"
},
"beneficiary": {
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM",
"entity_type": "COMPANY",
"payment_method": "LOCAL",
"email": "example@uqpay.com",
"beneficiary_status": "ACTIVE",
"summary": "John Doe",
"bank_details": {
"bank_name": "Bank of America",
"bank_address": "123 Main St",
"bank_country_code": "SG",
"account_holder": "John Doe",
"account_currency_code": "USD",
"swift_code": "WELGBE22",
"clearing_system": "GIRO",
"account_number": "12345678",
"iban": "GB82 WEST 1234 5698 7654 32",
"routing_code_type1": "aba",
"routing_code_value1": "123456789",
"routing_code_type2": "ach",
"routing_code_value2": "123456789"
},
"address": {
"country": "SG",
"city": "Singapore",
"street_address": "123 Main St",
"postal_code": "123456",
"state": "CA",
"nationality": "SG"
},
"nickname": "John Doe",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"first_name": "John",
"last_name": "Doe",
"id_number": "110101199001011234",
"create_time": "2024-03-01T00:00:00+08:00",
"update_time": "2024-03-01T00:00:00+08:00",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"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。
路径参数
资源的通用唯一标识符(UUID v4)。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
响应
OK —— 成功获取 payout。
出款的唯一请求标识符。 多数记录为 UUID v4;通过历史或兼容流程创建的记录可能为 64 位十六进制标识符。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
该 payout 的唯一标识符。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
付款人为该 payout 实际支付的金额。
"1000.00"
付款人将汇出的金额,以 currency 计。
"1000.00"
payout 的用途代码,必须为以下之一:
AUDIO_VISUAL_SERVICES- 视听服务。BILL_PAYMENT- 账单支付。BUSINESS_EXPENSES- 企业开支。CONSTRUCTION- 建筑。DONATION_CHARITABLE_CONTRIBUTION- 捐赠/慈善捐赠。EDUCATION_TRAINING- 教育/培训。FAMILY_SUPPORT- 家庭赡养。FREIGHT- 运费。GOODS_PURCHASED- 购买商品。INVESTMENT_CAPITAL- 投资本金。INVESTMENT_PROCEEDS- 投资收益。LIVING_EXPENSES- 生活开支。LOAN_CREDIT_REPAYMENT- 贷款/信贷还款。MEDICAL_SERVICES- 医疗服务。PENSION- 养老金。PERSONAL_REMITTANCE- 个人汇款。PROFESSIONAL_BUSINESS_SERVICES- 专业/商业服务。REAL_ESTATE- 房地产。TAXES- 税费。TECHNICAL_SERVICES- 技术服务。TRANSFER_TO_OWN_ACCOUNT- 转账至本人账户。TRAVEL- 旅行。WAGES_SALARY- 工资/薪酬。
"AUDIO_VISUAL_SERVICES"
付款人将汇出的币种。
3"USD"
付款人为该 payout 支付的金额。
"1000.00"
受益人收到的金额。
"1000.00"
付款手续费的承担类型。仅在 payment_method = SWIFT 时生效。
SHARED:交易手续费由付款人与收款方分担;付款人承担汇出行费用,收款方承担收款行费用。OURS:所有交易手续费(含中间行费用)均由付款人承担。
当记录的手续费承担方式不可用或不适用时,可能返回空字符串。
SHARED, OURS, "SHARED"
该 payout 的手续费金额。
"1.00"
系统尝试向受益人提交付款的日期。
"2024-03-01"
系统生成的用于标识该 payout 的编号。
"P220406-LLCVLRM"
显示在受益人银行交易记录中的银行付款附言。会发送给收款方(如 For Further Credit、For Benefit of 或自定义信息)。在控制台中亦称 Payment reference。
- SWIFT 付款:必须符合正则
/^[a-zA-Z0-9/-?:().'+, ]+$/。 允许的字符:英文字母、数字、空格,以及以下特殊符号:- / ? : ( ) . ' + ,。 - LOCAL 付款:当
payment_method = LOCAL且account_currency_code不是 CNH 或 SGD 时,不应用输入格式校验。
100"026073150"
该 payout 的自定义事由,将显示在受益人的银行交易记录中。
200"Audiovisual services"
该 payout 的状态。
READY_TO_SEND:payout 已通过校验,准备处理。PENDING:payout 正在由系统处理中。REJECTED:payout 因未满足校验或合规要求而被拒绝。FAILED:payout 处理过程中发生错误,无法完成。COMPLETED:payout 已成功处理,资金已转出。
READY_TO_SEND, PENDING, REJECTED, FAILED, COMPLETED 该 payout 的创建时间。
"2024-03-01T00:00:00+08:00"
该 payout 的更新时间。
"2024-03-01T00:00:00+08:00"
该 payout 的完成时间。
"2024-03-01T00:00:00+08:00"
需要指定支付方式,以确保针对该支付方式采集并校验准确的银行信息。
LOCAL:通过本地清算系统的境内支付网络处理的付款。SWIFT:通过 SWIFT 网络处理的跨境国际付款。
LOCAL, SWIFT "LOCAL"
与该 payout 关联的付款人信息。
Show child attributes
Show child attributes
Show child attributes
Show child attributes
失败 payout 中待退回的金额。
"1000.00"
该 payout 失败的原因。
""
该 payout 的换汇详情。 仅在跨币种 payout 场景下需要。
Show child attributes
Show child attributes

