Boletos e cobrança (v1)

O boleto que a conta emite para receber, as carteiras de cobrança que o registram, os pagamentos recebidos, lotes, carnês e assinaturas.

Boletos

Emitir, alterar, cancelar, duplicar, protestar, dar baixa e enviar boletos por e-mail ou SMS.

Comando	HTTP	Descrição
bank-billets list	GET /v1/bank_billets	Listar Boletos
bank-billets create	POST /v1/bank_billets	Criar um Boleto
bank-billets get	GET /v1/bank_billets/{id}	Visualizar o Boleto
bank-billets update	PUT /v1/bank_billets/{id}	Atualizar o Boleto
bank-billets cancel	PUT /v1/bank_billets/{id}/cancel	Cancelar o Boleto
bank-billets duplicate	POST /v1/bank_billets/{id}/duplicate	Duplicar Boleto
bank-billets pay	PUT /v1/bank_billets/{id}/pay	Marcar Boleto Como Pago
bank-billets send-email	POST /v1/bank_billets/{id}/send_email	Enviar Boleto por E-mail
bank-billets send-sms	POST /v1/bank_billets/{id}/send_sms	Enviar Boleto por SMS
bank-billets cancel-all create	POST /v1/bank_billets/cancel_all	Cancelar Boletos em Lote
bank-billets protest update	PUT /v1/bank_billets/{id}/protest/{type}	Protestar Boleto

# Listar Boletos
kobana banking bank-billets list

# Visualizar o Boleto
kobana banking bank-billets get --params '{"id":"BANK_BILLET_ID"}'

# Cancelar o Boleto
kobana banking bank-billets cancel --params '{"id":"BANK_BILLET_ID"}' --dry-run

Carteiras de cobrança

As carteiras que registram os boletos no banco, a homologação e a carteira padrão.

Comando	HTTP	Descrição
bank-billet-accounts list	GET /v1/bank_billet_accounts	Listar Carteiras
bank-billet-accounts create	POST /v1/bank_billet_accounts	Criar Carteira de Cobrança
bank-billet-accounts get	GET /v1/bank_billet_accounts/{id}	Informações da Carteira
bank-billet-accounts update	PUT /v1/bank_billet_accounts/{id}	Atualizar a Carteira
bank-billet-accounts ask	GET /v1/bank_billet_accounts/{id}/ask	Solicitar Homologação da Carteira de Cobrança
bank-billet-accounts set-default	PUT /v1/bank_billet_accounts/{id}/set_default	Alterar Carteira de Cobrança padrão
bank-billet-accounts validate	PUT /v1/bank_billet_accounts/{id}/validate	Validar Carteira de Cobrança

# Listar Carteiras
kobana banking bank-billet-accounts list

# Informações da Carteira
kobana banking bank-billet-accounts get --params '{"id":"BANK_BILLET_ACCOUNT_ID"}'

Pagamentos de boleto

Os pagamentos recebidos de um boleto, inclusive os registrados à mão.

Comando	HTTP	Descrição
bank-billet-payments list	GET /v1/bank_billet_payments	Listar Pagamentos de Boleto
bank-billet-payments create	POST /v1/bank_billet_payments	Efetuar Pagamento de Boleto
bank-billet-payments get	GET /v1/bank_billet_payments/{id}	Informações do Pagamento de Boleto
bank-billet-payments delete	DELETE /v1/bank_billet_payments/{id}	Excluir Pagamento de Boleto

# Listar Pagamentos de Boleto
kobana banking bank-billet-payments list

# Informações do Pagamento de Boleto
kobana banking bank-billet-payments get --params '{"id":"BANK_BILLET_PAYMENT_ID"}'

# Excluir Pagamento de Boleto
kobana banking bank-billet-payments delete --params '{"id":"BANK_BILLET_PAYMENT_ID"}' --dry-run

Lotes de boletos

Lotes para agrupar boletos e gerar um PDF ou um ZIP com todos eles.

Comando	HTTP	Descrição
bank-billet-batches list	GET /v1/bank_billet_batches	Listar Lotes
bank-billet-batches create	POST /v1/bank_billet_batches	Criar Lote
bank-billet-batches get	GET /v1/bank_billet_batches/{id}/	Informações do Lote
bank-billet-batches delete	DELETE /v1/bank_billet_batches/{id}/	Excluir o lote
bank-billet-batches add-bank-billets	PUT /v1/bank_billet_batches/{id}/add_bank_billets	Incluir Boletos no Lote
bank-billet-batches pdf	POST /v1/bank_billet_batches/{id}/pdf	Exportar Lote no Formato .pdf
bank-billet-batches remove-bank-billet	DELETE /v1/bank_billet_batches/{id}/remove_bank_billet	Excluir Boleto do Lote
bank-billet-batches zip	POST /v1/bank_billet_batches/{id}/zip	Exportar Lote no Formato .zip

# Listar Lotes
kobana banking bank-billet-batches list

# Informações do Lote
kobana banking bank-billet-batches get --params '{"id":"BANK_BILLET_BATCH_ID"}'

# Excluir o lote
kobana banking bank-billet-batches delete --params '{"id":"BANK_BILLET_BATCH_ID"}' --dry-run

Exportação do lote

O arquivo gerado pela exportação de um lote.

Comando	HTTP	Descrição
bank-billet-batch-exports get	GET /v1/bank_billet_batch_exports/{id}	Arquivo de Exportação do Lote

# Arquivo de Exportação do Lote
kobana banking bank-billet-batch-exports get --params '{"id":"BANK_BILLET_BATCH_EXPORT_ID"}'

Carnês

Carnês, que emitem uma série de boletos de uma vez.

Comando	HTTP	Descrição
installments list	GET /v1/installments	Listar Carnês
installments create	POST /v1/installments	Criar um Carnê
installments get	GET /v1/installments/{id}	Informações do Carnê
installments delete	DELETE /v1/installments/{id}	Excluir o Carnê

# Listar Carnês
kobana banking installments list

# Informações do Carnê
kobana banking installments get --params '{"id":"INSTALLMENT_ID"}'

# Excluir o Carnê
kobana banking installments delete --params '{"id":"INSTALLMENT_ID"}' --dry-run

Assinaturas

Assinaturas, que emitem um boleto a cada ciclo.

Comando	HTTP	Descrição
customer-subscriptions list	GET /v1/customer_subscriptions	Listar Assinaturas
customer-subscriptions create	POST /v1/customer_subscriptions	Criar uma Assinatura
customer-subscriptions get	GET /v1/customer_subscriptions/{id}	Informações da Assinatura
customer-subscriptions update	PUT /v1/customer_subscriptions/{id}	Atualizar a Assinatura
customer-subscriptions delete	DELETE /v1/customer_subscriptions/{id}	Excluir a Assinatura
customer-subscriptions next-charge	POST /v1/customer_subscriptions/{id}/next_charge	Gerar Próxima Cobrança

# Listar Assinaturas
kobana banking customer-subscriptions list

# Informações da Assinatura
kobana banking customer-subscriptions get --params '{"id":"CUSTOMER_SUBSCRIPTION_ID"}'

# Excluir a Assinatura
kobana banking customer-subscriptions delete --params '{"id":"CUSTOMER_SUBSCRIPTION_ID"}' --dry-run

Próximos passos

• Introspecção de schema: os parâmetros e o corpo que cada comando aceita.
• Flags globais: --params, --json, --fields, --dry-run e as demais.