Getting Started
First QR Code
Generate your first Pix QR code in seconds
QR code generation is fully offline — no API credentials needed.
Generate a Static QR Code
pixcli qr generate --key "+5511999999999" --amount 25.00 --name "LOJA EXEMPLO" --city "SAO PAULO"This renders a QR code directly in your terminal:
█████████████████████████████████
█████████████████████████████████
████ ▄▄▄▄▄ █▀▄▀▄▄█ ▄▄▄▄▄ ████
████ █ █ █▀ █▀██ █ █ ████
████ █▄▄▄█ █ ▄▀▄▄█ █▄▄▄█ ████
████▄▄▄▄▄▄▄█ ▀ █ █▄▄▄▄▄▄▄████
████▄▄ ▄▄▄▀▄▀█▀▄▄▄▄▀▄▀▄█████
████▀▄▀▄▀▄▄█▄▀█▀▄ ▄█▀█▄ █████
████▄▄▄▄▄▄▄█▄██▄█▄▄▄█▄██▄████
█████████████████████████████████
█████████████████████████████████
BR Code: 00020126580014br.gov.bcb.pix0136+5511999999999...The QR code works with any Pix-compatible banking app. Scan it to make a payment!
Save as PNG
pixcli qr generate \
--key "+5511999999999" \
--amount 25.00 \
--name "LOJA EXEMPLO" \
--city "SAO PAULO" \
--output qrcode.png \
--size 15This creates a qrcode.png file you can print, embed in invoices, or share.
Without an Amount (Open Value)
pixcli qr generate --key "email@example.com"This generates a static QR code where the payer decides the amount.
Decode a QR Code
Got a BR Code payload? Decode it to see what's inside:
pixcli qr decode "00020126580014br.gov.bcb.pix0136+5511999999999..."Output:
{
"format": "01",
"key": "+5511999999999",
"amount": "25.00",
"name": "LOJA EXEMPLO",
"city": "SAO PAULO",
"txid": "***"
}Understanding BR Code
The QR code contains an EMV-format payload called a BR Code. This is the standard defined by the Brazilian Central Bank for Pix payments. It encodes:
- Pix key — the recipient's identifier (CPF, CNPJ, email, phone, or EVP/random key)
- Amount — optional for static QR codes
- Merchant name — up to 25 characters
- Merchant city — up to 15 characters
- Transaction ID — optional identifier
- CRC16 checksum — integrity verification
Static vs Dynamic QR Codes
| Feature | Static | Dynamic |
|---|---|---|
| Generated offline | ✅ | ❌ (requires API) |
| Fixed amount | Optional | Required |
| Reusable | ✅ | Single-use |
| Tracks payment | ❌ | ✅ |
| Expiry | None | Configurable |
Static QR codes are generated locally with pixcli qr generate. Dynamic QR codes are created as part of a charge via the API — see pixcli charge.
Next Steps
- Configure API access to create dynamic charges
- CLI Commands Reference for the full command list