bindBeneficiary需要签名验签

POST /amsin/api/v1/business/account/bindBeneficiary

绑定收款人时,集成商可调用此接口将收款人的银行卡信息添加至万里汇账号中。

报文结构

万里汇接口报文结构包括:请求头、请求体。

请求头

字段名

是否必传

范例

说明

Client-Id

Client-Id: *****

关于这些参数的解释说明,详见:请求头

Signature

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Content-Type: application/json; charset=UTF-8

Request-Time

Request-Time: 2019-04-04T12:08:56+08:00

Connected-CustomerId

Connected-CustomerId: *****

注意

由万里汇定义、用于唯一标识某万里汇账户。

该字段原为请求体中的customerId字段。两个字段在API实现逻辑上一致,对已完成集成的功能没有任何影响,您可以继续使用请求体中的customerId字段,或使用Connected-CustomerId重新集成。

入参

bindBeneficiaryRequestId String  REQUIRED

由集成商定义、用于唯一标识某次收款人绑定请求。

更多信息:

  • 此为幂等字段。具体详见幂等字段介绍。
  • 最大长度:64 字符

accessToken String  

用于OAuth校验的访问令牌。

更多信息:

  • 最大长度:64 字符

beneficiaryBankAccount BeneficiaryBankAccount object  CONDITIONAL

收款人银行账户信息,例如账户持有人、国家/地区、收款人银行BIC码等。

  • beneficiaryType 字段取值为 RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT时,此字段为必传
  • 调用inquiryBeneficiaryTemplate接口获取需要填写的字段。

beneficiaryAlipayAccount BeneficiaryAlipayAccount  CONDITIONAL

收款人支付宝账户信息,例如支付宝账户名称、账户ID等。

beneficiaryType 字段取值为RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT时,此字段为必传

Show child parameters

beneficiaryType String  REQUIRED

收款人账户类型。

取值范围为:

  • THIRD_PARTY_COMPANY_BANK_ACCOUNT 第三方收款人的企业银行账户
  • THIRD_PARTY_PERSONAL_BANK_ACCOUNT 第三方收款人的私人银行账户
  • PERSONAL_BANK_ACCOUNT 同名收款人的私人银行账户
  • COMPANY_BANK_ACCOUNT 同名收款人的企业银行账户
  • RELATED_MERCHANT_COMPANY_BANK_ACCOUNT 关联公司企业银行账户
  • RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT 关联公司企业支付宝账户

countryCode String  CONDITIONAL

收款行所在国家/地区,为 ISO 3166标准规定的二位字母国家地区码。

当 beneficiaryType 字段取值为 RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT 时,此字段为非必传

更多信息:

  • 最大长度:2 字符

currency String  CONDITIONAL

币种信息,为 ISO 4217 标准规定的三位字母货币代码。

现阶段字段取值范围为:USD,EUR,GBP,NZD,CAD,AUD,JPY,SGD,HKD,CNH,CNY

当 beneficiaryType 字段取值为 RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT 时,此字段为非必传

beneficiaryNick String  CONDITIONAL

由用户定义的收款人昵称,可以帮助用户更方便地识别该收款人。

beneficiaryType 字段取值为​RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT时,此字段为非必传

更多信息:

  • 最大长度:70 字符

templateCategory String  

绑定收款人使用的模板类型。

可取值为:

  • GENERAL_TEMPLATE: 常规模板,对应inquiryBeneficiaryTemplate 接口返回的 cardTemplateData
  • LOCAL_TEMPLATE: 本地模板,对应inquiryBeneficiaryTemplate 接口返回的 localCardTemplateData
  • CROSS_BORDER_TEMPLATE:跨境模板,对应inquiryBeneficiaryTemplate 接口返回的 crossBorderCardTemplateData

有关此字段的更多信息:

  • 默认取值为GENERAL_TEMPLATE

referenceBeneficiaryId String  

由集成商定义的收款人唯一标识ID。

更多信息:

  • 最大长度:64 字符

出参

result Result  REQUIRED

代表API 接口的调用结果。

Show child parameters

beneficiary Beneficiary  REQUIRED

收款人信息。

该字段只有当 result.resultStatus =​S​ 时才会按需返回。

Show child parameters
API Explorer

请求

URL
Case
Add new beneficiary using general template
请求体

响应

Case
General template
Case description
Add new beneficiary using general template
响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果:result.resultStatusbeneficiary.status

  • result.resultStatus代表API调用结果
  • beneficiary.status代表提交的收款人状态

result.resultStatus 取值范围为:

Result status

描述

S

接口调用成功

F

接口调用失败,具体原因参见result.resultCode

U

调用结果未知,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

若上述重试均未成功,联系万里汇技术支持。

result.resultCode:系统结果码

结果码结果码信息行动建议
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do not retry.

需要人工介入,联系万里汇技术支持以解决此问题

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

参考API文档页面,确认请求头和传参是否正确

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

重试,若问题依旧,联系万里汇技术支持

OAUTH_FAILFOAuth process failed.

联系万里汇技术支持了解详情

INVALID_APIFThe called API is invalid or not active.

确认是否调用正确的API

INVALID_CLIENTFThe client is invalid.

Client ID不存在或无效,需确认信息正确

INVALID_SIGNATUREFThe signature is invalid.

确认请求正确加签,具体参见:

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

确认HTTP请求方法为POST

result.resultCode:业务结果码

结果码结果码信息行动建议
UN_SUPPORT_BUSINESSFUnsupported business.

包含无效参数(如货币代码错误),使用正确的参数重试

USER_NOT_EXISTFThe user does not exist.

使用正确的用户信息重试

RISK_REJECTFThe transfer is rejected for risk control reasons.

集成商需提示用户,该请求因风控审核未通过被拒绝

REPEAT_BIND_BENEFICIARY_REQUESTURepeated request to bind a beneficiary.

调用 inquiryBeneficiary 接口以检查收款人是否已成功绑定

EXCEED_MAX_COUNT_LIMITFExceed max count limit.

使用正确的参数重试

USER_NO_PERMISSIONFUser does not have permission.

检查用户权限是否正确并重试

BENEFICIARY_ALREADY_EXISTEDFBeneficiary already existed.

调用 inquiryBeneficiary 接口以检查收款人是否已成功绑定

REPEAT_REQ_INCONSISTENTFRepeated requests are inconsistent.

确认请求中所有参数一致

REFERENCE_BENEFICIARY_ID_EXISTFReference beneficiary id exist.

确认收款人是否已成功绑定

CARD_TEMPLATE_NOT_EXISTFNo card templates met the query conditions.

确认使用的模板类型是否正确

@2024 WorldFirst