# Payer Query

> Query saved payers with pagination.

```yaml
openapi: 3.1.0
info:
  title: Payer Query
  version: 1.0.0
  description: Query saved payers with pagination.
paths:
  /api/v1/acct/queryPayer:
    post:
      summary: Payer Query
      description: Query saved payers with pagination.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                size:
                  type: integer
                  description: Page size. Use `-1` to request all records when supported.
                current:
                  type: integer
                  description: Current page number.
                column:
                  type: string
                  description: Sort column name.
                asc:
                  type: boolean
                  description: Whether to sort in ascending order.
                id:
                  type: string
                  description: Optional payer ID filter.
                merchantNo:
                  type: string
                  description: Merchant number assigned by Onerway. Retrieve it from the merchant
                    portal or onboarding material after your sandbox or
                    production account is created.
                subEntityType:
                  type: string
                  description: Optional payer entity type filter.
                companyName:
                  type: string
                  description: Optional company name filter.
                companyNameEn:
                  type: string
                  description: Optional English company name filter.
                firstName:
                  type: string
                  description: Optional first-name filter.
                lastName:
                  type: string
                  description: Optional last-name filter.
                country:
                  type: string
                  description: Optional country filter.
                registerNo:
                  type: string
                  description: Optional registration-number filter.
                idType:
                  type: string
                  description: Optional identity-document type filter.
                registerDate:
                  type: string
                  description: Optional registration-date filter.
                sign:
                  type: string
                  description: Request signature string. Generate it according to the Transfer
                    request-signing rules with your merchant private key.
              required:
                - size
                - current
                - column
                - asc
                - merchantNo
                - sign
            examples:
              query-payers:
                summary: Query payers
                value:
                  asc: false
                  column: create_time
                  current: 1
                  merchantNo: "801129"
                  sign: "{{SIGN}}"
                  size: 10
      responses:
        "200":
          description: Payer list returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Response code returned by Onerway.
                  respMsg:
                    type:
                      - string
                      - "null"
                    description: Response message returned by Onerway.
                    x-onerway-value:
                      nullable: true
                      when:
                        en: No response message is returned.
                        zh: 未返回响应信息时为 `null`。
                  data:
                    type: object
                    properties:
                      records:
                        type: array
                        description: Payer records.
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Payer ID.
                            merchantNo:
                              type: string
                              description: Merchant number.
                            subEntityType:
                              type: string
                              description: Payer entity type.
                            country:
                              type: string
                              description: Payer country.
                      total:
                        type: integer
                        description: Total record count.
                      size:
                        type: integer
                        description: Page size.
                      current:
                        type: integer
                        description: Current page number.
                    description: Paged payer query result.
              examples:
                payer-list:
                  summary: Payer list returned
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      records:
                        - id: "1984096429476806656"
                          merchantNo: "801129"
                          subEntityType: "0"
                          country: GB
                      total: 1
                      size: 10
                      current: 1
```