inquiryBalance需要签名验签
可调用inquiryBalance接口查询账户余额。
报文结构
万里汇接口报文结构包括:请求头,请求体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| 关于这些参数的解释说明,详见:请求头。 |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-CustomerId | 有条件要求 |
| 当平台客户操作商户账户时需要传递 |
Access-Token | 有条件要求 |
| 当用 OAUTH 授权时需要传递 |
入参
currencyList Array<String>
集成商查询的币种列表,为 ISO 4217 标准规定的三位字母货币代码。
若本字段为空,则会响应所有币种的余额信息。
balanceTypes Array<String>
该字段表示客户拥有的不同余额类型。
客户在不同业务场景下,可使用不同的余额类型对资金余额做分隔管理,作用是为了风险管控。
此字段的可取值为:
NORMAL_BALANCE
: 普通余额类型(即电商余额类型)。(默认)SAME_NAME_TOP_UP_BALANCE
: 同名充值余额类型。
当该字段为空时,
NORMAL_BALANCE
为默认取值。
出参
result Result REQUIRED
代表接口调用结果。
responseId String REQUIRED
由万里汇定义,用于唯一标识某次响应的ID。
该字段只有当 result.resultStatus =
S
时才会按需返回。
更多信息:
- 最大长度:32 字符
accountBalances Array<AccountBalance> REQUIRED
用户的账户信息列表,包括账号、账户币种、账户余额等信息。
该字段只有当 result.resultStatus =
S
时才会按需返回。
请求
响应
响应处理
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:
result.resultCode:系统结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
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:业务结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试。 |
ACCOUNT_NOT_EXIST | F | Account does not exist. | 账户不存在,使用其他账户重试。 |
SYSTEM_ERROR | F | System error. | 请勿重试,联系万里汇技术支持了解详情。 |
SERVICE_NOT_ALLOWED | F | Service not allowed. | 使用正确的信息重试,若问题依旧,联系万里汇技术支持以解决问题。 |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | 暂不支持该币种。 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 联系万里汇技术支持了解合约状态后重试。 |
ACCESS_TOKEN_EXPIRED | F | The access token expired. | 刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题。 |
AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | 当前授权关系不存在,请联系万里汇技术支持检查授权关系。 |