# 收款方必填字段查询

> 查询指定国家、币种、主体类型和打款方式下的字段要求。

```yaml
openapi: 3.1.0
info:
  title: 收款方必填字段查询
  version: 1.0.0
  description: 查询指定国家、币种、主体类型和打款方式下的字段要求。
paths:
  /api/v1/acct/queryPaymentFeild:
    post:
      summary: 收款方必填字段查询
      description: 查询指定国家、币种、主体类型和打款方式下的字段要求。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: string
                  description: Onerway 分配的商户号。通常在沙盒或生产商户开通后，从商户后台或开户材料中获取。
                payoutCurrency:
                  type: string
                  description: 需要确认字段要求的打款币种。
                bankCountry:
                  type: string
                  description: 收款账户的目标国家。
                entityType:
                  type: string
                  description: 收款主体类型；`0` 表示企业，`1` 表示个人。
                paymentMethod:
                  type: string
                  description: 需要确认字段要求的付款方式。
                walletType:
                  type: string
                  description: 钱包类付款方式使用的钱包子类型。
                  x-onerway-required: conditional
                  x-onerway-condition:
                    - 当付款方式为钱包类时必填。
                sign:
                  type: string
                  description: 请求签名字符串，需使用商户私钥按 Transfer 请求签名规则生成。
              required:
                - merchantNo
                - payoutCurrency
                - bankCountry
                - entityType
                - paymentMethod
                - sign
            examples:
              query-required-fields-bank-transfer-individual:
                summary: 查询个人银行打款的必填字段
                value:
                  bankCountry: US
                  entityType: "1"
                  merchantNo: "801129"
                  paymentMethod: BANK_TRANSFER
                  payoutCurrency: USD
                  sign: "{{SIGN}}"
      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:
                      merchantNo:
                        type: string
                        description: 响应中回显的商户号。
                      accountInfomation:
                        type: object
                        properties:
                          cardNumber:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          accountType:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          swiftCode:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          sortCode:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          branchCode:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          bankHolderName:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          walletType:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          walletPhone:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                        description: 收款账户信息字段要求。
                      address:
                        type: object
                        properties:
                          state:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          city:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          addressLine1:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          addressLine2:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          addressLine3:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          postalCode:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                        description: 收款地址信息字段要求。
                      receiverInfo:
                        type: object
                        properties:
                          nickName:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          companyName:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          lastName:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          firstName:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          areaCode:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          phone:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          vatNumber:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          birthDate:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                          email:
                            type: string
                            description: 字段要求标记；`Y` 表示必填，`C` 表示条件必填，`N` 表示选填。
                        description: 收款人身份信息字段要求。
                    description: 指定打款场景下的字段要求矩阵。
              examples:
                required-fields-bank-transfer-individual:
                  summary: 个人银行打款返回的必填字段
                  value:
                    respCode: "20000"
                    respMsg: null
                    data:
                      merchantNo: "801129"
                      accountInfomation:
                        cardNumber: Y
                        accountType: Y
                        swiftCode: C
                        sortCode: C
                        branchCode: N
                        bankHolderName: Y
                        walletType: N
                        walletPhone: N
                      address:
                        state: Y
                        city: Y
                        addressLine1: Y
                        addressLine2: N
                        addressLine3: N
                        postalCode: Y
                      receiverInfo:
                        nickName: N
                        companyName: N
                        lastName: Y
                        firstName: Y
                        areaCode: C
                        phone: C
                        vatNumber: N
                        birthDate: C
                        email: C
```