Get a list of all low balance alerts for a customer

🚧 Coming soon

The GET {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance endpoint allows you to retrieve all low balance alerts that have been configured for a specific account under a customer. These alerts help ensure that stakeholders are notified when account balances fall below defined thresholds, enabling proactive funding and uninterrupted reward distribution. This endpoint is especially useful for auditing existing alerts, reviewing notification settings, or confirming that alerts are properly configured for critical accounts.

Use case

Acme Wellness manages multiple reward accounts for its client, Zanzibar Health Group. One of these accounts has a low balance alert set to notify the HR team when funds drop below $100. To ensure the alert is still active and correctly configured, Acme uses this endpoint to retrieve all low balance alerts associated with the account. By reviewing the alert settings, Acme can confirm the alert threshold is accurate, the correct recipients are being notified, and no duplicate or outdated alerts exist.

Use the following endpoint to get a list of all low balance alerts for a specific 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:

The following query parameters can be appended to the end of URL to pass additional information to the server

Here is an example of the returned payload:

{
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  },
  "lowBalanceAlerts": [
    {
      "createdAt": "2025-07-15T17:00:04.933Z",
      "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: