# 收款方列表查询

> 分页查询收款人记录。

```yaml
openapi: 3.1.0
info:
  title: 收款方列表查询
  version: 1.0.0
  description: 分页查询收款人记录。
paths:
  /api/v1/beneficiary/queryList:
    post:
      summary: 收款方列表查询
      description: 分页查询收款人记录。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: string
                  description: Onerway 分配的商户号。通常在沙盒或生产商户开通后，从商户后台或开户材料中获取。
                payeeStatus:
                  type: string
                  description: 可选的收款方审核状态筛选条件。
                beneficiaryId:
                  type: string
                  description: 可选的收款方 ID 筛选条件。
                merchantRefId:
                  type: string
                  description: 可选的商户侧收款方引用 ID 筛选条件。
                cardNumber:
                  type: string
                  description: 可选的银行账户或卡号筛选条件。
                size:
                  type: integer
                  description: 每页条数。
                current:
                  type: integer
                  description: 当前页码。
                sign:
                  type: string
                  description: 请求签名字符串，需使用商户私钥按 Transfer 请求签名规则生成。
              required:
                - merchantNo
                - size
                - current
                - sign
            examples:
              query-beneficiaries-by-status:
                summary: 按状态查询收款方
                value:
                  beneficiaryId: "12345"
                  cardNumber: "1234567890123456"
                  current: 1
                  merchantNo: "800181"
                  merchantRefId: beneficiary_demo_001
                  payeeStatus: PASS
                  sign: "{{SIGN}}"
                  size: 10
      responses:
        "200":
          description: 收款方列表结果
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: Onerway 返回的响应码。
                  respMsg:
                    type:
                      - string
                      - "null"
                    description: Onerway 返回的响应信息。
                    x-onerway-value:
                      nullable: true
                      when:
                        en: No response message is returned.
                        zh: 未返回响应信息时为 `null`。
                  data:
                    type: object
                    properties:
                      records:
                        type: array
                        description: 收款方记录列表。
                        items:
                          type: object
                          properties:
                            beneficiaryId:
                              type: string
                              description: 收款方 ID。
                            merchantRefId:
                              type: string
                              description: 商户侧收款方引用 ID。
                            createTime:
                              type: string
                              description: 收款方创建时间。
                            updateTime:
                              type: string
                              description: 收款方最后更新时间。
                            merchantNo:
                              type: string
                              description: 所属商户号。
                            nationality:
                              type: string
                              description: 收款方国籍。
                            status:
                              type: string
                              description: 收款方记录状态。
                            remark:
                              type: string
                              description: 系统返回的收款方备注。
                            payoutCurrency:
                              type: string
                              description: 配置的打款币种。
                            expireDate:
                              type: string
                              description: 可用时返回的收款方过期时间。
                            bankName:
                              type: string
                              description: 收款银行名称。
                            accountName:
                              type: string
                              description: 收款账户名称。
                            bankAddress:
                              type: string
                              description: 收款银行地址。
                            payeeStatus:
                              type: string
                              description: 收款方审核状态。
                            accountBelong:
                              type: string
                              description: 账户归属标识。`0` 表示自有账户，`1` 表示他人账户。
                            bankCountry:
                              type: string
                              description: 收款银行所在国家。
                            entityType:
                              type: string
                              description: 收款主体类型。`0` 表示企业，`1` 表示个人。
                            payeeAddress:
                              type: string
                              description: 收款方地址摘要。
                            paymentMethod:
                              type: string
                              description: 配置的付款方式。
                            payeeCountry:
                              type: string
                              description: 收款方国家。
                            receiverInfo:
                              type: string
                              description: 以 JSON 字符串返回的收款方身份信息。
                            address:
                              type: string
                              description: 以 JSON 字符串返回的收款方地址信息。
                            accountInfomation:
                              type: string
                              description: 以 JSON 字符串返回的收款方账户信息。
                      total:
                        type: integer
                        description: 总记录数。
                      size:
                        type: integer
                        description: 每页条数。
                      current:
                        type: integer
                        description: 当前页码。
                    description: 分页收款方列表结果。
              examples:
                beneficiary-list-result:
                  summary: 收款方列表结果
                  value:
                    respCode: "20000"
                    respMsg: Success
                    data:
                      records:
                        - beneficiaryId: "12345"
                          merchantRefId: beneficiary_demo_001
                          createTime: 2024-01-15 10:30:00
                          updateTime: 2024-01-20 14:45:00
                          merchantNo: "800181"
                          nationality: US
                          status: ACTIVE
                          remark: Primary beneficiary account
                          payoutCurrency: USD
                          expireDate: 2024-12-31 23:59:59
                          bankName: Demo Bank
                          accountName: John Smith
                          bankAddress: 123 Main Street, New York, NY 10001
                          payeeStatus: PASS
                          accountBelong: "0"
                          bankCountry: US
                          entityType: "1"
                          payeeAddress: 456 Oak Avenue, Los Angeles, CA 90210
                          paymentMethod: BANK_TRANSFER
                          payeeCountry: US
                          receiverInfo: '{"firstName":"John","lastName":"Smith","email":"john.smith@example.com"}'
                          address: '{"addressLine1":"456 Oak Avenue","city":"Los
                            Angeles","state":"CA","postalCode":"90210"}'
                          accountInfomation: '{"cardNumber":"1234567890123456","accountType":"CHECKING","bankName":"Demo
                            Bank"}'
                      total: 1
                      size: 10
                      current: 1
```