Balance
Endpoint
POST /v1/api/balanceRequest
Parameters
| Key | Required | Type | Example | Description |
|---|---|---|---|---|
mcode | Yes | string | M10086 | Merchant ID |
cur | No | string | PHP | Target currency. If not provided, returns all wallets. Corresponding key is List |
ts | Yes | string | 1785138705251 | Request milli timestamp len 13 |
sign | Yes | string | c380be... | Signature value |
Example
{
"mcode": "M10086",
"cur": "PHP",
"ts": "1785138705251",
"sign": "c8bbeab3ffb1f0f16f4...."
}Response
Parameters
| Field | Key | Type | Description |
|---|---|---|---|
| Status code | code | number | Response code, 0 means success |
| Response data | data | object | Response payload object |
| ─ Merchant code | data.mcode | string | Merchant ID |
| ─ Currency | data.cur | string | Currency code |
| ─ Balance | data.bal | string | Available balance |
| ─ Locked amount | data.lock | string | Locked amount |
| ─ Exception amount | data.excpt | string | Exception amount |
| ─ Settlement amount | data.stl | string | Settlement amount |
| ─ Signature | data.sign | string | Response signature |
Example
Response example when cur is provided
{
"code": 0,
"data": {
"mcode": "M10086",
"cur": "PHP",
"bal": "100.2000",
"lock": "0.0000",
"excpt": "0.0000",
"stl": "100.2000",
"sign": "xxxx"
}
}{
"code": 0,
"data": null,
"list": [
{
"mcode": "B123123",
"cur": "",
"bal": "572.8000",
"lock": "0.0000",
"excpt": "0.0000",
"stl": "",
"sign": "8jPS6eaid00qyRtJoMt4kE0ZFIv8vL6xauAbQmY27HA="
},
{
"mcode": "B123123",
"cur": "",
"bal": "0.0000",
"lock": "0.0000",
"excpt": "0.0000",
"stl": "",
"sign": "xWFBW9KPCCUcySDBuLKkJVLj9AYg9kEBY9LRIb8cSnE="
},
{
"mcode": "B123123",
"cur": "",
"bal": "0.0000",
"lock": "0.0000",
"excpt": "0.0000",
"stl": "",
"sign": "xWFBW9KPCCUcySDBuLKkJVLj9AYg9kEBY9LRIb8cSnE="
}
]
}