inquiryBeneficiaryList需要签名验签
创建收款人并绑定收款人账号后，集成商可调用此接口查询某万里汇账号绑定的所有收款人。
报文结构
万里汇接口报文结构包括：请求头、请求体。
请求头
入参
accessToken String
用于OAuth校验的访问令牌。
更多信息：
- 最大长度：64 字符
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 字符
relationFilter Array<String>
需要查询的收款人类型。
可取值范围：
-
SAME_NAME 同名收款人 -
THIRD_PARTY 第三方收款人
当此字段为空时，万里汇返回所有类型的收款人。
pageSize Integer REQUIRED
每页包含的条目数。
更多信息：
- 最大长度：50 字符
pageNumber Integer REQUIRED
页码。
格式：1、2、3……
出参
result Result object REQUIRED
代表API 接口的调用结果。
responseId String REQUIRED
由万里汇定义，用于唯一标识某次响应的ID。
更多信息：
- 最大长度：32 字符
beneficiaries Array<Beneficiary> object REQUIRED
收款人相关信息。
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.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 | The API call is failed, which is caused by unknown reasons. | 服务器错误，若稍后重试问题依旧，联系万里汇技术支持以解决问题 |
| 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. | 使用正确的用户信息重试 |