pixcli
CLI Commands

pixcli balance

Query your Pix account balance

Usage

pixcli balance

Shows the available balance for your configured PSP account.

Examples

Human output (default)

pixcli balance
πŸ’° Account Balance
   Available: R$1,250.00

JSON output

pixcli balance --output json
{
  "available": "1250.00"
}

Table output

pixcli balance --output table
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ Field     β”‚ Value      β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ Available β”‚ R$1,250.00 β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

With a specific profile

pixcli --profile production balance

Sandbox mode

pixcli --sandbox balance

Error Scenarios

No configuration

Error: No configuration found. Run `pixcli config init` first.

Invalid credentials

Error: Authentication failed (401 Unauthorized). Check your client_id and client_secret.

Network error

Error: Connection refused. Verify your internet connection and the PSP endpoint.

Use --verbose to see detailed request/response logs for debugging.

On this page