Skip to main content

Helpers

Helpers are commands prefixed with + that provide multi-step workflows the dynamic commands alone cannot: simplified interfaces, batch operations, or calls composed across multiple endpoints. They do not wrap a single API call already available through the dynamic commands — every helper flag controls orchestration logic, not a reshaped version of --params/--json.

Today's helpers belong to the Banking Gateway, and are available from the same binary whichever product you use:

HelperDescription
+emitirSimplified bank billet creation with named flags
+cancelar-loteBatch-cancel multiple bank billets by id
+cobrarSimplified Pix charge creation with named flags
# Issue a bank billet
kobana +emitir --valor 150.50 --vencimento 2026-05-01 \
--nome "Maria Silva" --cpf-cnpj "012.345.678-90" --carteira 1

# Create a Pix charge
kobana +cobrar --valor 99.90 --conta-pix "UID" \
--nome "João" --cpf-cnpj "012.345.678-90"

# Batch-cancel bank billets
kobana +cancelar-lote --ids "123,456,789"

Next steps​

  • Usage — the dynamic commands these helpers sit alongside.
  • Schema introspection — inspect the underlying endpoints a helper calls.