Balance
Check the available and pending balance held by our licensed payment partner.
The balance reflects funds available for payouts. Requires a secret key.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /balance | Retrieve balance |
The Balance object
totalnumberoptionalTotal balance (available + pending + reserved).
availablenumberoptionalFunds available for immediate transfers.
pendingnumberoptionalRecent transactions not yet settled (T+1 to T+3).
reservednumberoptionalFunds reserved for in-flight operations.
creditnumberoptionalCredit balance if applicable.
currencystringoptionalISO 4217 code of the balance.
environmentstringoptional`live` or `sandbox`.
balance.updated event
Subscribe to balance.updated, or infer changes from payment.succeeded,
transfer.succeeded, and refund.succeeded webhooks.