API de Cobrança

Visão geral

A API de cobrança é uma nova forma de registro de boletos que está sendo gradualmente disponibilizada pelos principais bancos. Seu diferencial em relação à troca de arquivos é a possibilidade de registrar um boleto e ter o PDF disponível em poucos segundos, como em uma transação de cartão de crédito. Este método é útil para empresas que precisam fornecer a 2ª via do boleto ao cliente no momento da venda, como lojas virtuais.

Cada banco possui uma API com formas de funcionamento distintas que exigem desenvolvimento exclusivo. A Nexxera, visando facilitar a rotina de empresas que utilizam múltiplos bancos emissores, desenvolveu uma API única que conversa com todas as APIs, assim permitindo que em um único desenvolvimento a empresa possa utilizar vários bancos.

A documentação técnica está disponível em https://cobrancaonlinenexxera.docs.apiary.io/

*Na documentação técnica acima apresentamos a relação de instituições que a Nexxera já desenvolveu a integração via API, no entanto para algumas destas instituições não temos clientes ativos. A relação com os bancos homologados e com clientes ativos está logo abaixo.

Bancos homologados

Fluxo dos dados

A API de cobrança elimina a necessidade de gerar uma remessa no formato CNAB 240 ou 400, pois a chamada via web service contém todos os dados necessários para registrar um título no banco. Quando uma tentativa de registro é realizada, a API retorna informando se a requisição foi bem sucedida ou não.

Caso haja sucesso na tentativa de registro, o banco informa na própria resposta o PDF do boleto codificado em base64 para que a empresa o armazene. Caso exista algum erro na requisição, a API retorna o código de erro para correção.

O fluxo de retorno das informações do banco, ou seja, todas as baixas, liquidações e demais movimentações do título, continuam sendo informadas pelo banco em arquivo CNAB. Este arquivo pode ser enviado a empresa como num fluxo de cobrança padrão, ou podemos devolver essas movimentações num webhook, ou API reversa.

Webhook

Através do Cobrança Eletrônica, é possível configurar o disparo de notificações via Webhook após os eventos ocorridos nos títulos importados na aplicação, para todos os tipos de documento (boleto de cobrança, boleto híbrido e Pix Qr Code). É possível configurar também processos de autenticação.