For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • GETGet Balance
LogoLogo
StatusDashboard
API ReferencePix Balance

Get Balance

GET
https://api.brzip.com.br/api/v1/pix/balance
GET
/api/v1/pix/balance
$curl -G https://api.brzip.com.br/api/v1/pix/balance \
>     -d account_id=acc-550e8400-e29b-41d4
200Retrieved
1{
2  "success": true,
3  "data": {
4    "account_id": "acc-550e8400-e29b-41d4",
5    "available_balance": "10000.00",
6    "blocked_balance": "500.00",
7    "total_balance": "10500.00",
8    "currency": "BRL",
9    "updated_at": "2025-01-15T10:00:00Z"
10  }
11}

Queries the account balance. If account_id is omitted, uses the client’s default account.

Scope: pix:balance:read

Was this page helpful?
Previous

List Transactions

Next
Built with

Query parameters

account_idstringOptional

Account ID (optional, uses default account if omitted)

Response

Account balance
successboolean
dataobject