WorldFirst DocsWorldFirst DocsDOCS

inquiryBeneficiaryTemplate需要签名验签

POST /amsin/api/v1/business/account/inquiryBeneficiaryTemplate

转账代发前，集成商需要创建收款人。创建收款人时，集成商可调用此接口获取收款人模板。

报文结构

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

请求头

字段名

是否必传

范例

说明

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: *****

注意此字段

当平台客户操作商户账户时需要传递

Access-Token

有条件要求

Access-Token: ****** 

注意此字段

当用 OAUTH 授权时需要传递

入参

countryCode String  REQUIRED

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

更多信息：

  • 最大长度：2 字符

currency String  REQUIRED

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

现阶段字段取值范围为：

USD,EUR,GBP,NZD,CAD,AUD,JPY,SGD,HKD,CNH

出参

result Result object REQUIRED

代表API 接口的调用结果。

Show child parameters

responseId String  REQUIRED

由万里汇定义，用于唯一标识某次响应的ID。

更多信息：

  • 最大长度：32 字符

cardTemplateData Array<CardTemplateField> object REQUIRED

常规模板，包括所有相关的收款人信息要素。

Show child parameters

localCardTemplateData Array<CardTemplateField> object 

本地模板，包括本地清算网络要求的收款人信息要素集合

Show child parameters

crossBorderCardTemplateData Array<CardTemplateField> object 

跨境模板，包括跨境清算网络要求的收款人信息要素集合。

Show child parameters
API Explorer

请求

URL
Case
DE-EUR
请求体

响应

Case
DE-EUR
Case description
Beneficiary template for DE-EUR
响应体

响应处理

接口调用结果

集成商调用接口后，万里汇返回集成商API调用结果。result.resultStatus字段取值范围为：

Result status

描述

S

接口调用成功

F

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

U

调用结果未知，需再次调用接口。

重试策略：

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

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

不同类型的卡模板

万里汇收到卡模板查询请求后，会根据场景返回一个或多个卡模板：

  • 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：系统结果码

结果码值结果码信息行动建议
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.

包含无效参数（如货币代码错误），使用正确的参数重试

SYSTEM_ERRORFSystem error.

请勿重试，联系万里汇技术支持了解详情

USER_NOT_EXISTFThe user does not exist.

使用正确的用户信息重试

CARD_TEMPLATE_NOT_EXISTFNo card templates met the query conditions.

修改请求参数后重试

@2024 WorldFirst