API DocsAPI Docs / GET /api/v1/payments/balance

GET /api/v1/payments/balance

Retrieves the current balance for the authenticated user.

Permissions

Response

200 OK

Returns the user's current balance.

Example

{
  "balance": 123.456
}

How the balance is computed

The returned figure is the spendable balance, and it is type-aware: see Payment System § How the balance is computed for the full table.

The point clients most often get wrong: pending withdrawal requests are already subtracted here. A withdrawal reduces this number from the moment it is created, not when an admin marks it . A client that subtracts its own pending withdrawals from this value will double-count them.