Recursos
Todo recurso de banking abaixo vem das specs OpenAPI v1 e v2 embutidas no CLI, as mesmas da Referência da API: o CLI chama exatamente os mesmos endpoints, então filtros, validação e comportamento são idênticos. A versão da API não entra no comando: /v1/bank_billets vira banking bank-billets e /v2/charge/pix vira banking charge pix.
kobana banking <recurso> <metodo> [flags]
Como ler estas páginas
--params carrega parâmetros de caminho e de query (uid, id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam, e vale a pena em todo list e get para economizar contexto. Veja Flags globais. Quando os parâmetros de um comando não estiverem óbvios, use a introspecção de schema.
O catálogo
| Recurso | Comando | Métodos |
|---|---|---|
| Boletos | bank-billets | list, create, get, update, cancel, duplicate, pay, send-email, send-sms, cancel-all create, protest update |
| Carteiras de cobrança | bank-billet-accounts | list, create, get, update, ask, set-default, validate |
| Pagamentos de boleto | bank-billet-payments | list, create, get, delete |
| Lotes de boletos | bank-billet-batches | list, create, get, delete, add-bank-billets, pdf, remove-bank-billet, zip |
| Exportação do lote | bank-billet-batch-exports | get |
| Carnês | installments | list, create, get, delete |
| Assinaturas | customer-subscriptions | list, create, get, update, delete, next-charge |
| Remessas | remittances | list, create, get, delete, raw, bulk create |
| Retornos | discharges | list, create, get, download, pay-off, reprocess |
| Registros de boleto | bank-billet-registrations | list, get |
| Boletos em remessa | bank-billet-remittances | list, get, delete, occurrence create, pending list |
| Boletos em retorno | bank-billet-discharges | list, get |
| Cobranças (v2) | charge | automatic-pix accounts list, automatic-pix accounts create, automatic-pix accounts get, automatic-pix accounts update, automatic-pix accounts delete, automatic-pix locations list, automatic-pix locations create, automatic-pix locations get, automatic-pix pix list, automatic-pix pix get, automatic-pix pix update, automatic-pix pix cancel, automatic-pix pix retry, automatic-pix recurrences list, automatic-pix recurrences create, automatic-pix recurrences pix, automatic-pix recurrences requests, automatic-pix recurrences get, automatic-pix recurrences update, automatic-pix recurrences cancel, automatic-pix requests list, automatic-pix requests get, automatic-pix requests update, automatic-pix requests cancel, payments list, payments create, payments get, payments delete, pix list, pix create, pix cancel, pix update, pix get, pix delete, pix commands get, pix-accounts list, pix-accounts create, pix-accounts get, pix-accounts update, pix-accounts delete |
| Pagamentos por tipo | payment | accounts list, accounts get, bank-billet-batches create, bank-billets list, bank-billets create, bank-billets get, bank-billets cancel, batches list, batches get, batches approve, batches reprove, dda-accounts list, dda-accounts create, dda-accounts get, dda-accounts update, dda-accounts disable, dda-accounts enable, dda-bank-billets list, dda-bank-billets get, dda-bank-billets delete, dda-bank-billets reject, dda-bank-billets release, pix list, pix create, pix get, pix cancel, pix-batches create, tax-batches create, taxes list, taxes create, taxes get, taxes cancel, utilities list, utilities create, utilities get, utilities cancel, utility-batches create |
| Pagamentos (unificado) | payments | list, create, get, cancel |
| Transferências por tipo | transfer | accounts list, accounts get, batches list, batches get, batches approve, batches reprove, internal list, internal create, internal get, internal cancel, internal-batches create, pix list, pix create, pix get, pix cancel, pix-batches create, ted list, ted create, ted get, ted cancel, ted-batches create |
| Transferências (unificado) | transfers | list, create, get, cancel |
| Financeiro | financial | accounts list, accounts create, accounts get, accounts update, accounts delete, accounts balances list, accounts balances get, accounts balances create, accounts commands get, accounts statement-transactions list, accounts statement-transactions imports list, accounts statement-transactions imports get, accounts statement-transactions imports create, accounts statement-transactions sync create, providers list, accounts statement-transactions syncs list, accounts statement-transactions syncs get |
| Clientes | customers | list, create, get, update, cnpj-cpf list, email list |
| Eventos | events | list, get |
| Importações | imports | get, create |
| Relatórios | reports | bank-billets list |
| Consultas | data | bank-billet-queries list, bank-billet-queries create, pix-qrcode-queries list, pix-qrcode-queries create |
| Webhooks | webhooks | list, create, get, update, delete |
| Entregas de webhook | webhook-deliveries | list, get, resend update |
| Entregas de e-mail | email-deliveries | list, get, resend |
| Entregas de SMS | sms-deliveries | list, get, resend |
| Caixa postal | mailbox | entries list, entries create, entries files, entries get, entries update, entries delete, entries email get, entries email create, entries email update, entries email delete, entries email activate update, entries email deactivate update, entries s3 get, entries s3 create, entries s3 delete, entries s3 activate update, entries s3 deactivate update, entries s3 fetch update, entries s3 update-password update, entries sftp get, entries sftp create, entries sftp update, entries sftp delete, entries sftp activate update, entries sftp deactivate update, entries sftp fetch update, entries sftp update-password update, entries syncthing get, entries syncthing create, entries syncthing update, entries syncthing delete, entries syncthing activate update, entries syncthing deactivate update, entries syncthing resend-invites update, entries syncthing update-status update, entries whatsapp get, entries whatsapp create, entries whatsapp update, entries whatsapp delete, entries whatsapp activate update, entries whatsapp deactivate update, files list, files get, files update, files delete |
| Caixas EDI | edi | edi-boxes list, edi-boxes create, edi-boxes get, edi-boxes update |
| Administração | admin | certificates list, certificates create, connections list, connections create, connections get, connections update, connections delete, connections associations create, connections associations delete, subaccounts list, subaccounts create, subaccounts get, subaccounts update, users list, users create, users update, users delete |
| Tokens de acesso | security | access-tokens create, access-tokens update, access-tokens delete, access-tokens disable, access-tokens enable, access-tokens renew, access-tokens revoke |
| Usuário autenticado | me | list |
| Usuário autenticado (descontinuado) | userinfo | list |