Balance

Retrieve the current balance of your IIMMPACT account. This endpoint provides real-time access to your account details, including balance, account name, and access level.

INFO

The balance returned includes pending transactions. For a detailed breakdown, see Balance Statement or view it from the Dashboard.

API Endpoint

GET https://api.iimmpact.com/v2/balance

Request Headers

Header	Description	Required
X-Api-Key	Your API key	Yes
X-Timestamp	Unix timestamp in seconds	Yes
X-Nonce	Unique request identifier	Yes
X-Signature	HMAC-SHA256 signature (v1=...)	Yes

See API Key Authentication for how to sign your requests.

Response 200

Field	Type	Description
data	object	The data parameter contains the requested data associated with the user. It provides information such as account details, transaction history, or other relevant data.
data.account	string	User's account number
data.name	string	User's name
data.balance	number	User's current balance
data.level	string	User's unique pricing group within the system
data.access	number	0 = full access (can execute payments via /v2/topup), 50 = read-only access

Example Response:

{
  "data": {
    "account": "00000",
    "name": "Demo",
    "balance": 48.6333,
    "level": "12",
    "access": 0
  }
}