Usage

Syntax

kobana <product> <resource> <method> [flags]

Available products:

Product	Description
banking	Gateway Bancário — charges, payments, transfers (API v1 and v2)
finance	Financeiro Inteligente — payables and receivables, transactions, cash flow
billing	Faturamento Automático — subscriptions, plans, invoices, tax documents
inbox	Autonomous Inbox — inboxes, agents, e-mails, webhooks (API v1)

The inbox product has its own API, credentials and requirements — see Authentication.

Top-level banking resources (the API version — v1 or v2 — is resolved from the spec and never appears in the command):

Command	Description
charge	Charges — Pix, recurring Pix
payment	Payments — bank billets, Pix, taxes, utilities
transfer	Transfers — Pix, TED, internal
financial	Financial — accounts, balances, statements
admin	Administration — subaccounts, users
mailbox	Mailbox — EDI, files
data	Queries — bank billets, Pix QR codes
security	Access tokens
bank-billets, customers, webhooks, …	Bank billets, customers and other v1 resources

inbox resources: workspaces, inboxes, emails, agents, agent-runs, webhooks, system-events — each maps to the equivalent model in the API Reference.

Use kobana <product> --help for the full list.

Examples

# List bank billets with a filter
kobana banking bank-billets list \
  --params '{"status": "opened", "per_page": 25}' \
  --fields "id,amount,status,due_at"

# Create a Pix charge
kobana banking charge pix create \
  --json '{"amount": 99.90, "pix_account_uid": "UID"}'

# Check a balance
kobana banking financial accounts balances list \
  --params '{"financial_account_uid": "UID"}'

# Pix transfer
kobana banking transfer pix create \
  --json '{"amount": 500, "pix_key": "email@example.com"}'

# List with automatic pagination (NDJSON)
kobana banking charge pix list --page-all --fields "uid,amount,status"

# Get bank billet details
kobana banking bank-billets get --params '{"id": 12345}'

# Cancel a bank billet
kobana banking bank-billets cancel --params '{"id": 12345}'

# Dry-run — see the request without executing it
kobana banking charge pix create --json '{"amount": 100}' --dry-run

# Table output
kobana banking bank-billets list --output-format table

# Save the response to a file
kobana banking bank-billets get --params '{"id": 12345}' --output boleto.json

Autonomous Inbox

kobana inbox emails list --fields "id,subject,received_at"

kobana inbox webhooks deliveries replay \
  --params '{"id": "WEBHOOK_ID", "deliveryId": "DELIVERY_ID"}'

Next steps

• Schema introspection — inspect any endpoint's parameters and body.
• Global flags — every flag a command accepts.
• Helpers — +verb shortcuts for common workflows.