CLI Commands
pixcli charge
Create and manage Pix charges (cobranças)
Commands
pixcli charge create
Create a new immediate Pix charge (cobrança imediata).
pixcli charge create --amount 25.00 --key "+5511999999999" --description "Order #123"Output:
✅ Charge created
TxID: abc123def456
Amount: R$25.00
Status: ATIVA
Expires: 2026-03-20T10:00:00Z
Copy-paste: 00020126...Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--amount | Yes | — | Amount in BRL (e.g. 10.50) |
--key | No | Profile default | Recipient Pix key |
--description | No | — | Payment description |
--expiry | No | 3600 | Expiry in seconds |
--debtor-doc | No | — | Debtor CPF or CNPJ |
--debtor-name | No | — | Debtor name |
--txid | No | Auto-generated | Custom transaction ID |
Charge with debtor info
pixcli charge create \
--amount 150.00 \
--key "+5511999999999" \
--description "Invoice #456" \
--debtor-doc "12345678901" \
--debtor-name "João Silva" \
--expiry 7200JSON output for scripting
pixcli charge create --amount 25.00 --output json{
"txid": "abc123def456",
"status": "ATIVA",
"amount": "25.00",
"pix_key": "+5511999999999",
"expiration": 3600,
"created_at": "2026-03-19T10:00:00Z",
"brcode": "00020126580014br.gov.bcb.pix..."
}In sandbox mode, charges under R$10.00 are automatically confirmed by the Efí sandbox.
pixcli charge get
Get details of a charge by its transaction ID.
pixcli charge get abc123def456Output:
📋 Charge Details
TxID: abc123def456
Amount: R$25.00
Status: ATIVA
Description: Order #123
Created: 2026-03-19T10:00:00Z
Expires: 2026-03-19T11:00:00ZCharge Lifecycle
| Status | Meaning |
|---|---|
ATIVA | Active — waiting for payment |
CONCLUIDA | Completed — payment received |
REMOVIDA_PELO_USUARIO_RECEBEDOR | Removed by recipient |
REMOVIDA_PELO_PSP | Removed by PSP (expired) |
pixcli charge list
List recent charges.
pixcli charge list --days 7Output:
📋 Recent Charges (last 7 days)
abc123def456 R$25.00 ATIVA 2026-03-19T10:00:00Z
xyz789ghi012 R$50.00 CONCLUIDA 2026-03-18T15:30:00Z
mno345pqr678 R$10.00 CONCLUIDA 2026-03-17T09:00:00ZFlags
| Flag | Required | Default | Description |
|---|---|---|---|
--days | No | 7 | Number of days to look back |
--from | No | — | Start date (ISO 8601, overrides --days) |
--to | No | — | End date (ISO 8601) |
Filter by date range
pixcli charge list --from 2026-03-01T00:00:00Z --to 2026-03-15T23:59:59ZWhat is a TxID?
A TxID (Transaction ID) is a unique identifier for a Pix charge. It's generated by the PSP when you create a charge, or you can provide a custom one with --txid. The TxID is alphanumeric, 26–35 characters long, and is used to track the lifecycle of a charge.