Query your real-time merchant settlement balance, including available funds, pending transactions, and reserve amounts.
The Balance endpoint allows you to programmatically retrieve the current state of your Checkout settlement account at any time. The response categorizes your funds into four components:
- Available Balance: Funds that have fully settled from your Checkout collections, net of fees and rolling reserves.
- Pending Balance: Funds from your Checkout collections that have not yet settled and are not available for use. Fees and rolling reserves are not deducted at this stage.
- Freeze Reserve Balance: Funds temporarily held to cover potential chargebacks or refunds. These funds are not available for immediate withdrawal.
- Rolling Reserve: A percentage of processed transactions held in reserve over a defined rolling period, released gradually to mitigate future risk.
This endpoint is particularly useful for merchants who require real-time balance visibility within their own dashboards or internal systems.