Request
About 1 min
HTTP Request
Service Code | 11 |
---|---|
Name | API balance inquiry |
Version | 2.0 |
HTTP Method | POST |
Path | {Base URL}/v2.0/inquiry-balance |
Header Parameters
Area | Field | Attribute | Type | Description |
---|---|---|---|---|
Header | Content-Type | M | String | application/json |
X-TIMESTAMP | M | String | yyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00 | |
X-SIGNATURE | M | String | signature | |
X-PARTNER-ID | M | String | merchant Id |
Tips
X-SIGNATURE = SHA256withRSA(private_key, stringToSign)
private_key
is merchant rsa private keystringToSign = X-TIMESTAMP + "|" + merchant_secret + "|" + minify(requestBody)
minify(requestBody)
is convert the request parameters to JSON string, and then remove line breaks, spaces, and other escape characters.- we provide some development languages
minify
andSHA256withRSA
demo. please refer to signature
Body Parameters
Area | Field | Attribute | Type | Description |
---|---|---|---|---|
Body | accountNo | M | String(128) | the account of merchant |
balanceTypes | M | List(String) | default BALANCE |
Tips
- In sandbox you can fill random string , but if in prod you can find in merchant backend. detail clik how to get account no in productionthe balance of pay in is different from the payout
- you can find you account in merchant backend.
Finace
->Balance
' For the one merchant, there will be two accounts for the same currency: pay-in and pay-out. - Pay in Account used to collect the amount of all pay-in business
- The payout account is used to indicate the account used for pay-out , whereas the balance indicates the amount that can be used for pay out.
- The balance between the payin account and the payout account can be transferred between them. refer to how to transfer
Example Header – Balance Inquiry Request:
POST {Base URL}/v2.0/inquiry-balance HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-18T15:06:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001
{
"accountNo": "21220030202403071031",
"balanceTypes": [
"BALANCE"
]
}