Set a low balance alert for a customer account

🚧 Coming soon

The low balance alert feature in the Tango API allows you to create, update, and manage alerts that notify users when an account’s balance falls below a specified threshold. This helps ensure that reward programs remain funded and that users are aware of low balances before attempting to redeem rewards.

/no

Use case

Acme Wellness provides employees with monthly wellness stipends through individual spending accounts for their gym memberships. Acme developers use the following endpoint to ensure employees are notified when their wellness account balance drops below a certain threshold. Notified employees can then plan their spending or request a top-up.

Endpoint	Purpose
`POST {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance`	Set a low balance alert on my account.

When creating the low balance alert, you should specify that the alert applies only to the specific account identified in the request, not to all accounts under the customer. This is done by setting the allAccounts field to false in the data transfer object (DTO) used for the API call.
When processing the alert, the system uses the currency code, such as USD, EUR, that is associated with the specific account for which the alert is being set. This ensures that the balance threshold and notifications are handled in the correct currency for that account.

The following values are part of your URL path for this API request. customerIdentifier is a string used to identify the Group (Customer) that contains the account you are transacting from:

Path param	Data type	Requirement	Description
customerIdentifier	string	required	A unique identifier for the customer under which you are seeking details. The string must have 5-100 characters. (????)
accountIdentifier	string	required	Specify the exact account to be monitored. The string must have 5-100 characters. (???)

The following body parameters are used as part of the API request to the server to configure a low balance alert:

Body params	Data type	Requirement	Description
balanceAlertDisplayName	string	required	A friendly name for this low balance alert (will be displayed in the Tango Portal).
balanceAlertThreshold	string	required	The threshold amount that will trigger the low balance alert.
balanceAlertNotification	array of objects	optional	Send low balance notification emails to the following address(es). A provided list replaces the existing list, an empty list clears all existing emails, and a null/omitted value leaves the list unchanged.
emailAddress	string	optional	An individual email address to receive notifications as part of the `balanceAlertNotification` array.

Here is an example of the returned payload:

{
  "createdAt": "2025-08-12T19:52:13.608Z",
  "balanceAlertID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerIdentifier": "string",
  "accountIdentifier": "string",
  "balanceAlertDisplayName": "string",
  "balanceAlertThreshold": 0,
  "balanceAlertNotification": [
    {
      "emailAddress": "string"
    }
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response code	Meaning
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
403	The server understood the request but refuses to authorize it.
409	The server understands the request but cannot process it due to semantic errors.
500	A generic error occurred on the server.