# Query cardholders

> Query cardholders under the merchant account with pagination and optional filters.

```yaml
openapi: 3.1.0
info:
  title: Query cardholders
  version: 1.0.0
  description: Query cardholders under the merchant account with pagination and
    optional filters.
paths:
  /api/v1/merchant/cardholder/queryCardholder:
    post:
      summary: Query cardholders
      description: Query cardholders under the merchant account with pagination and
        optional filters.
      parameters:
        - name: ApiKey
          in: header
          required: true
          description: Issuing API key request header assigned by Onerway.
          schema:
            type: string
            description: Issuing API key request header assigned by Onerway.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: integer
                  description: Merchant number filter. Use only when cross-merchant query access
                    is enabled.
                cardholderId:
                  type: integer
                  description: Cardholder ID filter.
                clientRequestId:
                  type: string
                  description: Idempotent request ID filter.
                pageNum:
                  type: integer
                  description: Page number.
                  x-onerway-constraints:
                    - kind: range
                      min: 1
                pageSize:
                  type: integer
                  description: Page size.
                  x-onerway-constraints:
                    - kind: range
                      min: 1
                      max: 100
              required:
                - pageNum
                - pageSize
            examples:
              default:
                summary: Query cardholders
                value:
                  pageNum: 1
                  pageSize: 10
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Business response code. `20000` means success.
                  respMsg:
                    type: string
                    description: Response message.
                  data:
                    type:
                      - object
                      - "null"
                    properties:
                      records:
                        type: array
                        description: Cardholder records on the current page.
                        items:
                          type: object
                          properties:
                            cardholderId:
                              type: integer
                              description: Cardholder ID.
                            firstName:
                              type: string
                              description: Cardholder first name.
                            lastName:
                              type: string
                              description: Cardholder last name.
                            email:
                              type: string
                              description: Cardholder email address.
                            mobile:
                              type:
                                - string
                                - "null"
                              description: Cardholder mobile number.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No mobile number is available.
                                  zh: 无手机号时返回 `null`。
                            mobileAreaCode:
                              type:
                                - string
                                - "null"
                              description: Mobile area code.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No mobile area code is available.
                                  zh: 无手机国际区号时返回 `null`。
                            birthDay:
                              type:
                                - string
                                - "null"
                              description: Date of birth.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No date of birth is available.
                                  zh: 无出生日期时返回 `null`。
                            nationality:
                              type:
                                - string
                                - "null"
                              description: Nationality.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No nationality is available.
                                  zh: 无国籍时返回 `null`。
                            addressRegionCode:
                              type:
                                - string
                                - "null"
                              description: Address country or region code.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No address region is available.
                                  zh: 无地址国家或地区时返回 `null`。
                            addressStateCode:
                              type:
                                - string
                                - "null"
                              description: State or province code.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No state or province is available.
                                  zh: 无州 / 省代码时返回 `null`。
                            addressCityCode:
                              type:
                                - string
                                - "null"
                              description: City code.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No city is available.
                                  zh: 无城市代码时返回 `null`。
                            addressDetailLine1:
                              type:
                                - string
                                - "null"
                              description: Address line 1.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No address line is available.
                                  zh: 无地址行时返回 `null`。
                            addressDetailLine2:
                              type:
                                - string
                                - "null"
                              description: Address line 2.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No address line 2 is available.
                                  zh: 无地址行 2 时返回 `null`。
                            addressPostalCode:
                              type:
                                - string
                                - "null"
                              description: Postal code.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No postal code is available.
                                  zh: 无邮编时返回 `null`。
                            remark:
                              type:
                                - string
                                - "null"
                              description: Remark.
                              x-onerway-value:
                                nullable: true
                                when:
                                  en: No remark is available.
                                  zh: 无备注时返回 `null`。
                        x-onerway-value:
                          empty: true
                          when:
                            en: Returned as an empty array when no cardholder matches.
                            zh: 无匹配持卡人时返回空数组。
                      total:
                        type: integer
                        description: Total record count.
                      current:
                        type: integer
                        description: Current page number.
                      size:
                        type: integer
                        description: Page size.
                    description: Paginated cardholder result.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: Returned as `null` when the query fails.
                        zh: 查询失败时返回 `null`。
              examples:
                success:
                  summary: Success
                  value:
                    respCode: "20000"
                    respMsg: success
                    data:
                      records:
                        - cardholderId: 300001
                          firstName: Alex
                          lastName: Chen
                          email: example_cardholder@example.com
                          mobile: null
                          mobileAreaCode: null
                          birthDay: null
                          nationality: CN
                          addressRegionCode: CN
                          addressStateCode: GD
                          addressCityCode: SZ
                          addressDetailLine1: Example address line 1
                          addressDetailLine2: null
                          addressPostalCode: "518000"
                          remark: null
                      total: 1
                      current: 1
                      size: 10
```