Remessa e retorno (CNAB)
Os arquivos CNAB trocados com o banco: remessas enviadas, retornos recebidos e o registro de cada boleto dentro deles.
Remessas
Os arquivos de remessa CNAB, inclusive a geração em lote e o arquivo bruto.
| Comando | HTTP | Descrição |
|---|---|---|
remittances list | GET /v1/remittances | Listar CNABs |
remittances create | POST /v1/remittances | Criar CNAB |
remittances get | GET /v1/remittances/{id} | Informações do CNAB |
remittances delete | DELETE /v1/remittances/{id} | Apagar CNAB |
remittances raw | GET /v1/remittances/{id}/raw | Raw(text/plain) do CNAB |
remittances bulk create | POST /v1/remittances/bulk | Criar CNABs em Lote |
# Listar CNABs
kobana banking remittances list
# Informações do CNAB
kobana banking remittances get --params '{"id":"REMITTANCE_ID"}'
# Apagar CNAB
kobana banking remittances delete --params '{"id":"REMITTANCE_ID"}' --dry-run
Retornos
Os arquivos de retorno CNAB, o download, a baixa e o reprocessamento.
| Comando | HTTP | Descrição |
|---|---|---|
discharges list | GET /v1/discharges | Listar CNABs |
discharges create | POST /v1/discharges | Enviar CNAB |
discharges get | GET /v1/discharges/{id} | Informações do CNAB |
discharges download | GET /v1/discharges/{id}/download | Download do CNAB |
discharges pay-off | PUT /v1/discharges/{id}/pay_off | Quitar Boletos |
discharges reprocess | PUT /v1/discharges/{id}/reprocess | Reprocessar CNAB |
# Listar CNABs
kobana banking discharges list
# Informações do CNAB
kobana banking discharges get --params '{"id":"DISCHARGE_ID"}'
Registros de boleto
O registro de cada boleto no banco.
| Comando | HTTP | Descrição |
|---|---|---|
bank-billet-registrations list | GET /v1/bank_billet_registrations | Listar Registros de Boleto. |
bank-billet-registrations get | GET /v1/bank_billet_registrations/{id} | Informações do Registro de Boleto |
# Listar Registros de Boleto.
kobana banking bank-billet-registrations list
# Informações do Registro de Boleto
kobana banking bank-billet-registrations get --params '{"id":"BANK_BILLET_REGISTRATION_ID"}'
Boletos em remessa
Os boletos dentro das remessas, os pendentes de envio e as ocorrências.
| Comando | HTTP | Descrição |
|---|---|---|
bank-billet-remittances list | GET /v1/bank_billet_remittances | Listar Registros de Remessa |
bank-billet-remittances get | GET /v1/bank_billet_remittances/{id} | Informações do Registro de Remessa |
bank-billet-remittances delete | DELETE /v1/bank_billet_remittances/{id} | Excluir Pendências |
bank-billet-remittances occurrence create | POST /v1/bank_billet_remittances/{id}/occurrence/{our_code} | Criar Pendências |
bank-billet-remittances pending list | GET /v1/bank_billet_remittances/pending | Listar Registros de Remessa Pendentes |
# Listar Registros de Remessa
kobana banking bank-billet-remittances list
# Informações do Registro de Remessa
kobana banking bank-billet-remittances get --params '{"id":"BANK_BILLET_REMITTANCE_ID"}'
# Excluir Pendências
kobana banking bank-billet-remittances delete --params '{"id":"BANK_BILLET_REMITTANCE_ID"}' --dry-run
Boletos em retorno
Os boletos dentro dos retornos.
| Comando | HTTP | Descrição |
|---|---|---|
bank-billet-discharges list | GET /v1/bank_billet_discharges | Listar Registros de Retorno |
bank-billet-discharges get | GET /v1/bank_billet_discharges/{id} | Informações do Registro de Retorno |
# Listar Registros de Retorno
kobana banking bank-billet-discharges list
# Informações do Registro de Retorno
kobana banking bank-billet-discharges get --params '{"id":"BANK_BILLET_DISCHARGE_ID"}'
Próximos passos
- Introspecção de schema: os parâmetros e o corpo que cada comando aceita.
- Flags globais:
--params,--json,--fields,--dry-rune as demais.