Skip to main content
GET
/
v1
/
merchant
/
balance-alerts
/
{currency}
Retrieve a balance alert threshold
curl --request GET \
  --url https://api.antonpayments.com/v1/merchant/balance-alerts/{currency} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_id": "<string>",
  "currency": "USD",
  "threshold_amount": "1234.56",
  "enabled": true,
  "currently_latched": true,
  "created_at": "2026-04-15T14:30:00Z",
  "updated_at": "2026-04-15T14:30:00Z",
  "last_fired_at": "2026-04-15T14:30:00Z"
}

Authorizations

​
Authorization
string
header
required

API keys are opaque strings prefixed by environment:

  • ak_live_* — production keys, accepted only on api.antonpayments.com.
  • ak_test_* — sandbox keys, accepted only on api.antonpayments.dev.

Include your key in the Authorization header: Bearer ak_test_....

Path Parameters

​
currency
string
required

ISO 4217 currency code (or stablecoin / crypto symbol). ISO 4217 three-letter currency code.

Pattern: ^[A-Z]{3}$
Example:

"USD"

Response

Threshold.

A per-(merchant, currency) balance.low threshold. Fires the balance.low webhook once when the merchant's available balance drops below threshold_amount and is not already latched; clears the latch when the balance rises back to at-or-above the threshold.

​
id
string<uuid>
required
​
merchant_id
string
required
Pattern: ^mer_[a-zA-Z0-9]+$
​
currency
string
required

ISO 4217 three-letter currency code.

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
threshold_amount
string
required

Decimal amount as a string, never a float. Up to 12 whole digits.

Pattern: ^-?\d{1,12}(\.\d+)?$
Example:

"1234.56"

​
enabled
boolean
required

When false, the threshold is ignored by the evaluator.

​
currently_latched
boolean
required

true when a balance.low event has fired and the balance has not yet recovered above the threshold. Read-only — the dashboard can use this to surface "currently alerting" status.

​
created_at
string<date-time>
required

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

​
updated_at
string<date-time>
required

RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

​
last_fired_at
string<date-time>

When the most recent balance.low fired for this row.

Example:

"2026-04-15T14:30:00Z"