API de Cobrança

1. Principais funcionalidades

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 API de cobrança está homologada para os seguintes bancos:

• Banco do Brasil;

• Bradesco;

• CEF;

• Itaú;

• Santander;

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

2. 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.

3. Webhook

Webhooks (callbacks ou reverse API) permitem que seu sistema receba notificações de todos os eventos que ocorrem nos boletos no sistema de Cobrança Eletrônica da Nexxera. Quando um evento acontece, o sistema envia uma requisição HTTP POST para a URL configurada no webhook com as informações relativas ao evento. Ao receber a notificação, seu sistema pode executar diversas tarefas, dependendo do objetivo da integração.

4. Portal de Cobrança

A API de cobrança é integrada ao Portal de Cobrança Eletrônica Nexxera. Todas as facilidades oferecidas pelo portal, como envio de boletos por e-mail, também estarão disponíveis caso a API seja utilizada no lugar da troca de arquivos.