List Beneficiaries
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries"
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', 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",
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"
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")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries")
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{
"data": [
{
"additional_info": {
"id_number": "",
"id_type": "",
"msisdn": "",
"organization_code": "",
"proxy_id": "",
"tax_id": ""
},
"address": {
"city": "",
"country": "SG",
"nationality": "",
"postal_code": "",
"state": "",
"street_address": ""
},
"bank_details": {
"account_currency_code": "SGD",
"account_holder": "UQPAY PTE. LTD.",
"account_number": "11020075767",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"bank_name": "GREEN LINK DIGITAL BANK",
"clearing_system": "FAST",
"iban": "",
"routing_code_type1": "",
"routing_code_type2": "",
"routing_code_value1": "",
"routing_code_value2": "",
"swift_code": "GLDTSGSGXXX"
},
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"beneficiary_status": "ACTIVE",
"company_name": "UQPAY PTE. LTD.",
"create_time": "2026-09-11T17:10:57+08:00",
"email": "",
"entity_type": "COMPANY",
"first_name": "",
"id_number": "",
"last_name": "",
"nickname": "sr08-d4dc6ae9",
"payment_method": "LOCAL",
"short_reference_id": "BF260911-OGJMC98L",
"summary": "",
"update_time": "0001-01-01T00:00:00Z"
}
],
"total_items": 1,
"total_pages": 1
}Beneficiaries
List Beneficiaries
分页查询已保存的受益人。按实体类型、昵称、币种、公司名称或支付方式筛选,查找出款所需的受益人。
GET
/
v1
/
beneficiaries
List Beneficiaries
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/beneficiaries"
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', 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",
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"
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")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/beneficiaries")
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{
"data": [
{
"additional_info": {
"id_number": "",
"id_type": "",
"msisdn": "",
"organization_code": "",
"proxy_id": "",
"tax_id": ""
},
"address": {
"city": "",
"country": "SG",
"nationality": "",
"postal_code": "",
"state": "",
"street_address": ""
},
"bank_details": {
"account_currency_code": "SGD",
"account_holder": "UQPAY PTE. LTD.",
"account_number": "11020075767",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"bank_name": "GREEN LINK DIGITAL BANK",
"clearing_system": "FAST",
"iban": "",
"routing_code_type1": "",
"routing_code_type2": "",
"routing_code_value1": "",
"routing_code_value2": "",
"swift_code": "GLDTSGSGXXX"
},
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"beneficiary_status": "ACTIVE",
"company_name": "UQPAY PTE. LTD.",
"create_time": "2026-09-11T17:10:57+08:00",
"email": "",
"entity_type": "COMPANY",
"first_name": "",
"id_number": "",
"last_name": "",
"nickname": "sr08-d4dc6ae9",
"payment_method": "LOCAL",
"short_reference_id": "BF260911-OGJMC98L",
"summary": "",
"update_time": "0001-01-01T00:00:00Z"
}
],
"total_items": 1,
"total_pages": 1
}授权
由 UQPAY 提供的登录 API Token。
查询参数
每页返回的最大条目数。必须在 1 到 100 之间(含)。
必填范围:
1 <= x <= 100示例:
10
用于获取特定一组条目的页码。必须 大于等于 1。
必填范围:
x >= 1示例:
1
指定用于筛选的受益人实体类型。有效值为:
COMPANY:企业实体INDIVIDUAL:个人账户
可用选项:
COMPANY, INDIVIDUAL 示例:
"COMPANY"
受益人昵称 受益人昵称。
Maximum string length:
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时,支持中文字符和中文括号()。
Maximum string length:
120Pattern:
^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$示例:
"UQPAY TECHNOLOGY SG PTE LTD"
按受益人支付方式筛选。
可用选项:
LOCAL, SWIFT, CARD 响应
200 - application/json
OK —— 成功获取受益人列表。
可用条目的总页数。
示例:
10
可用条目的总数。
示例:
105
data
(LOCAL SGD beneficiary with a bank in SG · object | Beneficiary with a complete address · object | Mastercard beneficiary · object)[]
- LOCAL SGD beneficiary with a bank in SG
- Beneficiary with a complete address
- Mastercard beneficiary
Show child attributes
Show child attributes

