inquiryBeneficiaryTemplate需要签名验签
转账代发前,集成商需要创建收款人。创建收款人时,集成商可调用此接口获取收款人模板。
报文结构
万里汇接口报文结构包括:请求头、请求体。
请求头
入参
countryCode String CONDITIONAL
收款行所在国家/地区,为 ISO 3166 标准规定的二位字母国家地区码。
当 beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT
时,此字段为非必传。
更多信息:
- 最大长度:2 字符
currency String CONDITIONAL
当 beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT
时,此字段为非必传。
beneficiaryType String CONDITIONAL
收款人账户类型。
可取值范围:
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
关联公司企业支付宝账户
- 对于已经集成的万里汇集成商,此参数为可选参数。
- 当此字段取值为
RELATED_MERCHANT_COMPANY_BANK_ACCOUNT
或RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT
时,countryCode 字段取值为CN
且 currency 字段取值为CNY
。- 当countryCode 字段取值为
KR
且 currency 字段取值为KRW
时,此字段为必传,且取值为PERSONAL_BANK_ACCOUNT
或COMPANY_BANK_ACCOUNT
。
出参
result Result REQUIRED
代表API 接口的调用结果。
responseId String REQUIRED
由万里汇定义,用于唯一标识某次响应的ID。
更多信息:
- 最大长度:32 字符
cardTemplateData Array<CardTemplateField> CONDITIONAL
常规模板,包括所有相关的收款人信息要素。
当beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT
时,此字段为非必传。
localCardTemplateData Array<CardTemplateField>
本地模板,包括本地清算网络要求的收款人信息要素集合
crossBorderCardTemplateData Array<CardTemplateField>
跨境模板,包括跨境清算网络要求的收款人信息要素集合。
alipayTemplateData Array<CardTemplateField> CONDITIONAL
支付宝模板,包括所有相关的收款人信息要素。
当beneficiaryType 字段取值为
RELATED_MERCHANT_ALIPAY_COMPANY_ACCOUNT
时,此字段为必传。
请求
响应
响应处理
接口调用结果
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus字段取值范围为:
Result status | 描述 |
S | 接口调用成功 |
F | 接口调用失败,具体原因参见result.resultCode. |
U | 调用结果未知,需再次调用接口。 重试策略:
若上述重试均未成功,联系万里汇技术支持。 |
不同类型的卡模板
万里汇收到卡模板查询请求后,会根据场景返回一个或多个卡模板:
cardTemplateData
为常规卡模板,包括所有相关的收款人信息要素localCardTemplateData
为本地模板,包括本地清算网络要求的收款人信息要素集合crossBorderCardTemplateData
为跨境模板,包括跨境清算网络要求的收款人信息要素集合
若万里汇返回多个卡模板,则所有卡模板均适用于查询的场景。 localCardTemplateData
和 crossBorderCardTemplateData
为特定场景适用的卡模板,一般包含的信息要素个数少于常规模板。集成商在绑定收款人时,多个卡模板均可使用。若有任何疑问,可联系万里汇技术支持。
卡信息要素列表
本表格仅供参考,具体不同场景下适用的信息要素需要参照万里汇返回的响应信息。
fieldName | fieldDescription | restrictionType |
bankAccountName | Account name | PATTERN_RESTRICTION |
bankAccountNo | Account number | PATTERN_RESTRICTION |
bankName | Bank name | PATTERN_RESTRICTION |
bankBIC | Bank BIC/SWIFT | PATTERN_RESTRICTION |
bankAccountIBAN | IBAN | PATTERN_RESTRICTION |
routingNumber | Routing Number | PATTERN_RESTRICTION |
beneficiaryAddress | Beneficiary address | PATTERN_RESTRICTION |
beneficiaryCountryCode | Beneficiary country code | PATTERN_RESTRICTION |
beneficiaryPhone | Beneficiary phone | PATTERN_RESTRICTION |
bankBranchCode | Bank branch code | PATTERN_RESTRICTION |
bankAccountLocalName | Account name (in local language) | PATTERN_RESTRICTION |
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. | 包含无效参数(如货币代码错误),使用正确的参数重试 |
SYSTEM_ERROR | F | System error. | 请勿重试,联系万里汇技术支持了解详情 |
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
CARD_TEMPLATE_NOT_EXIST | F | No card templates met the query conditions. | 修改请求参数后重试 |