Skip to main content
GET
/
v1
/
balance
Get account balance
curl --request GET \
  --url https://api.yuvexpay.com/v1/balance \
  --header 'Authorization: Bearer <token>'
{
  "balance": {
    "available": 13.45,
    "frozen": 0,
    "held": 10.2,
    "total": 23.65,
    "currency": "BRL",
    "environment": "PRODUCTION",
    "updatedAt": "2026-05-06T12:00:00.000Z"
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Response

Balance retrieved.

​
balance
object
required

Account balance for the company associated with the API key. The four buckets available, frozen, and held are independent and additive — total = available + frozen + held.