Delete a low balance alert for a customer account

🚧 Coming soon

Use DELETE {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID} to delete a low balance alert configured for a specific account under a customer. Low balance alerts are used to notify stakeholders when an account’s balance drops below a defined threshold. Removing an alert may be necessary when thresholds change, accounts are restructured, or notifications are no longer needed. Using delete option, you can maintain clean and relevant alert configurations, ensuring that only necessary notifications are active.

Use case

Acme Wellness uses low balance alerts to monitor funding levels in customer accounts that support automated wellness rewards. A customer updates their funding strategy and no longer needs one of the alerts previously set on their rewards account. The admin then deleted the alert using this endpoint. Once deleted, the account will no longer trigger notifications for that specific threshold, reducing unnecessary alerts.

Use the following endpoint to delete a low balance alert:

The following parameters 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. customerIdentifier is essential when working with endpoints that involve customer-specific data, especially when multiple customers may have accounts with similar structures or identifiers:

Here is an example of the returned payload:

{
  "balanceAlertID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "ACTIVE"
}

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