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

totalnumberfacultatif

Total balance (available + pending + reserved).

availablenumberfacultatif

Funds available for immediate transfers.

pendingnumberfacultatif

Recent transactions not yet settled (T+1 to T+3).

reservednumberfacultatif

Funds reserved for in-flight operations.

creditnumberfacultatif

Credit balance if applicable.

currencystringfacultatif

ISO 4217 code of the balance.

environmentstringfacultatif

live or sandbox.

balance.updated event

Subscribe to balance.updated, or infer changes from payment.succeeded, transfer.succeeded, and refund.succeeded webhooks.

Pages associées