Query Balance
Interface Gateway
URL address:
https://pay.xxx.io/pay/balancequery
Tips
This interface is a test interface, please ask the sales person for it
Request Parameter
Parameter Name | Variable Name | Type | Required | Example | Comment |
---|---|---|---|---|---|
Merchant UID | mchid | string | TRUE | 100000 | Merchant UID |
Example:
{
"mchid": 100000
}
Response Result
Result Name | Variable Name | Type | Required | Example | Comment |
---|---|---|---|---|---|
Result Code | result_code | string | TRUE | OK | Result Code. OK: Success, Other: Failure |
Return Message | result_msg | string | TRUE | SUCCESS | Prompt Information. SUCCESS: success |
Payload | charge | object | TRUE | Return the payment payload object (please see the specific data below) |
Success Example:
{
"result_code": "OK",
"result_msg": "SUCCESS",
"charge": [
{
"uid": 100000,
"currency": "INR",
"limit_credits": "-1000000000.000",
"security_deposit_credits": "0.000",
"unsettled_credits": "51356.336",
"hold_credits": "0.000",
"commission_credits": "229.470",
"available_credits": "48382.870"
},
{
"uid": 100000,
"currency": "VND",
"limit_credits": "-1000000000.000",
"security_deposit_credits": "0.000",
"unsettled_credits": "126131.336",
"hold_credits": "0.000",
"commission_credits": "229.470",
"available_credits": "-42728.130"
}
]
}
Error Example:
{
"error_msg": "Invalid Request.[ Request header [authentication] Failure.]",
"error_code": 400000
}
Tips
[success] This is the successful return information, only when result_code=OK and result_msg= SUCCESS in the returned JSON data can charge
[error] This is the error return information only have error_code and error_msg in the returned JSON data