> ## Documentation Index
> Fetch the complete documentation index at: https://docs-payment-merchant.keysecure.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取持卡人列表

查询指定时间范围内的持卡人列表，支持按持卡人单号、商户侧唯一单号筛选，并支持分页。

## 请求头

<ParamField header="Api-Key" type="string" required placeholder="your_api_key">
  apiKey（商户凭证，与 IP 白名单绑定）
</ParamField>

<ParamField header="Timestamp" type="string" required>
  Unix 时间戳（毫秒），与服务端偏差须在 60 秒内，且不接受未来时间戳
</ParamField>

<ParamField header="Access-Token" type="string" required placeholder="your_access_token">
  登录标识（除获取 Token 外必填）
</ParamField>

<ParamField header="Timezone" type="string" default="UTC+8">
  时区，影响 `start_time` / `end_time` 的日界计算，默认 UTC+8
</ParamField>

<ParamField header="Content-Type" type="string" default="application/json">
  固定为 `application/json`
</ParamField>

## 请求体

<ParamField body="cardholder_no" type="string">
  持卡人单号
</ParamField>

<ParamField body="cardholder_unique_no" type="string">
  商户侧持卡人唯一单号
</ParamField>

<ParamField body="start_time" type="string" required>
  开始时间（格式：`yyyy-MM-dd` 或 `yyyy-MM-dd HH:mm:ss`）
</ParamField>

<ParamField body="end_time" type="string" required>
  结束时间（同上；间隔 ≤90 天）
</ParamField>

<ParamField body="page" type="number" default="0">
  查询页码，默认 `0`
</ParamField>

<ParamField body="size" type="number" default="10">
  查询条数，默认 `10`（最多查询 100 条）
</ParamField>

## 返回参数

<ResponseField name="code" type="number">
  响应状态码，`0` 表示成功
</ResponseField>

<ResponseField name="msg" type="string">
  响应消息
</ResponseField>

<ResponseField name="data" type="object">
  返回数据

  <Expandable title="data">
    <ResponseField name="list" type="object[]">
      持卡人列表

      <Expandable title="list">
        <ResponseField name="cardholder_no" type="string">
          持卡人单号
        </ResponseField>

        <ResponseField name="cardholder_unique_no" type="string">
          商户侧持卡人唯一单号
        </ResponseField>

        <ResponseField name="email" type="string">
          邮箱
        </ResponseField>

        <ResponseField name="fail_reason" type="string">
          失败原因（认证失败时有值）
        </ResponseField>

        <ResponseField name="status" type="string">
          状态，见 【附录-常量表】持卡人状态
        </ResponseField>

        <ResponseField name="time" type="number">
          创建时间（Unix 毫秒）
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash Request theme={null}
  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
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "code": 0,
    "msg": "Success",
    "data": {
      "list": [
        {
          "cardholder_no": "",
          "cardholder_unique_no": "",
          "email": "",
          "fail_reason": "",
          "status": "",
          "time": 1716307200000
        }
      ]
    }
  }
  ```
</ResponseExample>