> ## 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.

# Get Cardholder List

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

<ParamField header="Api-Key" type="string" required placeholder="your_api_key">
  apiKey (merchant credential, bound to IP whitelist)
</ParamField>

<ParamField header="Timestamp" type="string" required>
  Unix timestamp in milliseconds. The deviation from the server time must be within 60 seconds, and future timestamps are not accepted.
</ParamField>

<ParamField header="Access-Token" type="string" required placeholder="your_access_token">
  Login token (required for all interfaces except Get Token).
</ParamField>

<ParamField header="Timezone" type="string" default="UTC+8">
  Timezone, affects the day boundary calculation for `start_time` / `end_time`. Defaults to UTC+8.
</ParamField>

<ParamField header="Content-Type" type="string" default="application/json">
  Fixed to `application/json`
</ParamField>

## Request Body

<ParamField body="cardholder_no" type="string">
  Cardholder order number.
</ParamField>

<ParamField body="cardholder_unique_no" type="string">
  Merchant-side unique cardholder number.
</ParamField>

<ParamField body="start_time" type="string" required>
  Start time (format: `yyyy-MM-dd` or `yyyy-MM-dd HH:mm:ss`).
</ParamField>

<ParamField body="end_time" type="string" required>
  End time (same format as above; interval ≤ 90 days).
</ParamField>

<ParamField body="page" type="number" default="0">
  Query page number. Defaults to `0`.
</ParamField>

<ParamField body="size" type="number" default="10">
  Number of records per page. Defaults to `10` (max 100).
</ParamField>

## Response Parameters

<ResponseField name="code" type="number">
  Response status code. `0` indicates success.
</ResponseField>

<ResponseField name="msg" type="string">
  Response message.
</ResponseField>

<ResponseField name="data" type="object">
  Response data.

  <Expandable title="data">
    <ResponseField name="list" type="object[]">
      Cardholder list.

      <Expandable title="list">
        <ResponseField name="cardholder_no" type="string">
          Cardholder order number.
        </ResponseField>

        <ResponseField name="cardholder_unique_no" type="string">
          Merchant-side unique cardholder number.
        </ResponseField>

        <ResponseField name="email" type="string">
          Email.
        </ResponseField>

        <ResponseField name="fail_reason" type="string">
          Failure reason (has a value when authentication fails).
        </ResponseField>

        <ResponseField name="status" type="string">
          Status, see \[Appendix - Constants] Cardholder Status.
        </ResponseField>

        <ResponseField name="time" type="number">
          Creation time (Unix milliseconds).
        </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>