Skip to content

The Available Balance fell below the threshold

POST

On by default. Sent to every Callback Endpoint in the Mode.

Gateway-Signature
required
string

t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>. During a secret rotation both secrets sign for 24 hours and the header carries two v1 values.

Example

t=1793980802,v1=9f2c…
Media typeapplication/json
object
id
required

Deduplicate on this. Delivery is at least once.

string

Example

evt_01J9…
type
required
string
Allowed values: payment.confirmed payment.reversed payment.seen checkout.expired balance.low balance.empty test
created_at
required
string format: date-time
mode
required
string
Allowed values: live test
type
required
string
Allowed value: balance.low
data
required
object
balance
required
object
mode
required
string
Allowed values: live test
state
required

ok covers new Checkouts. low is below the Merchant’s threshold. empty means new live Checkouts are refused. not_billed is Test mode, which is free and has no Prepaid Balance.

string
Allowed values: ok low empty not_billed
prepaid_balance
required

The Merchant’s credit, to one micro-USD. It can go slightly negative, and the next Recharge covers that.

string
/^-?[0-9]+(\.[0-9]+)?$/

Example

120.500000
held_amount
required

The part of the Prepaid Balance set aside for open Checkouts.

Example

0.850000
available_balance
required

The Prepaid Balance minus every Hold, so it can be negative. A new live Checkout needs enough of it.

string
/^-?[0-9]+(\.[0-9]+)?$/

Example

119.650000
low_balance_threshold
required

The Available Balance below which balance.low is sent.

Example

20.000000

Any 2xx within 10 seconds counts as delivered. Anything else retries for 3 days.