Skip to main content
POST
/
open-api
/
v1
/
cardholder
/
list
curl --request POST \
  --url https://sandbox-openplatform.keysecure.io/open-api/v1/cardholder/list \
  --header 'Content-Type: application/json' \
  --header 'Api-Key: your_api_key' \
  --header 'Timestamp: 1716307200000' \
  --header 'Access-Token: your_access_token' \
  --header 'Timezone: UTC+8' \
  --data '{
    "cardholder_no": "",
    "cardholder_unique_no": "",
    "start_time": "2026-01-01",
    "end_time": "2026-03-31",
    "page": 0,
    "size": 10
  }'

{
  "code": 0,
  "msg": "Success",
  "data": {
    "list": [
      {
        "cardholder_no": "",
        "cardholder_unique_no": "",
        "email": "",
        "fail_reason": "",
        "status": "",
        "time": 1716307200000
      }
    ]
  }
}
Queries the cardholder list within a specified time range, supporting filtering by cardholder order number and merchant-side unique number, as well as pagination.

​
Request Headers

​
Api-Key
string
required
apiKey (merchant credential, bound to IP whitelist)
​
Timestamp
string
required
Unix timestamp in milliseconds. The deviation from the server time must be within 60 seconds, and future timestamps are not accepted.
​
Access-Token
string
required
Login token (required for all interfaces except Get Token).
​
Timezone
string
default:"UTC+8"
Timezone, affects the day boundary calculation for start_time / end_time. Defaults to UTC+8.
​
Content-Type
string
default:"application/json"
Fixed to application/json

​
Request Body

​
cardholder_no
string
Cardholder order number.
​
cardholder_unique_no
string
Merchant-side unique cardholder number.
​
start_time
string
required
Start time (format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss).
​
end_time
string
required
End time (same format as above; interval ≤ 90 days).
​
page
number
default:"0"
Query page number. Defaults to 0.
​
size
number
default:"10"
Number of records per page. Defaults to 10 (max 100).

​
Response Parameters

​
code
number
Response status code. 0 indicates success.
​
msg
string
Response message.
​
data
object
Response data.
curl --request POST \
  --url https://sandbox-openplatform.keysecure.io/open-api/v1/cardholder/list \
  --header 'Content-Type: application/json' \
  --header 'Api-Key: your_api_key' \
  --header 'Timestamp: 1716307200000' \
  --header 'Access-Token: your_access_token' \
  --header 'Timezone: UTC+8' \
  --data '{
    "cardholder_no": "",
    "cardholder_unique_no": "",
    "start_time": "2026-01-01",
    "end_time": "2026-03-31",
    "page": 0,
    "size": 10
  }'

{
  "code": 0,
  "msg": "Success",
  "data": {
    "list": [
      {
        "cardholder_no": "",
        "cardholder_unique_no": "",
        "email": "",
        "fail_reason": "",
        "status": "",
        "time": 1716307200000
      }
    ]
  }
}