支付接口
接口描述:
商户系统向 支付系统发起账户余额查询请求,支付系统在收到请求后,验证处理并返回结果
业务方向
商户系统 -> 支付系统
安全约束
IP 白名单验证
请求数据签名验证
请求URL:
/api/balance/query
请求方式:
POST
Header
| 参数名 | 必需 |
类型 | 说明 |
|---|---|---|---|
| Content-Type | 是 | string | application/json |
| Accept | 是 | string | application/json |
请求参数:
| 参数名 | 必需 |
类型 | 数据规格 |
说明 |
|---|---|---|---|---|
| merchantNo | 是 | long | 不能为null,最大长度:20 | 商户号(咨询客服) |
| timestamp | 是 | long | 最大长度:12 | 毫秒级时间戳 |
| sign | 是 | String | 最大长度:64 | 签名数据 |
调用示例:
shell
curl --request POST \
--url https://xxx.com/api/balance/query \
--header 'Content-type: application/json' \
--header 'Accept: application/json' \
--data '{
"merchantNo": 22190316182634496,
"sign": "c4d70f51535bf88788edcdc695926cee",
"timestamp": 1767168259218
}'
json
{
"merchantNo": 22190316182634496,
"sign": "c4d70f51535bf88788edcdc695926cee",
"timestamp": 1767168259218
}
返回示例:
成功响应时
{
"data": {
"merchantNo": 22190316182634496,
"currency": 1,
"clearingAmount": 200,
"availableBalance": 6308.8,
"freezeAmount": 200,
"timestamp": 1767168260372,
"sign": "1390fa933490a69fa2607e0158bb2b69"
},
"code": "0",
"message": "Successful"
}
错误时返回
{
"message": "账户不可用",
"code": "-1"
}
返回参数说明:
参数名 |
类型 |
说明 |
|---|---|---|
| code | String | 状态码 : 字符串0表示成功 |
| msg | String | 结果描述信息 |
| data | Object | 结果数据 |
data 数据结构说明:
参数名 |
类型 |
说明 |
|---|---|---|
| merchantNo | long | 商户号 |
| sign | String | 签名 |
| currency | int | 币种,1是 CNY 人民币 |
| timestamp | long | 时间戳 |
| clearingAmount | dicimal | 待结算金额 |
| freezeAmount | dicimal | 冻结金额 |
| availableBalance | dicimal | 可用金额 |