Create Payout
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"payout_currency": "SGD",
"payout_amount": "100.00",
"statement_descriptor": "UQPAY PAYOUT",
"internal_note": "Payment to supplier",
"payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create"
payload = {
"payout_currency": "SGD",
"payout_amount": "100.00",
"statement_descriptor": "UQPAY PAYOUT",
"internal_note": "Payment to supplier",
"payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payout_currency: 'SGD',
payout_amount: '100.00',
statement_descriptor: 'UQPAY PAYOUT',
internal_note: 'Payment to supplier',
payout_account_id: '18523f72-f4de-4f9c-bb8e-ec7d1c4f32be'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create', 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/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payout_currency' => 'SGD',
'payout_amount' => '100.00',
'statement_descriptor' => 'UQPAY PAYOUT',
'internal_note' => 'Payment to supplier',
'payout_account_id' => '18523f72-f4de-4f9c-bb8e-ec7d1c4f32be'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create"
payload := strings.NewReader("{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}"
response = http.request(request)
puts response.read_body{
"payout_id": "PO1968582687224500224",
"payout_currency": "SGD",
"payout_amount": "100.00",
"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
Create Payout
创建新的出款单
POST
/
v2
/
payment
/
payout
/
create
Create Payout
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"payout_currency": "SGD",
"payout_amount": "100.00",
"statement_descriptor": "UQPAY PAYOUT",
"internal_note": "Payment to supplier",
"payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create"
payload = {
"payout_currency": "SGD",
"payout_amount": "100.00",
"statement_descriptor": "UQPAY PAYOUT",
"internal_note": "Payment to supplier",
"payout_account_id": "18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payout_currency: 'SGD',
payout_amount: '100.00',
statement_descriptor: 'UQPAY PAYOUT',
internal_note: 'Payment to supplier',
payout_account_id: '18523f72-f4de-4f9c-bb8e-ec7d1c4f32be'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create', 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/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payout_currency' => 'SGD',
'payout_amount' => '100.00',
'statement_descriptor' => 'UQPAY PAYOUT',
'internal_note' => 'Payment to supplier',
'payout_account_id' => '18523f72-f4de-4f9c-bb8e-ec7d1c4f32be'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create"
payload := strings.NewReader("{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/payout/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_currency\": \"SGD\",\n \"payout_amount\": \"100.00\",\n \"statement_descriptor\": \"UQPAY PAYOUT\",\n \"internal_note\": \"Payment to supplier\",\n \"payout_account_id\": \"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be\"\n}"
response = http.request(request)
puts response.read_body{
"payout_id": "PO1968582687224500224",
"payout_currency": "SGD",
"payout_amount": "100.00",
"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),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。
请求体
application/json
三位币种代码
示例:
"SGD"
通过此次出款提取的金额。
示例:
"100.00"
向收款方银行展示的出款参考信息
Maximum string length:
15示例:
"UQPAY PAYOUT"
出款备注信息
示例:
"Payment to supplier"
通过内部转账接收出款资金的 UQPAY 账户 ID。长、短账户 ID 均可接受。
- 如省略,出款将发送至预先配置的外部银行账户(默认行为)。
- 如提供,出款将作为 UQPAY 内部转账处理至指定账户。请传入调用方的账户 ID。
示例:
"18523f72-f4de-4f9c-bb8e-ec7d1c4f32be"
响应
200 - application/json
成功创建出款
出款 UUID
示例:
"PO1968582687224500224"
三位币种代码
示例:
"SGD"
通过此次出款提取的金额。
示例:
"100.00"
向收款方银行展示的出款参考信息
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"
出款完成时间
示例:
""
⌘I

