Update Beneficiary
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Updated 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}"
payload = {
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Updated 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
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({
entity_type: 'COMPANY',
company_name: 'UQPAY PTE. LTD.',
payment_method: 'SWIFT',
nickname: 'Updated 452d7f6f',
email: 'contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com',
bank_details: {
bank_name: 'GREEN LINK DIGITAL BANK',
bank_address: 'MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE',
bank_country_code: 'SG',
account_holder: 'UQPAY PTE. LTD.',
account_currency_code: 'SGD',
account_number: '11020075767',
clearing_system: 'SWIFT',
swift_code: 'GLDTSGSGXXX'
},
address: {
country: 'SG',
city: 'Singapore',
state: 'Singapore',
street_address: 'Sandbox Contract Test',
postal_code: 18989
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{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/beneficiaries/{id}",
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([
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY PTE. LTD.',
'payment_method' => 'SWIFT',
'nickname' => 'Updated 452d7f6f',
'email' => 'contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com',
'bank_details' => [
'bank_name' => 'GREEN LINK DIGITAL BANK',
'bank_address' => 'MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE',
'bank_country_code' => 'SG',
'account_holder' => 'UQPAY PTE. LTD.',
'account_currency_code' => 'SGD',
'account_number' => '11020075767',
'clearing_system' => 'SWIFT',
'swift_code' => 'GLDTSGSGXXX'
],
'address' => [
'country' => 'SG',
'city' => 'Singapore',
'state' => 'Singapore',
'street_address' => 'Sandbox Contract Test',
'postal_code' => 18989
]
]),
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/beneficiaries/{id}"
payload := strings.NewReader("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\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/beneficiaries/{id}")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}")
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 \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\n }\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_id": "caf351ff-be40-4caa-9288-133ba6d6d4b1",
"short_reference_id": "BF260910-E9MJ2KHL"
}Beneficiaries
Update Beneficiary
更新已保存的收款人信息，供后续出款使用。
通过 id 指定受益人，并提供其支付方式要求的字段。卡受益人必须提交完整的卡受益人对象，不支持部分更新。受益人实体类型不能更改。
POST
/
v1
/
beneficiaries
/
{id}
Update Beneficiary
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Updated 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}"
payload = {
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Updated 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
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({
entity_type: 'COMPANY',
company_name: 'UQPAY PTE. LTD.',
payment_method: 'SWIFT',
nickname: 'Updated 452d7f6f',
email: 'contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com',
bank_details: {
bank_name: 'GREEN LINK DIGITAL BANK',
bank_address: 'MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE',
bank_country_code: 'SG',
account_holder: 'UQPAY PTE. LTD.',
account_currency_code: 'SGD',
account_number: '11020075767',
clearing_system: 'SWIFT',
swift_code: 'GLDTSGSGXXX'
},
address: {
country: 'SG',
city: 'Singapore',
state: 'Singapore',
street_address: 'Sandbox Contract Test',
postal_code: 18989
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{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/beneficiaries/{id}",
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([
'entity_type' => 'COMPANY',
'company_name' => 'UQPAY PTE. LTD.',
'payment_method' => 'SWIFT',
'nickname' => 'Updated 452d7f6f',
'email' => 'contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com',
'bank_details' => [
'bank_name' => 'GREEN LINK DIGITAL BANK',
'bank_address' => 'MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE',
'bank_country_code' => 'SG',
'account_holder' => 'UQPAY PTE. LTD.',
'account_currency_code' => 'SGD',
'account_number' => '11020075767',
'clearing_system' => 'SWIFT',
'swift_code' => 'GLDTSGSGXXX'
],
'address' => [
'country' => 'SG',
'city' => 'Singapore',
'state' => 'Singapore',
'street_address' => 'Sandbox Contract Test',
'postal_code' => 18989
]
]),
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/beneficiaries/{id}"
payload := strings.NewReader("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\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/beneficiaries/{id}")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}")
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 \"entity_type\": \"COMPANY\",\n \"company_name\": \"UQPAY PTE. LTD.\",\n \"payment_method\": \"SWIFT\",\n \"nickname\": \"Updated 452d7f6f\",\n \"email\": \"contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com\",\n \"bank_details\": {\n \"bank_name\": \"GREEN LINK DIGITAL BANK\",\n \"bank_address\": \"MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE\",\n \"bank_country_code\": \"SG\",\n \"account_holder\": \"UQPAY PTE. LTD.\",\n \"account_currency_code\": \"SGD\",\n \"account_number\": \"11020075767\",\n \"clearing_system\": \"SWIFT\",\n \"swift_code\": \"GLDTSGSGXXX\"\n },\n \"address\": {\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"state\": \"Singapore\",\n \"street_address\": \"Sandbox Contract Test\",\n \"postal_code\": 18989\n }\n}"
response = http.request(request)
puts response.read_body{
"beneficiary_id": "caf351ff-be40-4caa-9288-133ba6d6d4b1",
"short_reference_id": "BF260910-E9MJ2KHL"
}授权
由 UQPAY 提供的登录 API Token。
请求头
用于保持操作幂等性的唯一标识符（UUID），确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败时保持数据一致性。
路径参数
资源的通用唯一标识符（UUID v4）。
示例:
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
请求体
application/json
- Company bank beneficiary
- Individual bank beneficiary
- Company Mastercard beneficiary
- Individual Mastercard beneficiary
受益人实体的类型。
示例:
"COMPANY"
受益人的公司名称，仅当 entity_type 为 COMPANY 时存在。
-
当
payment_method = SWIFT时：- 仅可包含英文字母、数字、特殊字符（半角格式）和空格。
- 允许的特殊字符：
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
当
payment_method = LOCAL时：- 不应用严格的校验规则，支持本地语言字符。
-
当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段 -
当
bank_country_code = CN且account_currency_code = CNH且payment_method = LOCAL且entity_type = COMPANY时，支持中文字符和中文括号（）。
Maximum string length:
120Pattern:
^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$示例:
"UQPAY TECHNOLOGY SG PTE LTD"
银行受益人的支付方式。
可用选项:
LOCAL, SWIFT 示例:
"LOCAL"
Show child attributes
Show child attributes
受益人的地址。
- 当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段
Show child attributes
Show child attributes
受益人的电子邮箱地址。
示例:
"example@uqpay.com"
受益人昵称。
Maximum string length:
120示例:
"John Doe"
受益人的附加信息。
Show child attributes
Show child attributes