inquiryBeneficiaryList需要签名验签

POST /amsin/api/v1/business/account/inquiryBeneficiaryList

创建收款人并绑定收款人账号后,集成商可调用此接口查询某万里汇账号绑定的所有收款人。

报文结构

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

请求头

字段名

是否必传

范例

说明

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重新集成。

入参

accessToken String  

用于OAuth校验的访问令牌。

更多信息:

  • 最大长度:64 字符

beneficiaryToken String  

为加密字符串,包含收款人银行账户相关信息。

加密内容使用 Base64 进行编码,具体详见编码标准部分。

更多信息:

  • 最大长度:128 字符

beneficiaryNick String  

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

更多信息:

  • 最大长度:70 字符

referenceBeneficiaryId String  

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

更多信息:

  • 最大长度:64 字符

bankAccountNo String  

银行卡类型或者支付宝类型的账户名,可进行模糊匹配。

规则{"checkRules": "^[A-Z0-9]{0,34}$"}.

更多信息:

  • 最大长度:64 字符

bankAccountIBAN String  

收款人账户的国际银行账户号码(IBAN码)。

规则:{"checkRules": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$"}.

更多信息:

  • 最大长度:34 字符

currencyList Array<String>  

由3字母ISO-4217代码组成的列表,代表账户币种。

现阶段支持以下币种:

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

当此字段为空时,万里汇返回所有可用币种的收款账户

accountName String  

账号户主姓名,可进行模糊匹配。

assetType String  

需要查询的收款人资产账户类型。

可取值范围:

  • BANK_ACCOUNT:查询收款人的银行卡账户
  • ALIPAY_ACCOUNT:查询收款人的支付宝账户

当此字段为空时,万里汇默认返回所有类型的资产账户信息。

relationFilter Array<String>  

需要查询的收款人类型。

可取值范围:

  • SAME_NAME 同名收款人
  • THIRD_PARTY 第三方收款人

当此字段为空时,万里汇返回所有类型的收款人。

pageSize Integer  REQUIRED

每页包含的条目数。

更多信息:

  • 最大长度:50 字符

pageNumber Integer  REQUIRED

页码。

格式:1、2、3……

出参

result Result  REQUIRED

代表API 接口的调用结果。

Show child parameters

responseId String  REQUIRED

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

更多信息:

  • 最大长度:32 字符

beneficiaries Array<Beneficiary>  REQUIRED

收款人相关信息。

Show child parameters

totalCount Integer  REQUIRED

查询结果的总条目数。

更多信息:

  • 最大长度:8 字符

totalPageNumber Integer  REQUIRED

查询结果的总页数。

更多信息:

  • 最大长度:8 字符

currentPageNumber Integer  REQUIRED

当前页码。

更多信息:

  • 最大长度:8 字符
API Explorer

请求

URL
Case
Samples using beneficiaryNick
请求体

响应

Case
Samples using beneficiaryNick
Case description
For inquiry with beneficiaryNick
响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。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_EXCEPTIONUThe API call is failed, which is caused by unknown reasons.

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

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.

使用正确的用户信息重试

@2024 WorldFirst