View details of a low balance alert

Use GET {URI}/customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID} to retrieve the details of a specific low balance alert using the balance alert ID. This is useful for viewing the current configuration of an alert, such as the threshold amount, notification settings, and status.

Use case (GET)

The finance team at Acme Wellness wants to retrieve details of a specific low balance alert—such as its threshold, display name, and notification settings—so they can monitor account funding levels and ensure timely replenishment just like Tango portal. They use the following endpoint and parameters to retrieve the alert details:

Endpoint	Purpose
`GET {URI}/customers/{customerIdentifier}/accounts/ {accountIdentifier}/lowbalance/{balanceAlertID}`	Get a low balance alert for a specific Account under a Customer.

The following parameters are part of your URL path for this API request. Replace balanceAlertID with the actual ID of the alert you want to fetch:

Path param	Data type	Requirement	Description
customerIdentifier	string	required	The `customerIdentifier` for the Customer/Account combination under which you update the low balance alert.
accountIdentifier	string	required	The `accountIdentifier` for the Customer/Account combination under which you update the low balance alert.
balanceAlertID	uuid	required	The `lowBalanceIdentifier` for the Customer/Account/low balance combination under which you update the low balance alert.

Here is an example of the returned payload:

{
  "createdAt": "2025-07-15T17:00:04.933Z",
  "balanceAlertID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerIdentifier": "acme-wellness",
  "accountIdentifier": "marketing-team",
  "balanceAlertDisplayName": "Marketing Budget Alert",
  "balanceAlertThreshold": 500.00,
  "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.
404	The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.
500	Something went wrong on the server, but the server cannot be more specific about what the exact problem is.