curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/accounts/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/accounts/{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/accounts/{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/accounts/{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/accounts/{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/accounts/{id}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/accounts/{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{
"account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
"short_reference_id": "P220406-LLCVLRM",
"business_code": [
"BANKING"
],
"email": "example@company.com",
"account_name": "UQPAY PTE LTD.",
"country": "US",
"status": "PROCESSING",
"verification_status": "APPROVED",
"entity_type": "COMPANY",
"review_reason": "The account is not compliant with the company's policies.",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"business_details": {
"legal_entity_name_english": "UQPAY PTE LTD.",
"incorporation_date": "2013-04-15",
"registration_number": "201901754K",
"business_structure": "SOLE_PROPRIETOR",
"product_description": "Design and produce high-tech wireless headphones.",
"merchant_category_code": "5733",
"estimated_worker_count": "BS001",
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [
"PAYOUT"
],
"legal_entity_name": "ソフトバンクインターナショナル株式会社",
"identifier": {
"type": "VAT",
"number": "XXX-XX-XXXX"
},
"website_url": "https://yourcompany.com"
},
"registration_address": {
"city": "San Francisco",
"line1": "9 N Buona Vista Dr",
"postal_code": "94103",
"state": "CA",
"line2": "THE METROPOLIS"
},
"business_address": [
{
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
}
],
"representatives": [
{
"representative_id": "72970a7c-7921-431c-b95f-3438724ba16f",
"roles": "DIRECTOR",
"first_name": "Mock",
"last_name": "Toy",
"nationality": "SG",
"date_of_birth": "2024-01-28",
"identification": {
"type": "PASSPORT",
"id_number": "27738277K",
"documents": {
"front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
"back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
}
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"as_applicant": false,
"share_percentage": "20.01",
"other_doucments": [
{
"type": "PROOF_OF_ADDRESS",
"front": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
}
]
}
],
"documents": [
{
"type": "CERTIFICATE_OF_INCORPORATION",
"front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
"back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
}
],
"tos_acceptance": {
"ip": "127.0.0.1",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}Retrieve Account
获取账户的详细信息。
curl --request GET \
--url https://api-sandbox.uqpaytech.com/api/v1/accounts/{id} \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/accounts/{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/accounts/{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/accounts/{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/accounts/{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/accounts/{id}")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/accounts/{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{
"account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
"short_reference_id": "P220406-LLCVLRM",
"business_code": [
"BANKING"
],
"email": "example@company.com",
"account_name": "UQPAY PTE LTD.",
"country": "US",
"status": "PROCESSING",
"verification_status": "APPROVED",
"entity_type": "COMPANY",
"review_reason": "The account is not compliant with the company's policies.",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"business_details": {
"legal_entity_name_english": "UQPAY PTE LTD.",
"incorporation_date": "2013-04-15",
"registration_number": "201901754K",
"business_structure": "SOLE_PROPRIETOR",
"product_description": "Design and produce high-tech wireless headphones.",
"merchant_category_code": "5733",
"estimated_worker_count": "BS001",
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [
"PAYOUT"
],
"legal_entity_name": "ソフトバンクインターナショナル株式会社",
"identifier": {
"type": "VAT",
"number": "XXX-XX-XXXX"
},
"website_url": "https://yourcompany.com"
},
"registration_address": {
"city": "San Francisco",
"line1": "9 N Buona Vista Dr",
"postal_code": "94103",
"state": "CA",
"line2": "THE METROPOLIS"
},
"business_address": [
{
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
}
],
"representatives": [
{
"representative_id": "72970a7c-7921-431c-b95f-3438724ba16f",
"roles": "DIRECTOR",
"first_name": "Mock",
"last_name": "Toy",
"nationality": "SG",
"date_of_birth": "2024-01-28",
"identification": {
"type": "PASSPORT",
"id_number": "27738277K",
"documents": {
"front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
"back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
}
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"as_applicant": false,
"share_percentage": "20.01",
"other_doucments": [
{
"type": "PROOF_OF_ADDRESS",
"front": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
}
]
}
],
"documents": [
{
"type": "CERTIFICATE_OF_INCORPORATION",
"front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
"back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
}
],
"tos_acceptance": {
"ip": "127.0.0.1",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}授权
由 UQPAY 提供的登录 API Token。
路径参数
资源的全局唯一标识符(UUID v4)。
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
查询参数
业务类型代码。默认为 BANKING。
BANKING, ACQUIRING, ISSUING 响应
OK——成功获取账户详细信息。
- Company Account
- Individual Account
有关该公司或企业的信息。
账户的唯一标识符。
"f5bb6498-552e-40a5-b14b-616aa04ac1c1"
账户的短引用 ID。
"P220406-LLCVLRM"
该账户的业务类型。
BANKING, ACQUIRING, ISSUING, RAMP ["BANKING"]
账户的电子邮箱地址。
100"example@company.com"
该账户的客户名称。
"UQPAY PTE LTD."
账户的状态。为以下之一:
- ACTIVE - 账户已激活。
- PROCESSING - 账户当前正在审核和处理中。
- INACTIVE - 账户暂时未激活
- CLOSED - 账户已关闭。
"PROCESSING"
KYC/KYB 的状态。为以下之一:
- REJECT - 账户在身份验证过程中被拒绝。
- APPROVED - 账户已通过验证且处于激活状态。
- PENDING - 账户当前正在进行身份验证。
- EXPIRED - 验证已过期。
- RETURN - 账户已被退回以进行身份验证,需要重新上传。
Webhook 说明: 在 accountStatus webhook 通知中,这两个状态
分别以 REJECTED 和 RETURNED 下发(而非 REJECT / RETURN)。
其他所有值均相同。参见
账户状态 webhook。
APPROVED, PENDING, REJECT, EXPIRED, RETURN "APPROVED"
账户类型。 此字段为必填,且必须是以下之一:
COMPANY- 为从事商业活动而设立的实体。INDIVIDUAL- 来自业务场景的单一个人。目前仅适用于 Banking。
COMPANY, INDIVIDUAL 账户审核未通过时提供的原因。
"The account is not compliant with the company's policies."
Show child attributes
Show child attributes
该账户的企业信息。
Show child attributes
Show child attributes
公司的注册地址。
Show child attributes
Show child attributes
公司的经营地址。
Show child attributes
Show child attributes
有关该公司代表人的信息。
Show child attributes
Show child attributes
用于确认公司身份的文件。
Show child attributes
Show child attributes
有关该账户接受 UQPAY 服务协议的详细信息。此属性仅可针对 Custom 账户更新。
Show child attributes
Show child attributes

