# Kobana Documentation

> Kobana oferece uma API limpa, simples e que funciona, com respostas documentadas, tratamento de erros, webhooks para todas as operações financeiras de mais de 30 bancos e instituições de pagamentos.

## Guides
- [Kobana para Desenvolvedores](https://developers.kobana.com.br/docs/comecando.md): Legal que você está aqui para aprender como utilizar o potencial de integração da Kobana, é um prazer estar com você!

## API Reference
- [Visão Geral](https://developers.kobana.com.br/reference/visao-geral.md): Você que é dev, divirta-se! ✨
- [Especificações](https://developers.kobana.com.br/reference/especificações.md): Arquivos de especificação da API
- [Endpoints](https://developers.kobana.com.br/reference/endpoints-1.md)
- [Limite de Requisições](https://developers.kobana.com.br/reference/limite-de-requisições.md)
- [Autenticação](https://developers.kobana.com.br/reference/autenticacao.md): Para você começar rapidamente e fazer sua primeira requisição.
- [Token de Acesso](https://developers.kobana.com.br/reference/token-de-acesso.md)
- [Fluxo de autorização](https://developers.kobana.com.br/reference/authorization-flow.md): Fluxo de autenticação por autorização do usuário (authorization flow)
- [Fluxo credenciais do cliente](https://developers.kobana.com.br/reference/client-credentials-flow.md): Fluxo de autenticação por concessão de credenciais do cliente (client credentials flow)
- [Postman](https://developers.kobana.com.br/reference/postman-collection.md): Coleção do Postman para testar a API
- [Bancos Suportados](https://developers.kobana.com.br/reference/bancos-suportados.md)
- [ABC Brasil](https://developers.kobana.com.br/reference/abc-brasil.md)
- [Ailos](https://developers.kobana.com.br/reference/ailos.md)
- [Arbi](https://developers.kobana.com.br/reference/arbi.md)
- [Banco de Brasília](https://developers.kobana.com.br/reference/banco-de-brasília.md)
- [Banco do Brasil](https://developers.kobana.com.br/reference/banco-do-brasil.md)
- [Banco do Nordeste](https://developers.kobana.com.br/reference/banco-do-nordeste.md)
- [Banco Industrial do Brasil](https://developers.kobana.com.br/reference/banco-industrial-do-brasil.md)
- [Banco Mercantil](https://developers.kobana.com.br/reference/banco-mercantil.md)
- [Banese](https://developers.kobana.com.br/reference/banese.md)
- [Banestes](https://developers.kobana.com.br/reference/banestes.md)
- [Banrisul](https://developers.kobana.com.br/reference/banrisul.md)
- [BNP Paribas](https://developers.kobana.com.br/reference/bnp-paribas.md)
- [Bocom BBM](https://developers.kobana.com.br/reference/bocom-bbm.md)
- [Bradesco](https://developers.kobana.com.br/reference/bradesco.md)
- [BV](https://developers.kobana.com.br/reference/bv.md)
- [BTG](https://developers.kobana.com.br/reference/btg.md)
- [Caixa Econômica Federal](https://developers.kobana.com.br/reference/caixa-econômica-federal.md)
- [Caruana](https://developers.kobana.com.br/reference/caruana.md)
- [Citibank](https://developers.kobana.com.br/reference/citibank.md)
- [Cora](https://developers.kobana.com.br/reference/cora.md)
- [Credisis](https://developers.kobana.com.br/reference/credisis.md)
- [Cresol](https://developers.kobana.com.br/reference/cresol.md)
- [Daycoval](https://developers.kobana.com.br/reference/daycoval.md)
- [Itaú](https://developers.kobana.com.br/reference/itaú.md)
- [Inter](https://developers.kobana.com.br/reference/inter.md)
- [Money Plus (BMP)](https://developers.kobana.com.br/reference/money-plus.md)
- [PJ Bank](https://developers.kobana.com.br/reference/pj-bank.md)
- [Rendimento](https://developers.kobana.com.br/reference/rendimento.md)
- [Safra](https://developers.kobana.com.br/reference/safra.md)
- [Semear](https://developers.kobana.com.br/reference/semear.md)
- [Santander](https://developers.kobana.com.br/reference/santander.md)
- [SICOOB](https://developers.kobana.com.br/reference/sicoob.md)
- [Sicredi](https://developers.kobana.com.br/reference/sicredi.md)
- [Sisprime](https://developers.kobana.com.br/reference/sisprime.md)
- [Sofisa](https://developers.kobana.com.br/reference/sofisa.md)
- [Unicred do Brasil](https://developers.kobana.com.br/reference/unicred-do-brasil.md)
- [Códigos de Erros](https://developers.kobana.com.br/reference/erros.md)
- [Criar um Boleto](https://developers.kobana.com.br/reference/post_v1-bank-billets.md): Cria um novo boleto bancário para cobrança. O boleto será processado e registrado na instituição financeira de acordo com as configurações da carteira de cobrança utilizada.
- [Listar Boletos](https://developers.kobana.com.br/reference/get_v1-bank-billets.md): Lista boletos.
- [Visualizar o Boleto](https://developers.kobana.com.br/reference/get_v1-bank-billets-id.md): Consulta informações específicas de um Boleto.
- [Atualizar o Boleto](https://developers.kobana.com.br/reference/put_v1-bank-billets-id.md): Atualiza informações específicas de um Boleto.  Você pode alterar boletos no status de Aberto(`opened`) ou Vencido(`overdue`)  Você receberá webhooks `generating` e `opened` para o boleto alterado.  Em carteiras registradas, a alteração irá entrar na remessa e pode ser cobrada taxa bancária.
- [Cancelar o Boleto](https://developers.kobana.com.br/reference/put_v1-bank-billets-id-cancel.md): Cancela boletos nos status de Aberto(opened) ou Vencido(overdue)
- [Duplicar Boleto](https://developers.kobana.com.br/reference/post_v1-bank-billets-id-duplicate-1.md): Duplica boleto permitindo alterar informações do novo boleto e ou cancelar o boleto duplicado
- [Marcar Boleto Como Pago](https://developers.kobana.com.br/reference/put_v1-bank-billets-id-pay-1.md): Marcar boleto como pago
- [Cancelar Boletos em Lote](https://developers.kobana.com.br/reference/post_v1-bank-billets-cancel-all-1.md): Cancelar boletos em lote
- [Enviar Boleto por E-mail](https://developers.kobana.com.br/reference/post_v1-bank-billets-id-send-email-1.md): Enviar boleto por e-mail
- [Enviar Boleto por SMS](https://developers.kobana.com.br/reference/post_v1-bank-billets-id-send-sms-1.md): Enviar boleto por sms
- [Protestar Boleto](https://developers.kobana.com.br/reference/put_v1-bank-billets-id-protest-type.md): Protesta ou cancela protesto de um boleto vencido. O parâmetro :type na rota é obrigatório: use "send" para protestar o boleto ou "cancel" para cancelar um protesto existente.
- [Criar um Cliente](https://developers.kobana.com.br/reference/post_v1-customers.md): Cria um novo cliente para associação com cobranças, boletos e assinaturas.
- [Listar Clientes](https://developers.kobana.com.br/reference/get_v1-customers.md): Lista clientes.
- [Visualizar o Cliente](https://developers.kobana.com.br/reference/get_v1-customers-id.md): Consulta informações específicas de um Cliente.
- [Atualizar Cliente](https://developers.kobana.com.br/reference/put_v1-customers-id.md): Atualiza informações específicas de um Cliente.
- [Busca Cliente por CNPJ/CPF](https://developers.kobana.com.br/reference/get_v1-customers-cnpj-cpf.md): Visualizar um cliente buscando por cnpj ou cpf.
- [Busca Cliente por E-mail](https://developers.kobana.com.br/reference/get_v1-customers-email.md): Visualizar um cliente buscando por e-mail.
- [Listar Carnês](https://developers.kobana.com.br/reference/get_v1-installments-1.md): Lista Carnês.
- [Criar um Carnê](https://developers.kobana.com.br/reference/post_v1-installments-1.md): Cria um carnê para geração de múltiplos boletos com vencimentos periódicos.
- [Informações do Carnê](https://developers.kobana.com.br/reference/get_v1-installments-id-1.md): Consulta informações específicas de um Carnê.
- [Excluir o Carnê](https://developers.kobana.com.br/reference/delete_v1-installments-id-1.md): Exclui um Carnê específico. Nenhum boleto gerado pela carnê será excluído.
- [Criar uma Assinatura](https://developers.kobana.com.br/reference/post_v1-customer-subscriptions-1.md): Cria uma nova assinatura recorrente para cobrança automática de clientes com boletos bancários.
- [Listar Assinaturas](https://developers.kobana.com.br/reference/get_v1-customer-subscriptions-1.md): Lista assinaturas.
- [Informações da Assinatura](https://developers.kobana.com.br/reference/get_v1-customer-subscriptions-id-1.md): Consulta informações específicas de uma Assinatura.
- [Atualizar a Assinatura](https://developers.kobana.com.br/reference/put_v1-customer-subscriptions-id-1.md): Atualiza informações específicas de uma Assinatura
- [Excluir a Assinatura](https://developers.kobana.com.br/reference/delete_v1-customer-subscriptions-id-1.md): Exclui uma Assinatura.
- [Gerar Próxima Cobrança](https://developers.kobana.com.br/reference/post_v1-customer-subscriptions-id-next-charge-1.md): Gera a próxima cobrança.
- [Criar Carteira de Cobrança](https://developers.kobana.com.br/reference/post_v1-bank-billet-accounts-1.md): Cria uma nova carteira de cobrança para emissão de boletos bancários. A carteira precisa ser homologada antes de poder ser utilizada em produção.
- [Listar Carteiras](https://developers.kobana.com.br/reference/get_v1-bank-billet-accounts-1.md): Lista Carteiras.
- [Informações da Carteira](https://developers.kobana.com.br/reference/get_v1-bank-billet-accounts-id-1.md): Consulta informações específicas de uma Carteira
- [Atualizar a Carteira](https://developers.kobana.com.br/reference/put_v1-bank-billet-accounts-id-1.md): Atualiza informações específicas de uma Carteira.
- [Solicitar Homologação da Carteira de Cobrança](https://developers.kobana.com.br/reference/get_v1-bank-billet-accounts-id-ask-1.md): Solicitar homologação da Carteira de Cobrança
- [Validar Carteira de Cobrança](https://developers.kobana.com.br/reference/put_v1-bank-billet-accounts-id-validate-1.md): Validar Carteira de Cobrança
- [Alterar Carteira de Cobrança padrão](https://developers.kobana.com.br/reference/put_v1-bank-billet-accounts-id-set-default-1.md): Alterar Carteira de Cobrança padrão
- [Excluir a Carteira de Cobrança](https://developers.kobana.com.br/reference/delete_v1-bank-billet-accounts-id.md): Exclui uma Carteira de Cobrança. Opcionalmente, exclui também a Conta Financeira associada.
- [Listar Eventos](https://developers.kobana.com.br/reference/get_v1-events-1.md): Lista Eventos.
- [Informações do Evento](https://developers.kobana.com.br/reference/get_v1-events-id-1.md): Consulta informações específicas de um Evento.
- [Listar SMS Enviados](https://developers.kobana.com.br/reference/get_v1-sms-deliveries-1.md): Listar SMS enviados
- [Informações do SMS Enviado](https://developers.kobana.com.br/reference/get_v1-sms-deliveries-id-1.md): Consulta informações específicas de um SMS enviado
- [Reenviar SMS Enviado](https://developers.kobana.com.br/reference/put_v1-sms-deliveries-id-resend-1.md): Você pode reenviar SMS enviados.
- [Criar Webhook](https://developers.kobana.com.br/reference/post_v1-webhooks-1.md): Cria um webhook para receber notificações de eventos do sistema via HTTP.
- [Listar Webhooks](https://developers.kobana.com.br/reference/get_v1-webhooks-1.md): Lista webhooks.
- [Informações do Webhook](https://developers.kobana.com.br/reference/get_v1-webhooks-id-1.md): Consulta informações específicas de um Webhook.
- [Atualizar Webhook](https://developers.kobana.com.br/reference/put_v1-webhooks-id-1.md): Atualiza informações específicas de um webhook.
- [Excluir Webhook](https://developers.kobana.com.br/reference/delete_v1-webhooks-id-1.md): Exclui um webhook específicos
- [Listar E-mails Enviados](https://developers.kobana.com.br/reference/get_v1-email-deliveries-1.md): Listar e-mails enviados  O `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.
- [Informações do E-mail Enviado](https://developers.kobana.com.br/reference/get_v1-email-deliveries-id-1.md): Consulta informações específicas de um e-mail enviado
- [Reenviar E-mail Enviado](https://developers.kobana.com.br/reference/put_v1-email-deliveries-id-resend-1.md): Você pode reenviar e-mails enviados.
- [Informações do Usuário (descontinuado)](https://developers.kobana.com.br/reference/get_v1-userinfo-1.md): Consulta informações da conta acessada.
- [Listar Webhooks Enviados](https://developers.kobana.com.br/reference/get_v1-webhook-deliveries-1.md): Listar webhooks enviados  O `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.
- [Informações do Webhook Enviado](https://developers.kobana.com.br/reference/get_v1-webhook-deliveries-id-1.md): Consulta informações específicas de um webhook enviado
- [Reenviar Webhooks Enviados](https://developers.kobana.com.br/reference/put_v1-webhook-deliveries-resend-1.md): Reenviar webhooks enviados.  Está limitado aos primeiros 1000 encontrados na busca conforme os parâmetros.  O `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.
- [Enviar CNAB](https://developers.kobana.com.br/reference/post_v1-discharges-1.md): Envia um arquivo CNAB de retorno bancário para processamento de pagamentos e baixas de boletos.
- [Listar CNABs](https://developers.kobana.com.br/reference/get_v1-discharges-1.md): Lista CNABs.
- [Informações do CNAB](https://developers.kobana.com.br/reference/get_v1-discharges-id-1.md): Consulta informações específicas de um CNAB.
- [Quitar Boletos](https://developers.kobana.com.br/reference/put_v1-discharges-id-pay-off-1.md): Quitar boletos.  É necessário já ter enviado o CNAB. Todos os boletos que forem identificados dentro do CNAB serão marcados como PAGO e os [Webhooks](/reference/webhooks) serão disparados.
- [Reprocessar CNAB](https://developers.kobana.com.br/reference/put_v1-discharges-id-reprocess-1.md): Reprocessar CNAB
- [Download do CNAB](https://developers.kobana.com.br/reference/get_v1-discharges-id-download-1.md): Download do CNAB
- [Arquivo de Exportação do Lote](https://developers.kobana.com.br/reference/get_v1-bank-billet-batch-exports-id-1.md): Arquivo de exportação do lote.  Caso o arquivo ainda não tenha sido processado a resposta será 404. Caso o arquivo já esteja pronto para download a resposta será um redirect para o download do arquivo.
- [Criar Lote](https://developers.kobana.com.br/reference/post_v1-bank-billet-batches-1.md): Criar Lote.
- [Listar Lotes](https://developers.kobana.com.br/reference/get_v1-bank-billet-batches-1.md): Listar Lotes.
- [Informações do Lote](https://developers.kobana.com.br/reference/get_v1-bank-billet-batches-id-1.md): Consulta informações específicas de um Lote.
- [Excluir o lote](https://developers.kobana.com.br/reference/delete_v1-bank-billet-batches-id-1.md): Excluir lote.
- [Incluir Boletos no Lote](https://developers.kobana.com.br/reference/put_v1-bank-billet-batches-id-add-bank-billets-1.md): Incluir boletos no lote.
- [Excluir Boleto do Lote](https://developers.kobana.com.br/reference/delete_v1-bank-billet-batches-id-remove-bank-billet-1.md): Excluir boleto do lote.
- [Exportar Lote no Formato .zip](https://developers.kobana.com.br/reference/post_v1-bank-billet-batches-id-zip-1.md): Exportar lote no formato .zip.  Após a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de [Exportação do Lote](/reference/get_v1-bank-billet-batch-exports-id).
- [Exportar Lote no Formato .pdf](https://developers.kobana.com.br/reference/post_v1-bank-billet-batches-id-pdf-1.md): Exportar lote no formato .pdf.  Após a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de [Exportação do Lote](/reference/get_v1-bank-billet-batch-exports-id).
- [Listar Registros de Retorno](https://developers.kobana.com.br/reference/get_v1-bank-billet-discharges-1.md): Lista registros de retorno.
- [Informações do Registro de Retorno](https://developers.kobana.com.br/reference/get_v1-bank-billet-discharges-id-1.md): Consulta informações específicas de um Registro de Retorno.
- [Efetuar Pagamento de Boleto](https://developers.kobana.com.br/reference/post_v1-bank-billet-payments-1.md): Efetuar Pagamento de Boleto.
- [Listar Pagamentos de Boleto](https://developers.kobana.com.br/reference/get_v1-bank-billet-payments-1.md): Listar Pagamentos de Boleto.
- [Informações do Pagamento de Boleto](https://developers.kobana.com.br/reference/get_v1-bank-billet-payments-id-1.md): Consulta informações específicas de um Pagamento de Boleto.
- [Excluir Pagamento de Boleto](https://developers.kobana.com.br/reference/delete_v1-bank-billet-payments-id-1.md): Excluir Pagamento de Boleto.
- [Listar Registros de Boleto.](https://developers.kobana.com.br/reference/get_v1-bank-billet-registrations-1.md): Listar Registros de Boleto.
- [Informações do Registro de Boleto](https://developers.kobana.com.br/reference/get_v1-bank-billet-registrations-id-1.md): Consulta informações específicas de um Registro de Boleto.
- [Listar Registros de Remessa](https://developers.kobana.com.br/reference/get_v1-bank-billet-remittances-1.md): Listar Registros de Remessa.
- [Listar Registros de Remessa Pendentes](https://developers.kobana.com.br/reference/get_v1-bank-billet-remittances-pending-1.md): Listar Registros de Remessa pendentes
- [Criar Pendências](https://developers.kobana.com.br/reference/post_v1-bank-billet-remittances-id-occurrence-our-code-1.md): Criar pendências.
- [Excluir Pendências](https://developers.kobana.com.br/reference/delete_v1-bank-billet-remittances-id-1.md): Excluir pendências.
- [Informações do Registro de Remessa](https://developers.kobana.com.br/reference/get_v1-bank-billet-remittances-id-1.md): Consulta informações específicas de um Registro de Remessa.
- [Listar Importações](https://developers.kobana.com.br/reference/get_v1-imports-collection-name-1.md): Lista as importações realizadas para um tipo específico de recurso (clientes, assinaturas, boletos ou carnês).
- [Importar](https://developers.kobana.com.br/reference/post_v1-imports-collection-name-1.md): Importa recursos (clientes, assinaturas, boletos ou carnês) através de um arquivo CSV. O processamento é realizado de forma assíncrona.  > **Processamento Assíncrono:** Este endpoint é processado assincronamente.  A Importação é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda os parâmetros da requisição e processa a importação em segundo plano. Após a importação ser processada, os registros serão associados à sua Conta. Você recebe na resposta desta requisição o ID da Importação criada e pode consultá-lo a qualquer momento.  ## Eventos de Webhook  Quando a requisição é realizada, um evento `import.created` é disparado. O nosso servidor então começa o processamento da importação. Após o fim do processamento, o evento `import.processed` é disparado.
- [Visualizar Importação](https://developers.kobana.com.br/reference/get_v1-imports-collection-name-id-1.md): Consulta informações específicas de uma Importação.
- [Criar CNAB](https://developers.kobana.com.br/reference/post_v1-remittances-1.md): Criar CNAB.  Será feita uma solicitação de Remessa. Após a criação da Remessa, ela será processada e ao término do processamento serão emitidas notificações através dos Webhooks.
- [Listar CNABs](https://developers.kobana.com.br/reference/get_v1-remittances-1.md): Lista CNABs.
- [Informações do CNAB](https://developers.kobana.com.br/reference/get_v1-remittances-id-1.md): Consulta informações específicas de um CNAB.
- [Apagar CNAB](https://developers.kobana.com.br/reference/delete_v1-remittances-id-1.md): Apagar CNAB.
- [Raw(text/plain) do CNAB](https://developers.kobana.com.br/reference/get_v1-remittances-id-raw-1.md): Raw(text/plain) do CNAB.  Será disparado o evento remittance.downloaded.
- [Criar CNABs em Lote](https://developers.kobana.com.br/reference/post_v1-remittances-bulk-1.md): Criar CNABs em Lote.  Serão feitas solicitações de Remessa de acordo com IDs das ocorrências. Será criada uma solicitação de Remessa para cada carteira associada às ocorrências. Após a criação das Remessas, elas serão processadas e ao término do processamento serão emitidas notificações através dos Webhooks.
- [Contagem de Boletos.](https://developers.kobana.com.br/reference/get_v1-reports-bank-billets-1.md): Contagem de Boletos.
- [Eventos](https://developers.kobana.com.br/reference/eventos.md)
- [Segurança](https://developers.kobana.com.br/reference/segurança.md)
- [Payloads](https://developers.kobana.com.br/reference/payloads.md)