收款人创建 - PayKKa OpenAPI Documentation

收款人创建

请求参数

Header 参数

X-Merch-Id

string

可选

默认值:

M24061911365700670

Body 参数application/json

request_id

string

必需

请求号，请求方系统内唯一

>= 1 字符<= 32 字符

type

string

必需

目的(必填): PAYMENT-收款、WITHDRAWAL-提现

beneficiary

object

收款人信息

必需

purpose

enum<string>

必需

收款类型 PFG-货款 LWF-物流仓储费 ASF-广告服务费 TSF-技术服务费 CSF-咨询服务费 OTHER-其他数据字典:PAYEE_TYPE

枚举值:

PFGLWFASFTSFCSFOTHER

purpose_desc

string

可选

收款类型说明,其他收款类型的时候需要填(最长100字符)，purpose为OTHER时必填

>= 0 字符<= 100 字符

country

string

必需

国家代码,使用ISO3166-2标准2位国家代码,非制裁国家(见附录)

industry

integer <int32>

可选

主营行业(见附件)，对公账户且为收款人时必填

nick_name

string

可选

账户昵称(最长100字符)

>= 0 字符<= 100 字符

first_name

string

可选

受益人first name(境外收款人对私必填)(最长100字符)

>= 1 字符<= 100 字符

last_name

string

可选

受益人last name(境外收款人对私必填)(最长100字符)

>= 1 字符<= 100 字符

doc_type

string

可选

证件类型(境内个人账户必填), 境内个人账户必填且为ID_CARD

id_number

string

可选

证件号码(境内个人账户必填)(最长100字符)

>= 0 字符<= 100 字符

uni_social_credit

string

可选

统一社会信用代码(境内对公账户必填)(最长18字符)

>= 0 字符<= 18 字符

address

object

受益人地址信息

可选

bank_acc

object

银行账户信息

必需

country

string

必需

国家代码,使用ISO3166-2标准2位国家代码,非制裁国家(见附录)

>= 0 字符<= 2 字符

示例值:

string

currency

enum<string>

必需

币种: EUR-欧元, USD-美元, CNY-人民币, GBP-英镑, JPY-日元, AUD-澳元, CAD-加元, SGD-新加坡元, HKD-港币, PHP-菲律宾比索, CNH-离岸人民币

枚举值:

EURUSDCNYGBPJPYAUDCADSGDHKDPHPCNH

acc_name

string

必需

账户名称(最长100字符)

>= 1 字符<= 100 字符

acc_type

enum<string>

必需

账户类型: PRIVATE-个人账户, COMPANY-企业对公

枚举值:

PRIVATECOMPANY

acc_no

string

可选

银行账号，acc_no和iban二选一

>= 0 字符<= 100 字符

payment_type

enum<string>

必需

支付清算网络：LOCAL-本地支付，SWIFT-国际支付

枚举值:

LOCALSWIFT

routing_code_type1

string

可选

LOCAL清算网络时必须(随业务发展后会扩展枚举值）：ABA（美国本地支付网络代码）、FASTER_PAYMENT（英国本地支付网络代码）、CHAPS（英国本地支付网络代码）、SORT_CODE、BANK_CODE(境内详见银行编码附件，境外如加拿大如实填写)

routing_code_value1

string

可选

routing_code_type1不为空时必须

routing_code_type2

string

可选

LOCAL清算网络子类型(随业务发展后会扩展枚举值）：BRANCH_BANK_CODE(境内详见银行编码附件，境外如加拿大如实填写)

routing_code_value2

string

可选

routing_code_type2不为空时必须

iban

string

可选

IBAN，欧元区账户特有，acc_no和iban二选一

>= 0 字符<= 50 字符

bic_swift

string

可选

swift code或bic，SWIFT清算网络时其它国家与地区均需要上传该字段(只支持8位或11位)

>= 8 字符<= 11 字符

示例值:

string

bank_acc_type

enum<string>

可选

银行账户类型 CHECKING-支票 SAVINGS-储蓄卡

枚举值:

CHECKINGSAVINGS

bank_addr

string

可选

开户银行详细地址(境外账户必填)(最长100字符)

>= 0 字符<= 100 字符

bank_name

string

可选

开户银行名称(境外账户必填; 最长100字符)

>= 0 字符<= 100 字符

branch_bank_name

string

可选

开户银行支行名称(最长100字符)

>= 0 字符<= 100 字符

phone

string

可选

银行预留手机号(大陆人民币对私提现)

>= 11 字符<= 11 字符

示例值:

string

province

string

可选

开户银行所属省份(境内企业对公账户必填, 见附件)

>= 0 字符<= 10 字符

city

string

可选

开户银行所属城市(境内企业对公账户必填, 见附件)

>= 0 字符<= 10 字符

district

string

可选

开户银行所属区(境内企业对公账户必填, 见附件)

>= 0 字符<= 10 字符

attachment

object

其他文件附件

可选

other_file_ids

array[integer <int32>]

可选

附件文件id 最多7个

>= 0 items<= 7 items

contract_file_id

integer <int32>

可选

合同文件-上传文件接口返回的id(目的为收款时, 合同/PI/物流文件必传其一)

logistics_file_id

integer <int32>

可选

物流文件-上传文件接口返回的id(目的为收款时, 合同/PI/物流文件必传其一)

pi_file_id

integer <int32>

可选

PI文件-上传文件接口返回的id(目的为收款时, 合同/PI/物流文件必传其一)

示例

{
    "request_id": "string",
    "type": "string",
    "beneficiary": {
        "purpose": "PFG",
        "purpose_desc": "string",
        "country": "string",
        "industry": 0,
        "nick_name": "string",
        "first_name": "string",
        "last_name": "string",
        "doc_type": "string",
        "id_number": "string",
        "uni_social_credit": "string",
        "address": {
            "province": "string",
            "city": "string",
            "zipcode": "string",
            "address1": "string",
            "address2": "string"
        }
    },
    "bank_acc": {
        "country": "string",
        "currency": "EUR",
        "acc_name": "string",
        "acc_type": "PRIVATE",
        "acc_no": "string",
        "payment_type": "LOCAL",
        "routing_code_type1": "string",
        "routing_code_value1": "string",
        "routing_code_type2": "string",
        "routing_code_value2": "string",
        "iban": "string",
        "bic_swift": "string",
        "bank_acc_type": "CHECKING",
        "bank_addr": "string",
        "bank_name": "string",
        "branch_bank_name": "string",
        "phone": "string",
        "province": "string",
        "city": "string",
        "district": "string"
    },
    "attachment": {
        "other_file_ids": [
            0
        ],
        "contract_file_id": 0,
        "logistics_file_id": 0,
        "pi_file_id": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

*/*

Body

msg

string

可选

结果说明，失败时不为空

payee_id

string

可选

收款人id, 仅创建成功并审核通过后返回；付款时可通过指定收款人 id 发起付款

>= 0 字符<= 20 字符

status

enum<string>

必需

付款人审核状态 PENDING-待审核 NORMAL-正常 REJECTED-审核未通过

枚举值:

PENDINGNORMALREJECTED

示例

{
    "msg": "string",
    "payee_id": "string",
    "status": "PENDING"
}

🟠400请求有误

🟠401没有权限

🟠404记录不存在

🟠429429

🔴500服务器错误