收款人认证申请

POST/v1/global-payout/beneficiary/apply

请求参数

mch_id

string

商户编号

必需

商户编号是商户在平台上开设的商户号码，为18位数字

<= 18 字符

sub_mch_id

string

子商户号

可选

子商户号（平台商模式下必传），为18位数字

txn_seqno

string

申请唯一编号

必需

<= 64 字符

beneficiary_id

string

商户侧收款人id

必需

仅限数字或者英文

<= 64 字符

beneficiary_type

enum<string>

收款人类型

必需

<= 16 字符

枚举值:

PERSONCOMPANY

beneficiary_name

string

收款人名称

必需

仅限英文

<= 64 字符

string

收款人邮箱

必需

该字段需要连连RSA公钥加密传输。

country_code

string

收款人所在国家/地区编码

必需

标准2位编码，参考：https://en.wikipedia.org/wiki/ISO_3166-2

<= 2 字符

city

string

收款人所在城市

必需

禁止包含!#?及其他特殊字符

<= 32 字符

state

string

收款人所在州、县、地区

必需

禁止包含!#?及其他特殊字符

<= 32 字符

line

string

收款人的详细地址

必需

英文地址，禁止包含!#?及其他特殊字符

<= 256 字符

postcode

string

邮政编码

必需

可通过此网站查询：https://www.nowmsg.com/

<= 16 字符

account_name

string

收款人账户名称

必需

<= 128 字符

account_no

string

收款人账户号

必需

该字段需要连连RSA公钥加密传输。

account_currency

string

收款人账户币种

必需

<= 3 字符

bank_country_code

string

银行所在国家/地区编码

必需

标准两位编码，参考：https://en.wikipedia.org/wiki/ISO_3166-2

<= 2 字符

payment_method

enum<string>

付款方式

必需

<= 16 字符

枚举值:

SWIFTLOCAL

local_clearing_system

enum<string>

本地清算系统

可选

当付款方式=LOCAL时必传

<= 16 字符

枚举值:

RTGS

bank_routing

array [object {2}]

路由列表

可选

当使用本地清算系统时必传，不同清算系统所需路由要素不同，请参考开发指引中的银行路由信息表

routing_type

string

路由类型

必需

<= 16 字符

routing_number

string

路由号

必需

<= 32 字符

swift_code

string

SWIFT编码

必需

<= 16 字符

notify_url

string

收款人认证申请结果通知地址

可选

<= 256 字符

{
    "mch_id": "string", //商户号
    "notify_url": "string",//创建收款人结果通知地址
    "payee_id": "string", //商户侧收款人id
    "type": "string",//收款人类型
    "name": "string",//收款人名称
    "email":"string",//收款人邮箱
    "country_code": "string",//收款人所在地区编码
    "city": "string",//收款人所在城市
    "state":"string",//收款人所在州、县、地区
    "line":"string",//收款人的详细地址
    "postcode":"string",//邮政编码
    "account_name":"string",//收款人账户名称
    "account_no":"string",//收款人账户号
    "account_currency":"string",//收款人账户币种
    "bank_country_code":"string",//银行所在国家编码
    "swift_code":"string"//SWIFT编码
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

ret_code

string

响应码

必需

ret_msg

string

响应信息

必需

mch_id

string

商户号

可选

txn_seqno

string

可选

商户系统唯一交易流水号

platform_txno

string

平台订单号

可选

beneficiary_id

string

商户侧收款人id

可选

platform_beneficiary_id

string

平台收款人id

可选

txn_status

enum<string>

处理状态

可选

枚举值:

PROCESSINGFAILSUCCESS

fail_reason

string

失败原因

可选

处理状态=FAIL，返回失败原因

{
  "ret_code": "string",
  "ret_msg": "string",
  "mch_id": "string",
  "notify_url": "string",
  "out_payee_id": "string",
  "type": "string",
  "name": "string",
  "email": "string",
  "country_code": "string",
  "city": "string",
  "state": "string",
  "line": "string",
  "postcode": "string",
  "account_name": "string",
  "account_no": "string",
  "account_currency": "string",
  "bank_country_code": "string",
  "swift_code": "string",
  "status": "string"
}