Saltar al contenido principal

Uso

Sintaxis​

kobana <producto> <recurso> <método> [flags]

Productos disponibles:

ProductoDescripción
bankingGateway Bancario — cobros, pagos, transferencias (API v1 y v2)
financeFinanzas Inteligentes — cuentas por pagar y por cobrar, movimientos, flujo de caja
billingFacturación Automática — suscripciones, planes, facturas, notas fiscales
inboxInbox Autónomo — inboxes, agents, correos, webhooks (API v1)

El producto inbox tiene API, credenciales y requisitos propios — ver Autenticación.

Recursos de nivel superior del producto banking (la versión de la API — v1 o v2 — se resuelve a partir de la spec y nunca aparece en el comando):

ComandoDescripción
chargeCobros — Pix, Pix automático
paymentPagos — boletos, Pix, tasas, servicios
transferTransferencias — Pix, TED, interna
financialFinanciero — cuentas, saldos, extractos
adminAdministración — subcuentas, usuarios
mailboxBuzón — EDI, archivos
dataConsultas — boletos, códigos QR Pix
securityTokens de acceso
bank-billets, customers, webhooks, …Boletos, clientes y demás recursos de la API v1

Recursos de inbox: workspaces, inboxes, emails, agents, agent-runs, webhooks, system-events — cada uno se corresponde con el modelo equivalente en la Referencia de la API.

Usa kobana <producto> --help para la lista completa.

Ejemplos​

# Listar boletos con filtro
kobana banking bank-billets list \
--params '{"status": "opened", "per_page": 25}' \
--fields "id,amount,status,due_at"

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

# Consultar saldo
kobana banking financial accounts balances list \
--params '{"financial_account_uid": "UID"}'

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

# Listar con paginación automática (NDJSON)
kobana banking charge pix list --page-all --fields "uid,amount,status"

# Ver detalles de un boleto
kobana banking bank-billets get --params '{"id": 12345}'

# Cancelar boleto
kobana banking bank-billets cancel --params '{"id": 12345}'

# Dry-run — ver la solicitud sin ejecutarla
kobana banking charge pix create --json '{"amount": 100}' --dry-run

# Salida en tabla
kobana banking bank-billets list --output-format table

# Guardar la respuesta en un archivo
kobana banking bank-billets get --params '{"id": 12345}' --output boleto.json

Inbox Autónomo​

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

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

Próximos pasos​