Webhooks(Callbacks ou Reverse API) permitem que seu sistema receba notificações de todos os eventos que ocorrem em boletos ou cobranças via Pix 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.

Modelos possíveis de autenticação

- Sem autenticação

É esperado que seja disponibilizado para a Nexxera, apenas a URL para recepção das notificações do Webhook.

- Token Fixo

É esperado que seja disponibilizado para a Nexxera, a URL de notificação e o token fixo que será utilizado no cabeçalho Authorization. Exemplo:

Authorization: Bearer dGVzdGUxMjNleGVtcGxv

- Basic Auth (Usuário e Senha

É esperado que seja disponibilizado para a Nexxera, a URL de notificação e o Usuário e Senha que serão utilizados no modelo 'Basic Auth'.

- Request

É esperado que seja disponibilizado para a Nexxera, a URL de notificação, a URL de autenticação e o Corpo de requisição(body), onde este deve retornar OBRIGATORIAMENTE um Json contendo o atributo 'access_token'.

• Body Exemplo (Corpo de requisição)

        {
            "client_id": "id_teste", 
            "client_secret": "senha_teste"
        }
  

Obs: A área de operações da Nexxera(Implantação ou Suporte) deve parametrizar junto ao cadastro do seu Beneficiário o modelo que será utilizado.

Formato e método de envio

Caso esteja interessado na funcionalidade supracitada, será preciso desenvolver uma API Rest de método POST, com o conteúdo no corpo (body) da requisição no formato JSON, conforme abaixo:

• Body (Notificação de Boleto)

        {
            "instructions": [{
                "type": "BOLETO",
                "txid": "",
                "endToEndId": "",
                "fare_amount": "",
                "environment": "HOMOLOGACAO",
                "bank": 341,
                "agreement_number": "1234567890",
                "portfolio_id": "109",
                "document_number": "123456",
                "our_number": "123456",
                "your_number": "123456",
                "emission_date": "2021-09-13",
                "due_date": "2021-10-13",
                "nominal_amount": "999.88",
                "return_code": "06",
                "remittance_code": "00",
                "description": "Liquidação",
                "value_one": {
                    "type": "VALOR_PAGO",
                    "old_value": "0.00",
                    "new_value": "125.00"
                },
                "value_two": {
                    "type": "ACRESCIMO_COBRADO",
                    "old_value": "0.00",
                    "new_value": "0.05"
                },
                "value_three": {
                    "type": "DESCONTO_CONCEDIDO",
                    "old_value": "0.00",
                    "new_value": "0.01"
                },
                "value_four": {
                    "type": "ABATIMENTO_CONCEDIDO",
                    "old_value": "0.00",
                    "new_value": "0.02"
                },
                "value_five": {
                    "type": "DATA_CREDITO",
                    "old_value": 0,
                    "new_value": "2019-01-29"
                },
                "value_six": {
                    "type": "DATA_LIQUIDACAO",
                    "old_value": 0,
                    "new_value": "2019-03-25"
                }
            }]
        }
  

  • Body (Notificação de QR Code Pix)

      {
          "instructions": [{
              "type": "PIX",
              "txid": "1956879719919771554657157151315987",
              "endToEndId": "ai00569819aioajoinmxaoxc",
              "fare_amount": "",
              "environment": "HOMOLOGACAO",
              "bank": 341,
              "agreement_number": "289000014692",
              "portfolio_id": "109",
              "document_number": "8519634174",
              "our_number": "00000860",
              "your_number": "",
              "emission_date": "2021-06-09",
              "due_date": "2021-06-18",
              "nominal_amount": "60.99",
              "return_code": "06",
              "remittance_code": "00",
              "description": "Liquidação",
              "value_one": {
                  "type": "VALOR_PAGO",
                  "old_value": "0.00",
                  "new_value": "60.99"
              },
              "value_two": "",
              "value_three": "",
              "value_four": "",
              "value_five": {
                  "type": "DATA_CREDITO",
                  "old_value": 0,
                  "new_value": "2021-06-09"
              },
              "value_six": {
                  "type": "DATA_LIQUIDACAO",
                  "old_value": 0,
                  "new_value": "2021-06-09"
              }
          }]
      }
    

  • Body (Notificação de Boleto hibrido)

      {
          "instructions": [{
              "type": "HIBRIDO",
              "txid": "BL15000064973109000000001245772",
              "endToEndId": "",
              "fare_amount": "",
              "environment": "HOMOLOGACAO",
              "bank": 341,
              "agreement_number": "15000649734",
              "portfolio_id": "109",
              "document_number": "1245772",
              "our_number": "01245772",
              "your_number": "1245772",
              "emission_date": "2024-01-31",
              "due_date": "2024-02-25",
              "nominal_amount": "1003",
              "return_code": "09",
              "remittance_code": "00",
              "description": "Baixa",
              "value_one": "",
              "value_two": "",
              "value_three": "",
              "value_four": "",
              "value_five": "",
              "value_six": ""
              }
          }]
      }
    

Nossa plataforma espera que sua aplicação responda com o código HTTP 2XX (200, 201, etc) em no máximo 30 segundos. Códigos de redirecionamento (3XX) não serão seguidos e serão considerados como falha.

Retentativas

A plataforma irá efetuar 5 retentativas de envio caso seu sistema esteja fora do ar ou responda com um código HTTP diferente de 2XX. As retentativas são todas enviadas no intervalo de 30 minutos. Depois desse período a requisição é descartada pela plataforma e enviaremos um e-mail para o contato técnico cadastrado em nossa plataforma.

Esse email possuirá um link para zerar as tentativas de envio das informações para o webhook.

Esteja ciente de que as requisições podem chegar até seu servidor em uma ordem diferente do disparo.

A requisição fornecerá as seguintes informações:

Informações gerais do título

Lista dos principais códigos de instrução:

Nosso Web Service retorna os códigos de resposta HTTP. Estas são as informações mais relevantes:

Já utiliza a API de Cobrança da Nexxera?

• Não. Nesse caso entre em contato com o setor de Implantação da Nexxera pelo email implantacao@nexxera.com ou pelo telefone +55 48 21065698, opção 6.
  
  

• Sim. Nesse caso entre em contato com o setor de Suporte/Operações da Nexxera pelo email suporte@nexxera.com ou pelo telefone +55 48 21065698, opção 2.