Skip to content
Draft: the API is under development and may change before the first release

Balances and settlement

GET /balances returns one entry per currency. All values are integers in minor units.

Field Meaning
available Can be paid out. Never negative.
pending Received, waiting for settlement.
reserve Held against chargebacks.
hold Reserved for payouts and refunds in progress.
debt What you owe after chargebacks.
{ "object": "balance", "currency": "CLP", "available": 500000, "pending": 120000, "reserve": 30000, "hold": 50000, "debt": 0 }
  • A received payment first sits in pending. When its settlement time comes, and it has no hold, no merchant block and no open chargeback, it moves to available.
  • A part is kept in reserve and returned after the reserve period set in your terms.
  • Creating a payout or a refund moves the amount (and fee) from available to hold. It is spent when the operation succeeds and returned when it fails or is canceled.
  • After a chargeback, if funds do not cover it, the shortfall becomes debt. It is repaid from later available funds. Payouts and refunds are blocked while debt is above zero.

The balance changes are also sent as balance.updated events. Settlement timing and reserve terms are part of the merchant agreement.