连连开放平台文档
  • 易企汇
    • 开发指引
    • API接口
      • 付款人
      • 收款人
        • 收款人认证申请POST
        • 收款人申请结果查询POST
        • 删除收款人POST
        • 收款人详情POST
      • 贸易材料
      • 付汇额度
      • 付汇
      • 异步通知类
logoPowered by Apifox
  1. 易企汇
  2. API接口
  3. 收款人

收款人详情

POST/v1/global-payout/beneficiary/detail

请求参数

Body 参数application/json
mch_id
string 
商户编号
必需

商户在平台上开设的商户号码,为18位数字,如:201304121000001004

sub_mch_id
string 
子商户号
可选

子商户号(平台商模式下必传),为18位数字

beneficiary_id
string 
商户侧收款人id
可选

商户侧收款人唯一id(和平台收款人id二选一)

<= 64 字符
platform_beneficiary_id
string 
平台收款人id
可选

平台收款人id(和商户侧收款人id二选一)

<= 20 字符
示例
{
  "mch_id": "string",
  "sub_mch_id": "string",
  "beneficiary_id": "string",
  "platform_beneficiary_id": "string"
}

示例代码

返回响应

成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
ret_code
string 
返回码
必需
ret_msg
string 
返回码描述
必需
mch_id
string 
商户号
必需
beneficiary_id
string 
商户侧收款人id
必需
platform_beneficiary_id
string 
平台收款人id
必需
txn_status
enum<string> 
收款人状态
必需
枚举值:
VALID
beneficiary_type
enum<string> 
收款人类型
必需
枚举值:
PERSONCOMPANY
beneficiary_name
string 
收款人名称
必需
email
string 
必需

收款人邮箱,邮箱脱敏处理。

country_code
string 
必需

收款人所在国家/地区编码(标准2位编码)

city
string 
收款人所在城市
必需
state
string 
必需

收款人所在州、县、地区

line
string 
收款人的详细地址
必需
postcode
string 
邮政编码
必需
account_name
string 
收款人账户名称
必需
account_no
string 
必需

收款人账户号,账户号脱敏处理。

account_currency
string 
收款人账户币种
必需
bank_country_code
string 
必需

银行所在国家/地区编码(标准两位编码)

payment_method
enum<string> 
必需
枚举值:
SWIFTLOCAL
local_clearing_system
enum<string> 
本地清算方式
可选
枚举值:
RTGSFastPayment
bank_routing
array [object {2}] 
路由列表
可选
routing_type
string 
路由类型
必需
routing_number
string 
路由号
必需
swift_code
string 
必需
示例
{
  "ret_code": "string",
  "ret_msg": "string",
  "mch_id": "string",
  "beneficiary_id": "string",
  "platform_beneficiary_id": "string",
  "txn_status": "VALID",
  "beneficiary_type": "PERSON",
  "beneficiary_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",
  "payment_method": "SWIFT",
  "local_clearing_system": "RTGS",
  "bank_routing": [
    {
      "routing_type": "string",
      "routing_number": "string"
    }
  ],
  "swift_code": "string"
}
最后修改时间: 3 个月前