Retrieve Cardholder

curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{id} \
  --header 'x-auth-token: <api-key>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{id}")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{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

{
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "email": "demo@example.com",
  "number_of_cards": 1,
  "first_name": "Emily",
  "last_name": "Toy",
  "create_time": "2024-05-09 15:52:23",
  "cardholder_status": "SUCCESS",
  "date_of_birth": "1990-01-01",
  "country_code": "SG",
  "phone_number": "86683306",
  "gender": "MALE",
  "nationality": "SG",
  "residential_address": {
    "country": "SG",
    "city": "Singapore",
    "line1": "9 N Buona Vista Dr",
    "state": "Singapore",
    "district": "Buona Vista",
    "line2": "THE METROPOLIS",
    "line_en": "9 N Buona Vista Dr, THE METROPOLIS",
    "postal_code": "138666"
  },
  "review_status": "SUCCESS",
  "idv_verification_url": "https://idv.sumsub.com/verify/abc123",
  "idv_url_expires_at": "2026-04-10T10:00:00+08:00"
}

GET

issuing

cardholders

{id}

Retrieve Cardholder

curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{id} \
  --header 'x-auth-token: <api-key>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{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/issuing/cardholders/{id}")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders/{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

{
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "email": "demo@example.com",
  "number_of_cards": 1,
  "first_name": "Emily",
  "last_name": "Toy",
  "create_time": "2024-05-09 15:52:23",
  "cardholder_status": "SUCCESS",
  "date_of_birth": "1990-01-01",
  "country_code": "SG",
  "phone_number": "86683306",
  "gender": "MALE",
  "nationality": "SG",
  "residential_address": {
    "country": "SG",
    "city": "Singapore",
    "line1": "9 N Buona Vista Dr",
    "state": "Singapore",
    "district": "Buona Vista",
    "line2": "THE METROPOLIS",
    "line_en": "9 N Buona Vista Dr, THE METROPOLIS",
    "postal_code": "138666"
  },
  "review_status": "SUCCESS",
  "idv_verification_url": "https://idv.sumsub.com/verify/abc123",
  "idv_url_expires_at": "2026-04-10T10:00:00+08:00"
}

授权

x-auth-token

string

header

必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of

string

指定代表哪个子账户发起请求。应设置为 account_id，该值可通过 List Connected Accounts 接口获取。若省略或为空，则请求以主账户身份执行。更多信息参见关联账户。

路径参数

string<uuid>

必填

资源的全局唯一标识符（UUID v4）。

示例:

"71fdb0fe-9682-457a-9361-e8868694f12f"

响应

200 - application/json

成功获取持卡人。

cardholder_id

string<uuid>

持卡人的唯一标识符。

示例:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

string

持卡人的电子邮箱地址。

示例:

"demo@example.com"

number_of_cards

integer

与持卡人关联的卡片总数，包含所有状态。

示例:

1

first_name

string

该持卡人的名字。激活卡片前必填。此字段不能包含任何数字、特殊字符（句点、逗号、连字符、空格和撇号除外）或非拉丁字母。

示例:

"Emily"

last_name

string

该持卡人的姓氏。激活卡片前必填。此字段不能包含任何数字、特殊字符（句点、逗号、连字符、空格和撇号除外）或非拉丁字母。

示例:

"Toy"

create_time

string

对象的创建时间。

示例:

"2024-05-09 15:52:23"

cardholder_status

enum<string>

默认值:SUCCESS

持卡人的状态。

可用选项:

FAILED,

PENDING,

SUCCESS,

INCOMPLETE

date_of_birth

string

持卡人的出生日期，格式为 yyyy-mm-dd。

示例:

"1990-01-01"

country_code

string

两位国家代码 ISO 3166-1 alpha-2。

Maximum string length: 2

示例:

"SG"

phone_number

string

持卡人的电话号码。

长度校验详情参见电话号码校验规则。

示例:

"86683306"

gender

enum<string>

持卡人的性别。

MALE - 男。
FEMALE - 女。

可用选项:

MALE,

FEMALE

示例:

"MALE"

nationality

string

持卡人的国籍，采用 ISO 3166-1 alpha-2 格式。STANDARD 和 ENHANCED KYC 等级必填。

Required string length: 2

示例:

"SG"

residential_address

object

持卡人的居住地址。

所有字段只接受字母（A-Z、a-z）、数字（0-9）、空格，以及以下标点：, . ' / # ( ) - &。包含其他任何字符的请求都会被拒绝——请修正后重新提交。为空的可选字段不做校验。

Show child attributes

review_status

enum<string>

持卡人的审核状态。

可用选项:

SUCCESS,

FAILED,

PENDING

示例:

"SUCCESS"

idv_status

enum<string>

IDV 验证状态。在适用时返回。

PENDING - IDV 待处理。
PASSED - IDV 通过。
FAILED - IDV 失败。

可用选项:

PENDING,

PASSED,

FAILED

idv_verification_url

string

IDV 验证 URL。在适用时返回。

示例:

"https://idv.sumsub.com/verify/abc123"

idv_url_expires_at

string

IDV 验证 URL 的过期时间，RFC 3339 格式。

示例:

"2026-04-10T10:00:00+08:00"

Create cardholder Update cardholder