日终余额查询
- Endpoint:
POST /aggregate-pay/api/gateway/dayEndBalanceQuery - Tags: 资金账户(老)
Description
返回指定日期及时区下的余额信息
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
Content-Type | header | string | Yes | ||
sign | header | string | Yes | 签名信息请参考技术文档 |
Parameter Examples
Content-Type:"application/json"sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
version | string | Yes | 接口版本 当前值为:1.3 | ||
keyVersion | string | Yes | maxLength: 8 | 密钥版本 当前值为:1 | |
requestTime | string | Yes | maxLength: 32 | 请求时间,符合rfc3339规范,格式:yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内 | |
appId | string | Yes | maxLength: 64 | 商户应用Id,PayerMax分配给商户应用的唯一标识 | |
merchantNo | string | No | maxLength: 32 | 商户号,商户与PayerMax业务签约时生成的唯一标识 | |
data | object | Yes | |||
data.accountCurrency | string | No | maxLength: 3 | 符合ISO 4217规范. 当未指定币种时,返回全部 | |
data.accountType | array[string] | No | -ACQUIRING 收单账户 -DISBURSEMENT 代发账户可用余额户 当未指定账户类型时,返回全部 | ||
data.inquiryDate | string | Yes | maxLength: 32 | 支持查询近90天 | |
data.timezone | string | Yes | maxLength: 32 | 目前只支持(UTC 、CST),不区分大小写 |
Example
json
{
"version": "1.3",
"keyVersion": "1",
"requestTime": "{{requestTime}}",
"appId": "f79e7cd18fbc43e3a085adab88b9d61f",
"merchantNo": "SP12106963",
"data": {
"accountCurrency": "USD",
"accountType": [],
"inquiryDate": "2023-06-20",
"timezone": "utc"
}
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
data | object | Yes | |||
data.timezone | string | Yes | maxLength: 32 | 目前只支持(UTC 、CST) | |
data.acctTime | string | Yes | maxLength: 63 | 符合rfc3339规范,格式:yyyy-MM-dd’T’HH:mm:ss.SSSXXX | |
data.accountEndDayTimeTypes | array[object] | Yes | 查询到的账户类型 | ||
data.accountEndDayTimeTypes[].inflowAmount | number (20,2) | Yes | 当日内流入金额 | ||
data.accountEndDayTimeTypes[].initalBalance | number (20,2) | Yes | |||
data.accountEndDayTimeTypes[].endBalance | number (20,2) | Yes | 计算公式 endBalance = initalBalance+ inflowAmount - outflowAmount | ||
data.accountEndDayTimeTypes[].accountType | string | Yes | maxLength: 32 | ||
data.accountEndDayTimeTypes[].currency | string | Yes | maxLength: 3 | 符合ISO 4217规范. 当未指定币种时,返回全部余额大于0的币种 | |
data.accountEndDayTimeTypes[].outflowAmount | number (20,2) | Yes | 当日内流出金额 | ||
data.errorCode | string | Yes | maxLength: 32 | ||
data.errorMsg | string | Yes | maxLength: 256 | ||
code | string | Yes | 返回码,’APPLY_SUCCESS’代表成功 | ||
msg | string | Yes | 返回描述,’Success.’ |
Response Example
json
{
"msg": "",
"code": "APPLY_SUCCESS",
"data": {
"acctTime": "2023-02-20",
"timezone": "CST",
"accountEndDayTimeTypes": [
{
"inflowAmount": 0,
"initalBalance": 43820,
"endBalance": 33820,
"accountType": "DISBURSEMENT",
"currency": "IDR",
"outflowAmount": 10000
},
{
"inflowAmount": 0,
"initalBalance": 0,
"endBalance": 0,
"accountType": "DISBURSEMENT",
"currency": "EGP",
"outflowAmount": 0
},
{
"inflowAmount": 0,
"initalBalance": 0,
"endBalance": 0,
"accountType": "DISBURSEMENT",
"currency": "MYR",
"outflowAmount": 0
},
{
"inflowAmount": 0,
"initalBalance": 0,
"endBalance": 0,
"accountType": "DISBURSEMENT",
"currency": "PHP",
"outflowAmount": 0
}
]
}
}