API 查询余额
大约 2 分钟
请求
余额查询 API 使商户可查询 Smilepayz 账户的实时余额，支持收款账户、付款账户等。
请求路径：
沙盒：
https://sandbox-gateway.smilepayz.com/v2.0/inquiry-balance
生产：https://gateway.smilepayz.com/v2.0/inquiry-balance
请求头参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | 固定值：application/json |
| X-TIMESTAMP | M | String | ISO 8601 日期时间，带时区 须为当前服务器时间，误差在 ±5 分钟内 |
| X-SIGNATURE | M | String | 请求签名 参见签名生成 |
| X-PARTNER-ID | M | String | 商户 ID（merchantID） |
请求体参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| accountNo | M | String(128) | 商户账户标识 用于指定要查余额的账户 |
| balanceTypes | M | List(String) | 要查询的余额类型 默认：["BALANCE"] |
重要说明
1. 沙盒：
accountNo使用随机字符串用于测试
2. 生产：accountNo从商户后台获取，参见如何获取生产账户号
3. 收款账户： 用于入账交易资金
4. 付款账户： 用于付款、提现
5. 账户转账： 参见账户转账指南
请求体示例
Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+08:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001
{
"accountNo": "21820030202403071031",
"balanceTypes": ["BALANCE"]
}
响应
HTTP 响应
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | application/json |
| X-TIMESTAMP | M | String | ISO 8601 日期时间，带时区 |
响应体参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| code | M | String | 状态码，00 表示成功 |
| message | M | String | 状态说明 |
| accountNo | O | String | 与请求一致的账户号 |
| name | O | String | 账户名称或描述 |
| balanceTypes | O | Array | 请求的余额类型 |
| accountInfos | M | Object | 余额详情 含 balanceType、amount（currency: VND, value）、availableBalance（currency: VND, value）等 参见货币模型 |
| additionalInfo | O | Object | 扩展信息 |
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+08:00
{
"code": "00",
"message": "成功",
"accountNo": "21820030202403071031",
"name": "越南收款账户",
"balanceTypes": ["BALANCE"],
"accountInfos": {
"balanceType": "BALANCE",
"amount": {
"currency": "VND",
"value": "250000"
},
"availableBalance": {
"currency": "VND",
"value": "250000"
}
}
}