Payment Gateway Develop API DocsPayment Gateway Develop API Docs
  • English
  • 简体中文
  • English
  • 简体中文
  • Introduction
  • General
    • Business Process
    • API Rule
    • Response Code
  • API
    • Order Payment
    • Order Payout
    • Notify Payment
    • Notify Payout
    • Query Order
    • Query Balance
  • Appendix
    • Banks

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 NameVariable NameTypeRequiredExampleComment
Merchant UIDmchidstringTRUE100000Merchant UID

Example:

{
	"mchid": 100000
}

Response Result

Result NameVariable NameTypeRequiredExampleComment
Result Coderesult_codestringTRUEOKResult Code. OK: Success, Other: Failure
Return Messageresult_msgstringTRUESUCCESSPrompt Information. SUCCESS: success
PayloadchargeobjectTRUEReturn 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

Prev
Query Order