Skip to content

Vexora API Documentation

Check Balance

Check Balance¶

Saudi Arabia APIs

Introduction · Response Code · Checkout · Check Deposit Status · Deposit WayCode · Check Balance · Webhook

Brief Description¶

Use this API to query the merchant account balance for Saudi Arabia.

Request URL¶

/v1/vexora/queryBalance

Request Method¶

Method: POST
Content-Type: application/json

Header	Required	Type	Description
merchantNo	Yes	String	Merchant number assigned by Vexora

Request Body Parameters¶

Name	Required	Type	Description
timestamp	Yes	String	Timestamp
sign	Yes	String	Request signature

{
  "timestamp": "1782878640000",
  "sign": "b6ffae957b1eaf7fe17e1636d2d9118e"
}

Response Parameters¶

Name	Required	Type	Description
msg	Yes	String	API request message
code	Yes	String	API request code. `0000` indicates the balance query request was accepted
timestamp	Yes	Integer	Response timestamp
success	Yes	Boolean	Whether the balance query request succeeded
data	Yes	Object	Response object
data.availableAmount	Yes	Float	Available balance
data.freezeAmount	Yes	Float	Frozen amount
data.unsettledAmount	Yes	Float	Unsettled amount

{
  "msg": "success",
  "code": "0000",
  "timestamp": 1782878641200,
  "success": true,
  "data": {
    "availableAmount": 9998989.1200,
    "unsettledAmount": 0.0000,
    "freezeAmount": 0.0000
  }
}