Skip to main content
GET
/
balance
Get Balance
curl --request GET \
  --url https://api.payviox.com/balance \
  --header 'Authorization: Bearer <token>'
{
  "balance": 1500000,
  "payout_balance": 500000
}

Documentation Index

Fetch the complete documentation index at: https://docs.payviox.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Returns your current business balance and payout balance in cents. Use this endpoint to programmatically check your available funds.
All amounts are returned in cents (e.g., 1500000 = $15,000.00).

​
Authentication

This endpoint requires your Secret API Key (server-side only). See Authentication for details. 
Authorization: Bearer sk_live_xxxxxxxxxxxx
Never expose your Secret API Key in client-side code. This endpoint should only be called from your backend server.

​
Example Requests

curl https://api.payviox.com/balance \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxx"

​
Example Response

{
  "balance": 1500000,
  "payout_balance": 500000
}

​
Error Responses

Returned when the API key is missing or invalid. This endpoint requires your Secret API Key.How to resolve: Ensure you are sending a valid Secret API key in the Authorization: Bearer header. Public API keys are not accepted for this endpoint.
{
  "error": "Unauthorized"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Balance retrieved successfully

​
balance
integer

Current business balance in cents (e.g., 1500000 = $15,000.00)

​
payout_balance
integer

Current payout balance in cents (e.g., 500000 = $5,000.00)