Low Balance Threshold

Set the balance threshold at which you receive low balance alerts. When your account balance drops below this amount, notifications are sent to team members who have alerts enabled.

TIP

You can also configure this from the Dashboard UI.

API Endpoint

POST https://api.iimmpact.com/v2/low-balance-threshold

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.

Request Parameters (Query String)

INFO

This endpoint accepts parameters as query string parameters, not a JSON request body.

Example: POST /v2/low-balance-threshold?amount=1000

Parameter	Type	Required	Description
amount	string	Yes	Threshold amount in RM (minimum 1)

Response 200

Field	Type	Description
data	object	Response data
data.Status	string	Operation result
data.Email	string	Email address registered to the account
data.BalanceThreshold	number	The threshold amount that was set
data.Note	string	Confirmation message
@metadata	object	Response metadata
@metadata.status_code	number	HTTP status code
@metadata.last_updated	string	Timestamp of the update (GMT+8). Format: yyyy-MM-dd HH:mm:ss

Example Response:

{
  "data": {
    "Status": "Success",
    "Email": "your_email@gmail.com",
    "BalanceThreshold": 1000,
    "Note": "You will receive email notification when your balance drop below 1000"
  },
  "@metadata": {
    "status_code": 200,
    "last_updated": "2025-05-16 18:49:32"
  }
}