API ReferenceSettlements
Get balance summary
Returns the merchant's current balance breakdown: available balance for withdrawal, total collected from payments, and total already settled.
Authorization
privy AuthorizationBearer <token>
Privy JWT authentication for dashboard and management endpoints. This is used internally by the Bag Dashboard and is not intended for direct API integrations. Use API keys instead.
In: header
Response Body
application/json
application/json
curl -X GET "https://api.justusebag.xyz/api/settlements/balance"{
"status": "success",
"availableBalance": 1250.5,
"totalCollected": 3750.5,
"totalSettled": 2500
}{
"status": "error",
"message": "Invalid or revoked API key",
"code": "UNAUTHORIZED",
"hint": "Include a valid API key in the Authorization header: Bearer bag_live_sk_..."
}