bindBeneficiary需要签名验签
绑定收款人时，集成商可调用此接口将收款人的银行卡信息添加至万里汇账号中。
报文结构
万里汇接口报文结构包括：请求头、请求体。
请求头
入参
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时，此字段为必传。
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,KRW
当 beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT时，此字段为非必传。
beneficiaryNick String CONDITIONAL
由用户定义的收款人昵称，可以帮助用户更方便地识别该收款人。
当beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT时，此字段为非必传。
更多信息：
- 最大长度：70 字符
templateCategory String
绑定收款人使用的模板类型。
可取值为：
GENERAL_TEMPLATE: 常规模板，对应inquiryBeneficiaryTemplate 接口返回的cardTemplateDataLOCAL_TEMPLATE: 本地模板，对应inquiryBeneficiaryTemplate 接口返回的localCardTemplateDataCROSS_BORDER_TEMPLATE：跨境模板，对应inquiryBeneficiaryTemplate 接口返回的crossBorderCardTemplateData
有关此字段的更多信息：
- 默认取值为
GENERAL_TEMPLATE
referenceBeneficiaryId String
由集成商定义的收款人唯一标识ID。
更多信息：
- 最大长度：64 字符
出参
result Result REQUIRED
代表API 接口的调用结果。
beneficiary Beneficiary REQUIRED
收款人信息。
该字段只有当 result.resultStatus =S 时才会按需返回。
请求
响应
响应处理
集成商调用接口后，万里汇返回集成商API调用结果：result.resultStatus和beneficiary.status。
result.resultStatus代表API调用结果beneficiary.status代表提交的收款人状态
result.resultStatus 取值范围为：
result.resultCode：系统结果码
| 结果码 | 值 | 结果码信息 | 行动建议 |
|---|---|---|---|
| SUCCESS | S | Success | |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入，联系万里汇技术支持以解决此问题 |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面，确认请求头和传参是否正确 |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误，若稍后重试问题依旧，联系万里汇技术支持以解决问题 |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | 重试，若问题依旧，联系万里汇技术支持 |
| OAUTH_FAIL | F | OAuth process failed. | 联系万里汇技术支持了解详情 |
| INVALID_API | F | The called API is invalid or not active. | 确认是否调用正确的API |
| INVALID_CLIENT | F | The client is invalid. | Client ID不存在或无效，需确认信息正确 |
| INVALID_SIGNATURE | F | The signature is invalid. | |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确认HTTP请求方法为 |
result.resultCode：业务结果码
| 结果码 | 值 | 结果码信息 | 行动建议 |
|---|---|---|---|
| UN_SUPPORT_BUSINESS | F | Unsupported business. | 包含无效参数（如货币代码错误），使用正确的参数重试 |
| USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
| RISK_REJECT | F | The transfer is rejected for risk control reasons. | 集成商需提示用户，该请求因风控审核未通过被拒绝 |
| REPEAT_BIND_BENEFICIARY_REQUEST | U | Repeated request to bind a beneficiary. | 调用 inquiryBeneficiary 接口以检查收款人是否已成功绑定 |
| EXCEED_MAX_COUNT_LIMIT | F | Exceed max count limit. | 使用正确的参数重试 |
| USER_NO_PERMISSION | F | User does not have permission. | 检查用户权限是否正确并重试 |
| BENEFICIARY_ALREADY_EXISTED | F | Beneficiary already existed. | 调用 inquiryBeneficiary 接口以检查收款人是否已成功绑定 |
| REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | 确认请求中所有参数一致 |
| REFERENCE_BENEFICIARY_ID_EXIST | F | Reference beneficiary id exist. | 确认收款人是否已成功绑定 |
| CARD_TEMPLATE_NOT_EXIST | F | No card templates met the query conditions. | 确认使用的模板类型是否正确 |