curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{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/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 => "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/beneficiaries/{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/beneficiaries/{id}")
.header("x-auth-token", "<api-key>")
.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::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
}Retrieve Beneficiary
通过指定 beneficiary_id 获取某个特定受益人。
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{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/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 => "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/beneficiaries/{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/beneficiaries/{id}")
.header("x-auth-token", "<api-key>")
.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::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}
}授权
由 UQPAY 提供的登录 API Token。
路径参数
资源的通用唯一标识符(UUID v4)。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
响应
OK —— 成功获取受益人。
受益人的通用唯一标识符(UUID v4)。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
系统生成的用于标识该实体的编号。
"P220406-LLCVLRM"
指定用于筛选的受益人实体类型。有效值为:
COMPANY:企业实体INDIVIDUAL:个人账户
COMPANY, INDIVIDUAL 需要指定支付方式,以确保针对该支付方式采集并校验准确的银行信息。
LOCAL:通过本地清算系统的境内支付网络处理的付款。SWIFT:通过 SWIFT 网络处理的跨境国际付款。
LOCAL, SWIFT "LOCAL"
受益人的电子邮箱地址。
"example@uqpay.com"
受益人的状态。
ACTIVE:受益人已完成验证,可以收款。PENDING:受益人正在验证过程中,暂时无法收款。
ACTIVE, PENDING "ACTIVE"
受益人的摘要。
"John Doe"
Show child attributes
Show child attributes
受益人记录中存储的地址。
Show child attributes
Show child attributes
受益人昵称。
120"John Doe"
受益人的公司名称,仅当 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时,支持中文字符和中文括号()。
120^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$"UQPAY TECHNOLOGY SG PTE LTD"
受益人的名字,仅当 entity_type 为 INDIVIDUAL 时存在。
-
当
payment_method = SWIFT时:- 仅可包含英文字母、数字、特殊字符(半角格式)和空格。
- 允许的特殊字符:
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
当
payment_method = LOCAL时:- 不应用严格的校验规则,支持本地语言字符。
-
当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段
45^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$"John"
受益人的姓氏,仅当 entity_type 为 INDIVIDUAL 时存在。
-
当
payment_method = SWIFT时:- 仅可包含英文字母、数字、特殊字符(半角格式)和空格。
- 允许的特殊字符:
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
当
payment_method = LOCAL时:- 不应用严格的校验规则,支持本地语言字符。
-
当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段
45^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$"Doe"
个人受益人的身份证件号码。 当受益人为中国大陆居民且满足以下条件时必填:
bank_details.account_currency_code为CNHpayment_method为LOCAL
"110101199001011234"
受益人的创建时间。
"2024-03-01T00:00:00+08:00"
受益人的更新时间。
"2024-03-01T00:00:00+08:00"
受益人的附加信息。
Show child attributes
Show child attributes

