Balance
Check the available and pending balance held by our licensed payment partner.
The balance reflects funds available for payouts. Requires a private key.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /balance | Retrieve balance |
The Balance object
totalnumberoptionalEverything you hold:
available plus pending plus reserved plus disputed (plus in.transit and hold, always zero).availablenumberoptionalFunds available for immediate transfers.
pendingnumberoptionalRecent transactions not yet settled (T+1 to T+3).
reservednumberoptionalFunds reserved for in-flight operations.
disputednumberoptionalLive only. Held against open disputes, taken from
available when a dispute opens. It returns to available if you win, and leaves if you lose.in.transitnumberoptionalReserved, always
0. The key contains a dot, so read it as balance["in.transit"].holdnumberoptionalReserved, always
0.creditnumberoptionalReserved, always
0.currencystringoptionalISO 4217 code of the balance.
environmentstringoptionallive or sandbox.balance.updated event
Subscribe to balance.updated, or infer changes from payment.succeeded, transfer.succeeded,
and refund.succeeded webhooks.