Account Balance

Balance Notes

Each merchant account has a default USDT account plus the local market currency account (2 accounts in total).
Available amount for payout/withdrawal = balance - locked amount.
To avoid losing trailing zeros during conversions (e.g. 0.0000), amounts in this API are returned as strings.

Balance Query

Endpoint

https://{$api_host}/api/balance

Request Parameters

Field	Key	Required	Type	Example	Description
Merchant ID	merid	Yes	string	10086	Merchant ID assigned by the platform (not the login account).
Currency	cur	No	string	PKR	Currency code (uppercase). If omitted, balances for all currencies are returned. Refer to your account settings and Common Conventions.
Signature	sign	Yes	string	c380bec2bfd727a4.....	Signature. See the signature algorithm.

Request Example

{
  "merid": "10086",
  "cur": "USDT",
  "sign": "c8bbeab3ffb1f0f16f4...."
}

Amounts are returned as strings to preserve precision and avoid losing trailing zeros due to conversions.

Response Parameters

Field	Key	Type	Example	Description
Merchant ID	merid	string	10086	Merchant ID assigned by the platform (not the login account).
Currency	cur	string	USDT	Currency code.
Balance	bal	string	100.9900	Balance (4 decimals). Type is string.
Locked Amount	lock	string	1.0000	Locked amount (4 decimals). Type is string.
Exception Amount	excpt	string	2.0000	Exception amount (4 decimals). Type is string.

Response Example (with `cur`)

{
  "data": {
    "merid": "10086",
    "cur": "USDT",
    "bal": "100.2000",
    "lock": "0.0000",
    "excpt": "0.0000"
  }
}

Response Example (without `cur`)

{
  "list": [
    {
      "merid": "10086",
      "cur": "USDT",
      "bal": "100.2000",
      "lock": "0.0000",
      "excpt": "0.0000"
    },
    {
      "merid": "10086",
      "cur": "PKR",
      "bal": "100.2000",
      "lock": "0.0000",
      "excpt": "0.0000"
    }
  ]
}