QueryBalance API

Endpoints

Live POST https://pay.onlinepay.ai/balance/query

Sandbox POST https://testpay.onlinepay.ai/balance/query

Request Parameters

Parameter	Type	Required	Description
merNo	integer	Yes	Merchant Number, Unique identifier assigned to the merchant by the onlinepay payment platform when registering with onlinepay
sign	string	Yes	signature, MD5(merNo+version+PrivateKey) or RSA(merNo=123&version=V3.0.0)
version	string	Yes	V3.0.0
currency	string	No	If currency is null, query all currency, which unit is USDC

Example Request

{
  "merNo": 111111,
  "version": "V3.0.0",
  "sing":  "9D6FDF4880B00B002B1F2AB61AE9A721",
  "currency": "USD"
}

Responses Body

Parameter	Type	Required	Description
code	string	Yes	If the value is 00000, it will return success, other please refer to Error Code
message	string	Yes	Interface returns description
data	object	Yes	Request response data
-currency	integer	Yes
-balance	string	Yes	the amount can be withdrawn from the account
-unCheckedBalance	string	Yes	the unsettled amount from the account
-totalBalance	string	Yes	the sum of balance and unCheckedBalance

Example Responses

{
    "code":"00000",
    "message":"SUCCESS",
    "data":{
      "currency": "USD",
      "balance": "111111.11"
     }
}