Create Payout
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"currency": "USD",
"amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_reference": "026073150",
"fee_paid_by": "SHARED",
"payout_date": "2024-03-01",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"payout_currency": "SGD",
"payout_amount": 100,
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"beneficiary": {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"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"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"is_payer": "N",
"payer_id": "d36384c8-5df1-4ede-b054-804578601ae7",
"documentation": [
{
"file": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
]
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts"
payload = {
"currency": "USD",
"amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_reference": "026073150",
"fee_paid_by": "SHARED",
"payout_date": "2024-03-01",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"payout_currency": "SGD",
"payout_amount": 100,
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"beneficiary": {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"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"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"is_payer": "N",
"payer_id": "d36384c8-5df1-4ede-b054-804578601ae7",
"documentation": [
{
"file": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
]
}
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({
currency: 'USD',
amount: '1000.00',
purpose_code: 'AUDIO_VISUAL_SERVICES',
payout_reference: '026073150',
fee_paid_by: 'SHARED',
payout_date: '2024-03-01',
quote_id: '784832f7-1f8a-4b08-ac2a-8719b5b2a590',
payout_currency: 'SGD',
payout_amount: 100,
beneficiary_id: 'b3d9d2d5-4c12-4946-a09d-953e82sed2b0',
beneficiary: {
entity_type: 'COMPANY',
company_name: 'UQPAY TECHNOLOGY SG PTE LTD',
payment_method: 'LOCAL',
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'
},
email: 'example@uqpay.com',
nickname: 'John Doe',
additional_info: {
organization_code: '91210106MA0P46BWXY',
proxy_id: '<string>',
id_type: 'PASSPORT',
id_number: 'AB1234567',
tax_id: '123456789',
msisdn: '+65111111'
}
},
is_payer: 'N',
payer_id: 'd36384c8-5df1-4ede-b054-804578601ae7',
documentation: [
{
file: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
}
]
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => 'USD',
'amount' => '1000.00',
'purpose_code' => 'AUDIO_VISUAL_SERVICES',
'payout_reference' => '026073150',
'fee_paid_by' => 'SHARED',
'payout_date' => '2024-03-01',
'quote_id' => '784832f7-1f8a-4b08-ac2a-8719b5b2a590',
'payout_currency' => 'SGD',
'payout_amount' => 100,
'beneficiary_id' => 'b3d9d2d5-4c12-4946-a09d-953e82sed2b0',
'beneficiary' => [
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY TECHNOLOGY SG PTE LTD',
'payment_method' => 'LOCAL',
'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'
],
'email' => 'example@uqpay.com',
'nickname' => 'John Doe',
'additional_info' => [
'organization_code' => '91210106MA0P46BWXY',
'proxy_id' => '<string>',
'id_type' => 'PASSPORT',
'id_number' => 'AB1234567',
'tax_id' => '123456789',
'msisdn' => '+65111111'
]
],
'is_payer' => 'N',
'payer_id' => 'd36384c8-5df1-4ede-b054-804578601ae7',
'documentation' => [
[
'file' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
]
]
]),
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/v1/payouts"
payload := strings.NewReader("{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\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/v1/payouts")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\n}")
.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::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM"
}Payouts
Create Payout
向受益人创建一笔新的 payout。依托 SWIFT 与本地支付通道的能力支持，你可以更快、更具成本效益地向海外企业账户、供应商和员工发起国际付款。
此 API 支持多种付款模式，包括标准 payout 和代付（POBO），实现灵活高效的资金管理。此外，你还可以选择费用承担方式，以控制交易手续费的处理方式。
使用说明
-
支持以 30+ 种币种向 180 多个国家/地区发起 payout，包括向中国大陆发起的 CNY payout。
-
用于 POBO 交易的子账户必须提前创建，且账户状态必须为已激活。
-
要启用 POBO 模式，请在请求头中加入
x-on-behalf-of参数，并指定用于该 payout 的子账户 ID。受益人将看到自定义的付款人名称，而非实际付款实体。 -
用户可通过
fee_paid_by参数选择费用承担类型，以确定由谁承担交易费用：SHARED—— 交易手续费由付款人与收款方分担；付款人承担汇出行费用，收款方承担收款行费用。OURS—— 所有交易手续费（含中间行费用）均由付款人承担。
-
有两种方式指定受益人：
- 使用
beneficiary_id—— 如果受益人已创建，提供beneficiary_id以引用现有受益人。 - 提供完整的受益人信息 —— 如果受益人此前未创建，在请求中包含完整的受益人信息。此时不要传入
beneficiary_id。
注意：提供完整信息时会创建一个受益人。后续向同一受益人发起的任何 payout，都应传入对应的
beneficiary_id，而非完整的受益人信息。 - 使用
-
如果你打算发起跨币种 payout，可参阅跨币种指南了解详情与示例。
POST
/
v1
/
payouts
Create Payout
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"currency": "USD",
"amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_reference": "026073150",
"fee_paid_by": "SHARED",
"payout_date": "2024-03-01",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"payout_currency": "SGD",
"payout_amount": 100,
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"beneficiary": {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"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"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"is_payer": "N",
"payer_id": "d36384c8-5df1-4ede-b054-804578601ae7",
"documentation": [
{
"file": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
]
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/payouts"
payload = {
"currency": "USD",
"amount": "1000.00",
"purpose_code": "AUDIO_VISUAL_SERVICES",
"payout_reference": "026073150",
"fee_paid_by": "SHARED",
"payout_date": "2024-03-01",
"quote_id": "784832f7-1f8a-4b08-ac2a-8719b5b2a590",
"payout_currency": "SGD",
"payout_amount": 100,
"beneficiary_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"beneficiary": {
"entity_type": "COMPANY",
"company_name": "UQPAY TECHNOLOGY SG PTE LTD",
"payment_method": "LOCAL",
"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"
},
"email": "example@uqpay.com",
"nickname": "John Doe",
"additional_info": {
"organization_code": "91210106MA0P46BWXY",
"proxy_id": "<string>",
"id_type": "PASSPORT",
"id_number": "AB1234567",
"tax_id": "123456789",
"msisdn": "+65111111"
}
},
"is_payer": "N",
"payer_id": "d36384c8-5df1-4ede-b054-804578601ae7",
"documentation": [
{
"file": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
]
}
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({
currency: 'USD',
amount: '1000.00',
purpose_code: 'AUDIO_VISUAL_SERVICES',
payout_reference: '026073150',
fee_paid_by: 'SHARED',
payout_date: '2024-03-01',
quote_id: '784832f7-1f8a-4b08-ac2a-8719b5b2a590',
payout_currency: 'SGD',
payout_amount: 100,
beneficiary_id: 'b3d9d2d5-4c12-4946-a09d-953e82sed2b0',
beneficiary: {
entity_type: 'COMPANY',
company_name: 'UQPAY TECHNOLOGY SG PTE LTD',
payment_method: 'LOCAL',
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'
},
email: 'example@uqpay.com',
nickname: 'John Doe',
additional_info: {
organization_code: '91210106MA0P46BWXY',
proxy_id: '<string>',
id_type: 'PASSPORT',
id_number: 'AB1234567',
tax_id: '123456789',
msisdn: '+65111111'
}
},
is_payer: 'N',
payer_id: 'd36384c8-5df1-4ede-b054-804578601ae7',
documentation: [
{
file: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
}
]
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'currency' => 'USD',
'amount' => '1000.00',
'purpose_code' => 'AUDIO_VISUAL_SERVICES',
'payout_reference' => '026073150',
'fee_paid_by' => 'SHARED',
'payout_date' => '2024-03-01',
'quote_id' => '784832f7-1f8a-4b08-ac2a-8719b5b2a590',
'payout_currency' => 'SGD',
'payout_amount' => 100,
'beneficiary_id' => 'b3d9d2d5-4c12-4946-a09d-953e82sed2b0',
'beneficiary' => [
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY TECHNOLOGY SG PTE LTD',
'payment_method' => 'LOCAL',
'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'
],
'email' => 'example@uqpay.com',
'nickname' => 'John Doe',
'additional_info' => [
'organization_code' => '91210106MA0P46BWXY',
'proxy_id' => '<string>',
'id_type' => 'PASSPORT',
'id_number' => 'AB1234567',
'tax_id' => '123456789',
'msisdn' => '+65111111'
]
],
'is_payer' => 'N',
'payer_id' => 'd36384c8-5df1-4ede-b054-804578601ae7',
'documentation' => [
[
'file' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
]
]
]),
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/v1/payouts"
payload := strings.NewReader("{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\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/v1/payouts")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\n}")
.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::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"USD\",\n \"amount\": \"1000.00\",\n \"purpose_code\": \"AUDIO_VISUAL_SERVICES\",\n \"payout_reference\": \"026073150\",\n \"fee_paid_by\": \"SHARED\",\n \"payout_date\": \"2024-03-01\",\n \"quote_id\": \"784832f7-1f8a-4b08-ac2a-8719b5b2a590\",\n \"payout_currency\": \"SGD\",\n \"payout_amount\": 100,\n \"beneficiary_id\": \"b3d9d2d5-4c12-4946-a09d-953e82sed2b0\",\n \"beneficiary\": {\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY TECHNOLOGY SG PTE LTD\",\n \"payment_method\": \"LOCAL\",\n \"bank_details\": {\n \"bank_name\": \"Bank of America\",\n \"bank_address\": \"123 Main St\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"John Doe\",\n \"account_currency_code\": \"USD\",\n \"swift_code\": \"WELGBE22\",\n \"clearing_system\": \"GIRO\",\n \"account_number\": \"12345678\",\n \"iban\": \"GB82 WEST 1234 5698 7654 32\",\n \"routing_code_type1\": \"aba\",\n \"routing_code_value1\": \"123456789\",\n \"routing_code_type2\": \"ach\",\n \"routing_code_value2\": \"123456789\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"street_address\": \"123 Main St\",\n \"postal_code\": \"123456\",\n \"state\": \"CA\",\n \"nationality\": \"SG\"\n },\n \"email\": \"example@uqpay.com\",\n \"nickname\": \"John Doe\",\n \"additional_info\": {\n \"organization_code\": \"91210106MA0P46BWXY\",\n \"proxy_id\": \"<string>\",\n \"id_type\": \"PASSPORT\",\n \"id_number\": \"AB1234567\",\n \"tax_id\": \"123456789\",\n \"msisdn\": \"+65111111\"\n }\n },\n \"is_payer\": \"N\",\n \"payer_id\": \"d36384c8-5df1-4ede-b054-804578601ae7\",\n \"documentation\": [\n {\n \"file\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"payout_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
"short_reference_id": "P220406-LLCVLRM"
}授权
由 UQPay 提供的登录 API Token。
请求头
用于保持操作幂等性的唯一标识符（UUID），确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败时保持数据一致性。
请求体
application/json
付款人将汇出的币种。
Required string length:
3示例:
"USD"
付款人将汇出的金额，以 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"
显示在受益人银行交易记录中的银行付款附言。会发送给收款方（如 For Further Credit、For Benefit of 或自定义信息）。在控制台中亦称 Payment reference。
- SWIFT 付款：必须符合正则
/^[a-zA-Z0-9/-?:().'+, ]+$/。 允许的字符：英文字母、数字、空格，以及以下特殊符号：- / ? : ( ) . ' + ,。 - LOCAL 付款：当
payment_method = LOCAL且account_currency_code不是 CNH 或 SGD 时，不应用输入格式校验。
Maximum string length:
100示例:
"026073150"
付款手续费的承担类型。仅在 payment_method = SWIFT 时生效并必填。
SHARED：交易手续费由付款人与收款方分担；付款人承担汇出行费用，收款方承担收款行费用。当付款人为企业且付款人所在国家/地区为 SG、VN、HK 或 AU 之一时，SWIFT payout 可使用此项。OURS：所有交易手续费（含中间行费用）均由付款人承担。
可用选项:
SHARED, OURS 示例:
"SHARED"
系统尝试向受益人提交付款的日期。
示例:
"2024-03-01"
受益人将收到的金额，以 payout_currency 计。
当指定 quote_id 时必填。必须与创建报价响应中返回的 buy_amount 一致。
示例:
100
受益人的通用唯一标识符（UUID v4）。可用它替代 beneficiary 部分；如果已提供 beneficiary 各字段，则此项应留空，反之亦然。
示例:
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
payout 请求中受益人的信息。如果 payout 请求中提供了 beneficiary_id，则 beneficiary 应留空。
- COMPANY
- INDIVIDUAL
Show child attributes
Show child attributes
重要提示： 此字段计划在下一版本中弃用。建议在新开发中避免使用此字段。 当前用户是否为付款人。 取值为 Y 或 N
示例:
"N"
重要提示：
此字段计划在下一版本中弃用。建议在新开发中避免使用此字段。
付款人的唯一标识符。如果 is_payer 为 Y，payer_id 为空；如果 is_payer 为 N，则通过查询付款人列表接口获取 payer_id。
示例:
"d36384c8-5df1-4ede-b054-804578601ae7"
与该 payout 相关的证明文件。
- 一般情况：可选字段，用于附加与该 payout 相关的文件。
- 必填情况：当
beneficiary.bank_details.account_currency_code = INR且clearing_system = IFSC时，必须通过documentation字段上传发票文件。
Show child attributes
Show child attributes
响应
200 - application/json
Payout 创建成功。
该 payout 的唯一标识符。
示例:
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
系统生成的用于标识该实体的编号。
示例:
"P220406-LLCVLRM"
该 payout 的状态。
READY_TO_SEND：payout 已通过校验，准备处理。PENDING：payout 正在由系统处理中。REJECTED：payout 因未满足校验或合规要求而被拒绝。FAILED：payout 处理过程中发生错误，无法完成。COMPLETED：payout 已成功处理，资金已转出。
可用选项:
READY_TO_SEND, PENDING, REJECTED, FAILED, COMPLETED ⌘I