Neofin V1
  1. Webhooks
Neofin V1
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Versão 1
    • API de Cobranças
      • Upsert de Cobranças
        • Como realizar o upsert de uma cobrança
        • Upsert de Cobranças
          POST
      • Buscando uma cobrança
        • Como buscar uma única cobrança
        • Buscando pelo Integration Identifier
          GET
        • Buscando pelo Billing Number
          GET
      • Marcando uma cobrança como paga
        • Como marcar uma cobrança como paga
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Listando suas cobranças
        • Como listar suas cobranças
        • Eventos de cobranças
          GET
        • Eventos de uma uma cobrança por Integration Identifier
          GET
        • Cobranças por status
          GET
        • Cobranças por cliente
          GET
        • Cobranças por data de atualização
          GET
      • Enviando anexos
        • Como enviar anexos
        • Anexando uma NF a uma cobrança pelo Integration Identifier
          PUT
        • Anexando um Boleto a uma cobrança pelo Integration Identifier
          PUT
    • API de Clientes
      • Upsert de um cliente
        • Como realizar o upsert de um cliente
        • Upsert de clientes
          POST
      • Buscando um cliente
        • Buscando um cliente por Integration Identifier
          GET
        • Buscando um cliente pelo documento
          GET
    • Webhooks
      • Como preparar seus webhooks
  1. Webhooks

Como preparar seus webhooks

Endpoint para Recebimento de Webhooks#

Seu endpoint deve ser uma URL HTTPS com um certificado SSL válido, capaz de receber requisições HTTP POST contendo um payload em JSON e headers customizados.
É considerado sucesso qualquer resposta com status code entre 200 e 299.
Se a requisição não receber resposta em até 10 segundos, será considerada uma falha, e a requisição será reenviada conforme a política de tentativas (Retry Policy).
É possível registrar:
Uma única URL para receber todos os eventos disponíveis, ou
URLs específicas para cada tópico/evento.
Após o registro do endpoint, a Neofin enviará um POST sempre que um evento ocorrer.
A Neofin verifica o certificado SSL ao entregar os webhooks. Certifique-se de que seu servidor está configurado corretamente para HTTPS com um certificado válido.

Política de Reenvio (Retry Policy)#

A Neofin tentará enviar a notificação até 3 vezes, seguindo as seguintes regras:
1.
Primeira tentativa: imediatamente após o evento atingir o estado necessário.
2.
Segunda tentativa: se a primeira falhar, será feita 5 minutos depois.
3.
Terceira e última tentativa: se a segunda também falhar, será feita 20 minutos após a primeira.

Registro de Webhooks#

API
Método: POST
{
  "URL": "https://api.sandbox.neofin.services/webhook",
  "Headers": {
    "api-key": "1A2B3C4D5E1A2B3C4D5E",
    "secret-key": "Aa1Bb2Aa1Bb2Aa1Bb2Aa1Bb2Aa1Bb2Aa1Bb2"
  },
  "Payload": {
    "topic": "payments/created",
    "destination": "https://url-do-webhook"
  }
}

Eventos para serem registrados no "topic" disponíveis#

payments/created
payments/registered
payments/overdue
payments/paid
payments/cancelled

payment_status retornados por tópico#

payments/created:
pending (Em aberto) payments/registered
pending (Em aberto) payments/overdue
overdue (Vencido)
processing_protest (Protestado (em andamento))
protested (Protestado)
pending_derrogatory (Negativação (solicitada))
processing_derrogatory (Negativação (em andamento))
derrogatory (Negativado)
derrogatory_cancelled (Negativação cancelada)
protest_cancelled (Protestado baixado) payments/paid
paid (Recebido)
paid_after_protested (Protestado recebido)
paid_after_derrogatory (Negativação paga) payments/cancelled
cancelled (Cancelado)
Exemplos de Payload/JSON
payments/created#
{
   "id": "d2b836f9-659f-4c2f-96c0-9cb2b57919c9",
   "customer_name": "Customer Name LTDA",
   "customer_document": "11112222000199",
   "customer_mail": "customer@email.com",
   "customer_phone": "+5511977773333",
   "address_street": "Rua Teste",
   "address_number": "123",
   "address_complement": "CJ 1",
   "address_neighborhood": "Centro",
   "address_zip_code": "01005000",
   "address_city": "São Paulo",
   "address_state": "SP",
   "billing_amount": "15000",
   "payment_number": "11111999999999-1",
   "payment_method": "bolepix",
   "payment_status": "pending",
   "payment_amount": "15000",
   "description": "Cobrança 1111100000 - parcela 001/001",
   "installment": "1/1",
   "fine": 0.0,
   "fees": 0.0,
   "discount_before_payment_due_date": 1681757667,
   "discount_before_payment": 0.0,
   "due_date": 1681959600,
   "issued_at": 1681781894,
   "external_identifier": "1234",
   "os_code": "8888888888",
   "os_identifier": "5678",
   "nf_url": "https://nf.co/123098",
   "danfe": [
      {
         "number": "1234",
         "url": "http://nfe.pref.sp.gov.br/con/nota.aspx?ccm=87654321&nf=1234&cod=K1ABCD2E"
      }
   ],
   "rps": "https://neofin-nf.co/1234567-abcd-1234-efgh-ijklmnopqrst/rps9876543210.pdf"
}
payments/registered#
{
   "id": "d2b836f9-659f-4c2f-96c0-9cb2b57919c9",
   "customer_name": "Customer Name LTDA",
   "customer_document": "11112222000199",
   "customer_mail": "customer@email.com",
   "customer_phone": "+5511977773333",
   "address_street": "Rua Teste",
   "address_number": "123",
   "address_complement": "CJ 1",
   "address_neighborhood": "Centro",
   "address_zip_code": "01005000",
   "address_city": "São Paulo",
   "address_state": "SP",
   "billing_amount": "15000",
   "payment_number": "11111999999999-1",
   "payment_method": "bolepix",
   "payment_status": "pending",
   "payment_amount": "15000",
   "description": "Cobrança 1111100000 - parcela 001/001",
   "installment": "1/1",
   "fine": 0.0,
   "fees": 0.0,
   "discount_before_payment_due_date": 1681757667,
   "discount_before_payment": 0.0,
   "due_date": 1681959600,
   "issued_at": 1681781894,
   "external_identifier": "1234",
   "os_code": "8888888888",
   "os_identifier": "5678",
   "nf_url": "https://nf.co/123098",
   "danfe": [
      {
         "number": "1234",
         "url": "http://nfe.pref.sp.gov.br/con/nota.aspx?ccm=87654321&nf=1234&cod=K1ABCD2E"
      }
   ],
   "rps": "https://neofin-nf.co/1234567-abcd-1234-efgh-ijklmnopqrst/rps9876543210.pdf",
   "barcode_b64": "iVBORw0KGgoAAAANSUhEUgAAA+oAAADICAIAAADwcIwlAAAE1UlEQVR4nO3YyW6jUBRAQdPq///l17soMuGZIbRzoqodNsMFAT7yMsZ4AAAABX/ePQAAALCXfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCAjL/vHuB2y7I8Ho8xxp7F+VYfttb/+Opp/fXnnxcne1sf8aZJ1nvYudrWnr+8wi/P69ClmA983yG2jvhygOsnNbnCh454+rbZcxZ7pj2xt5eTYHyo5wMfGuDLz0/fmUcfpafN5+d13027tfgth/g5JzVfbb3noy/kK78sk709bf7yiN/4Ft0a/j/cNtffQhef8cmQp9/AV35qT9wPWwPc1zZXfjLWW/0m/n0HAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIBM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgIzljPHuGQAAgF38+w4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgBz5DgAAGfIdAAAy/gH5LV2aysUGjwAAAABJRU5ErkJggg==",
   "boleto_url": "https://boletos.fitbank.com.br/pdf/2023-04-18/4044kt2s.pdf",
   "code": "45090.13781 00000.127805 00255.550032 1 94790000001295",
   "hash": "00030101021226780025br.gov.bcb.pix2556qrcode.fitbank.com.br/QR/cobv/598D2EAA37098C4916EBD16CAA5204 000053039865802BR5922NEOFIN TECNOLOGIA LTDA6009Sao Paulo51080660600361070503***6304144C"
}
}
payments/overdue#
{
  "id": "d2b836f9-659f-4c2f-96c0-9cb2b57919c9",
  "customer_name": "Customer Name LTDA",
  "customer_document": "11112222000199",
  "customer_mail": "customer@email.com",
  "customer_phone": "+5511977773333",
  "address_street": "Rua Teste",
  "address_number": "123",
  "address_complement": "CJ 1",
  "address_neighborhood": "Centro",
  "address_zip_code": "01005000",
  "address_city": "São Paulo",
  "address_state": "SP",
  "billing_amount": "15000",
  "payment_number": "11111999999999-1",
  "payment_method": "bolepix",
  "payment_status": "overdue",
  "payment_amount": "15000",
  "description": "Cobrança 1111100000 - parcela 001/001",
  "installment": "1/1",
  "fine": 0.0,
  "fees": 0.0,
  "discount_before_payment_due_date": 1681757667,
  "discount_before_payment": 0.0,
  "due_date": 1681959600,
  "issued_at": 1681781894,
  "external_identifier": "1234",
  "os_code": "8888888888",
  "os_identifier": "5678",
  "nf_url": "https://nf.co/123098",
  "danfe": [
    {
      "number": "1234",
      "url": [
        "http://nfe.pref.sp.gov.br/con/nota.aspx?ccm=87654321&nf=1234&cod=K1ABCD2E"
      ]
    }
  ],
  "rps": "https://neofin-nf.co/1234567-abcd-1234-efgh-ijklmnopqrst/rps9876543210.pdf",
  "barcode_b64": "iVBORw0KGgoAAAANSUhEUgAAA+oAAADICAIAAADwcIwlAAAE1UlEQVR4nO3YyW6jUBRAQdPq///l17soMuGZIbRzoqodNsMFAT7yMsZ4AAAABX/ePQAAALCXfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCAjL/vHuB2y7I8Ho8xxp7F+VYfttb/+Opp/fXnnxcne1sf8aZJ1nvYudrWnr+8wi/P69ClmA983yG2jvhygOsnNbnCh454+rbZcxZ7pj2xt5eTYHyo5wMfGuDLz0/fmUcfpafN5+d13027tfgth/g5JzVfbb3noy/kK78sk709bf7yiN/4Ft0a/j/cNtffQhef8cmQp9/AV35qT9wPWwPc1zZXfjLWW/0m/n0HAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgIxljPHuGQAAgF38+w4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgBz5DgAAGfIdAAAy/gH5LV2aysUGjwAAAABJRU5ErkJggg==",
  "boleto_url": "https://boletos.fitbank.com.br/pdf/2023-04-18/4044kt2s.pdf",
  "code": "45090.13781 00000.127805 00255.550032 1 94790000001295",
  "hash": "00030101021226780025br.gov.bcb.pix2556qrcode.fitbank.com.br/QR/cobv/598D2EAA37098C4916EBD16CAA5204000053039865802BR5922NEOFIN TECNOLOGIA LTDA6009Sao Paulo51080660600361070503***6304144C"
}
payments/paid#
{
  "id": "d2b836f9-659f-4c2f-96c0-9cb2b57919c9",
  "customer_name": "Customer Name LTDA",
  "customer_document": "11112222000199",
  "customer_mail": "customer@email.com",
  "customer_phone": "+5511977773333",
  "address_street": "Rua Teste",
  "address_number": "123",
  "address_complement": "CJ 1",
  "address_neighborhood": "Centro",
  "address_zip_code": "01005000",
  "address_city": "São Paulo",
  "address_state": "SP",
  "billing_amount": "15000",
  "payment_number": "11111999999999-1",
  "payment_method": "bolepix",
  "payment_status": "paid",
  "payment_amount": "15000",
  "description": "Cobrança 1111100000 - parcela 001/001",
  "installment": "1/1",
  "fine": 0.0,
  "fees": 0.0,
  "discount_before_payment_due_date": 1681757667,
  "discount_before_payment": 0.0,
  "due_date": 1681959600,
  "issued_at": 1681781894,
  "external_identifier": "1234",
  "os_code": "8888888888",
  "os_identifier": "5678",
  "nf_url": "https://nf.co/123098",
  "danfe": [
    {
      "number": "1234",
      "url": "http://nfe.pref.sp.gov.br/con/nota.aspx?ccm=87654321&nf=1234&cod=K1ABCD2E"
    }
  ],
  "rps": "https://neofin-nf.co/1234567-abcd-1234-efgh-ijklmnopqrst/rps9876543210.pdf",
  "barcode_b64": "iVBORw0KGgoAAAANSUhEUgAAA+oAAADICAIAAADwcIwlAAAE1UlEQVR4nO3YyW6jUBRAQdPq///l17soMuGZIbRzoqodNsMFAT7yMsZ4AAAABX/ePQAAALCXfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCAjL/vHuB2y7I8Ho8xxp7F+VYfttb/+Opp/fXnnxcne1sf8aZJ1nvYudrWnr+8wi/P69ClmA983yG2jvhygOsnNbnCh454+rbZcxZ7pj2xt5eTYHyo5wMfGuDLz0/fmUcfpafN5+d13027tfgth/g5JzVfbb3noy/kK78sk709bf7yiN/4Ft0a/j/cNtffQhef8cmQp9/AV35qT9wPWwPc1zZXfjLWW/0m/n0HAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8z5DgAAGfIdAAAy/gH5LV2aysUGjwAAAABJRU5ErkJggg==",
  "boleto_url": "https://boletos.fitbank.com.br/pdf/2023-04-18/4044kt2s.pdf", 
  "code": "45090.13781 00000.127805 00255.550032 1 94790000001295",
  "hash": "00030101021226780025br.gov.bcb.pix2556qrcode.fitbank.com.br/QR/cobv/598D2EAA37098C4916EBD16CAA5204 000053039865802BR5922NEOFIN TECNOLOGIA LTDA6009Sao Paulo51080660600361070503\*\*\*6304144C",
  "paid_amount":"15000", 
  "paid_at":1681845201, 
  "paid_method: "pix"
}
payments/cancelled#
{
   "id":"d2b836f9-659f-4c2f-96c0-9cb2b57919c9",
   "customer_name":"Customer Name LTDA",
   "customer_document":"11112222000199",
   "customer_mail":"customer@email.com",
   "customer_phone":"+5511977773333",
   "address_street":"Rua Teste",
   "address_number":"123",
   "address_complement":"CJ 1",
   "address_neighborhood":"Centro",
   "address_zip_code":"01005000",
   "address_city":"São Paulo",
   "address_state":"SP",
   "billing_amount":"15000",
   "payment_number":"11111999999999-1",
   "payment_method":"bolepix",
   "payment_status":"canceled",
   "payment_amount":"15000",
   "description":"Cobrança 1111100000 - parcela 001/001",
   "installment":"1/1",
   "fine":0.0,
   "fees":0.0,
   "discount_before_payment_due_date":1681757667,
   "discount_before_payment":0.0,
   "due_date":1681959600,
   "issued_at":1681781894,
   "external_identifier":"1234",
   "os_code":"8888888888",
   "os_identifier":"5678",
   "nf_url":"<https://nf.co/123098>",
   "danfe":[
      {
         "number":"1234",
         "url":"http://nfe.pref.sp.gov.br/con/nota.aspx?ccm=87654321&nf=1234&cod=K1ABCD2E"
      }
   ],
   "rps":"https://neofin-nf.co/1234567-abcd-1234-efgh-ijklmnopqrst/rps9876543210.pdf",
   "barcode_b64":"iVBORw0KGgoAAAANSUhEUgAAA+oAAADICAIAAADwcIwlAAAE1UlEQVR4nO3YyW6jUBRAQdPq///l17soMuGZIbRzoqodNsMFAT7yMsZ4AAAABX/ePQAAALCXfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCAjL/vHuB2y7I8Ho8xxp7F+VYfttb/+Opp/fXnnxcne1sf8aZJ1nvYudrWnr+8wi/P69ClmA983yG2jvhygOsnNbnCh454+rbZcxZ7pj2xt5eTYHyo5wMfGuDLz0/fmUcfpafN5+d13027tfgth/g5JzVfbb3noy/kK78sk709bf7yiN/4Ft0a/j/cNtffQhef8cmQp9/AV35qT9wPWwPc1zZXfjLWW/0m/n0HAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZh0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIBM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgAz5DgAAGfIdAAAy5DsAAGTIdwAAyJDvAACQId8BACBDvgMAQIZ8BwCADPkOAAAZ8h0AADLkOwAAZMh3AADIkO8AAJAh3wEAIEO+AwBAhnwHAIAM+Q4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgIxljPHuGQAAgF38+w4AABnyHQAAMuQ7AABkyHcAAMiQ7wAAkCHfAQAgQ74DAECGfAcAgBz5DgAAGfIdAAAy/gH5LV2aysUGjwAAAABJRU5ErkJggg==",
   "boleto_url":"https://boletos.fitbank.com.br/pdf/2023-04-18/4044kt2s.pdf",
   "code":"45090.13781 00000.127805 00255.550032 1 94790000001295",
   "hash":"00030101021226780025br.gov.bcb.pix2556qrcode.fitbank.com.br/QR/cobv/598D2EAA37098C4916EBD16CAA5204000053039865802BR5922NEOFIN TECNOLOGIA LTDA6009Sao Paulo510806606003610705036304144C",
   "paid_amount":"15000",
   "paid_at":1681845201,
   "paid_method":"pix"
}

Regras#

barcode_b64: Disponível apenas para pagamentos com payment_method = boleto, nos eventos:
payments/registered
payments/overdue
payments/paid
payments/cancelled
boleto_url: Disponível apenas para pagamentos com payment_method = boleto, nos mesmos eventos acima.
code: Disponível apenas para pagamentos com payment_method = boleto, nos mesmos eventos acima.
hash: Disponível apenas para pagamentos com payment_method = pix, nos eventos:
payments/registered
payments/overdue
payments/paid
payments/cancelled
paid_amount: Disponível apenas no evento payments/paid.
paid_at: Disponível apenas no evento payments/paid.
paid_method: Disponível apenas para pagamentos com payment_method = bolepix, no evento payments/paid.
danfe: Este campo só será retornado se o pagamento tiver sido criado por meio de integração com ERP.
rps: Também retornado apenas se o pagamento tiver sido criado por meio de integração com ERP.

Tipos de Dados#

due_date: timestamp em segundos (tipo int).
issued_at: timestamp em segundos (tipo int).
discount_before_payment_due_date: timestamp em segundos (tipo int).
paid_at: timestamp em segundos (tipo int).
billing_amount: valor em centavos de Real (tipo string).
payment_amount: valor em centavos de Real (tipo string).
paid_amount: valor em centavos de Real (tipo string).

Possible Values#

payment_status: pending | paid | overdue | cancelled | paid_after_protested | paid_after_derrogatory | processing_protest | protested | derrogatory | pending_derrogatory | processing_derrogatory | derrogatory_cancelled | protest_cancelled
payment_method: pix | boleto | bolepix | tedin | pixin | generic | credit_card
paid_method: pix | boleto

Exemplos de headers#

X-Neofin-Topic: payments/created | payments/registered | payments/overdue | payments/paid | payments/cancelled
X-Neofin-Hmac-SHA256: Assinatura HMAC da requisição, usada para validar a autenticidade.
X-Neofin-Webhook-ID: ID único da requisição. Use para evitar processar webhooks duplicados.
X-Neofin-Datetime: Data do evento no formato ISO 8601.
X-Neofin-API-Version: Versão da API. Atualmente: 01-2023.
User-Agent: Sempre será 'neofin-webhook'.

Validação do Webhook#

A assinatura é gerada usando o corpo da requisição (payload) + sua API Secret Key, utilizando o algoritmo HMAC-SHA256.
🧪 Exemplo com Python (Flask)
Modified at 2025-04-10 23:00:16
Previous
Buscando um cliente pelo documento
Built with