跳到主要内容

ListPayeesResponse

successboolean
Example: true
data object
payees object[]

收款人列表

  • Array [
    • idstring<uuid>

    收款人 ID

    typeRemitType (string)

    汇款明细类型：

    • SWIFT — 国际汇款
    • CHINA_MAINLAND_BANK — 中国大陆银行转账
    • ALIPAY_MAINLAND — 中国大陆支付宝转账

    Possible values: [SWIFT, CHINA_MAINLAND_BANK, ALIPAY_MAINLAND]

    display_namestring

    显示名称

    owner_idstring<uuid>

    所属用户 ID

    recipient_idstring<uuid>

    收款方 ID

    details object
    recipient object

    收款方信息，根据汇款类型选择对应结构：

    • SWIFT → SWIFTRecipient
    • CHINA_MAINLAND_BANK → ChinaMainlandBankRecipient
    • ALIPAY_MAINLAND → AlipayMainlandRecipient
    oneOf
    account_typeAccountType (string)required

    账户类型：

    • PERSONAL — 个人账户
    • COMPANY — 公司/企业账户

    Possible values: [PERSONAL, COMPANY]

    country_codestringrequired

    ISO 3166-1 Alpha-3 国家代码

    Possible values: >= 3 characters and <= 3 characters

    Example: CHN
    transfer_typeTransferType (string)required

    汇款方式（仅 SWIFT）：

    • WIRE — 普通汇款
    • WIRE_SAME_NAME — 同名汇款

    Possible values: [WIRE, WIRE_SAME_NAME]

    bank_namestringrequired

    银行名称

    Example: China Construction Bank
    bank_swift_codestringrequired

    SWIFT/BIC 代码

    Example: PCBCCNBJ
    bank_addressstringrequired

    银行地址

    Example: Beijing, China
    intermediary_bank_swift_codestring

    中间行 SWIFT 代码（可选）

    account_numberstringrequired

    收款账号

    Example: 6217001234567890
    beneficiary_namestringrequired

    收款人姓名

    Example: Example Corp Ltd
    beneficiary_id_documentstring[]

    身份证件文件 ID（同名汇款 + 个人账户时必填）

    Possible values: <= 3

    beneficiary_statementstring[]

    声明文件 ID（同名汇款 + 个人账户时必填）

    Possible values: <= 3

    beneficiary_business_registrationstring[]

    营业执照文件 ID（公司账户时必填）

    Possible values: <= 3

    beneficiary_company_registrationstring[]

    公司注册文件 ID（公司账户时必填）

    Possible values: <= 3

    created_atstring<date-time>

    创建时间

    updated_atstring<date-time>

    更新时间

  • ]
    • medias object

    文件 ID 到临时访问 URL 的映射

    property name*string
    totalinteger

    符合条件的总数

    Example: 42
    ListPayeesResponse
    {
      "success": true,
      "data": {
        "payees": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type": "SWIFT",
            "display_name": "string",
            "owner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "details": {
              "recipient": {
                "account_type": "PERSONAL",
                "country_code": "CHN",
                "transfer_type": "WIRE",
                "bank_name": "China Construction Bank",
                "bank_swift_code": "PCBCCNBJ",
                "bank_address": "Beijing, China",
                "intermediary_bank_swift_code": "string",
                "account_number": "6217001234567890",
                "beneficiary_name": "Example Corp Ltd",
                "beneficiary_id_document": [
                  "string"
                ],
                "beneficiary_statement": [
                  "string"
                ],
                "beneficiary_business_registration": [
                  "string"
                ],
                "beneficiary_company_registration": [
                  "string"
                ]
              }
            },
            "created_at": "2024-07-29T15:51:28.071Z",
            "updated_at": "2024-07-29T15:51:28.071Z"
          }
        ],
        "medias": {
          "f1e2d3c4-b5a6-7890-fedc-ba0987654321": "https://storage.example.com/file.pdf?token=xxx"
        },
        "total": 42
      }
    }