1. Enviando Notificações
Neofin V1
latest
  • latest
  • english
  • Inicie sua jornada na Neofin
  • Preparando seus ambientes
  • Dúvidas frequentes
  • Premissas comportamentais da API (default x personalização)
  • Premissas de infraestrutura da API (default x personalização)
  • 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
        • V2
          • Marcar como pago - V2
        • Marcando como paga
          PUT
      • Cancelando uma cobrança
        • Como cancelar uma cobrança
        • Cancelando uma cobrança
          PUT
      • Reabrindo uma cobrança
        • Como reabrir uma cobrança
        • Reabrir cobrança
      • Listando suas cobranças
        • Como listar suas cobranças
        • Todas as cobranças
          GET
        • Cobranças por status
          GET
        • Cobranças por cliente
          GET
        • Cobranças por data de atualização
          GET
        • Eventos de cobranças
          GET
        • Eventos de uma uma cobrança por Integration Identifier
          GET
        • Cobranças por data de pagamento
          GET
      • Enviando anexos
        • Como enviar anexos
        • Anexando outros arquivos
          POST
        • Anexando uma NF a uma cobrança pelo Integration Identifier
          PUT
        • Anexando um Boleto a uma cobrança pelo Integration Identifier
          PUT
      • Enviando Notificações
        • Reenvio de Notificações de Cobranças
        • enviando notificações
          POST
    • 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
        • Listando réguas disponíveis
          GET
        • Buscando tags vinculadas a um cliente
          GET
    • Webhooks
      • Como preparar seus webhooks
      • Como preparar seus webhooks - Atualizado
  • Schemas
    • API Return
      • BillingsOutput
      • BillingsEventsOutput
      • ResumedBillingsEventsOutput
      • BillingsByPaymentDateOutput
      • ForbidennModel
    • Enums
      • BillingStatusEnum
      • InstallmentTypeEnum
      • BillingType
    • Sub Entities
      • GenericBoleto
      • BillingInInstallment
      • Payments
    • Customer
      • Customer Tags
      • Customer
    • Billing
    • BillingEvent
    • ResumedBillingEvent
    • CommonReturnModel
    • BillingWithPayments
    • UpsertBilling
    • InstallmentWithBilling
    • Attachment
    • UpsertCustomer
  1. Enviando Notificações

Reenvio de Notificações de Cobranças

Reenviar Notificações de Cobranças#

POST /billing/send-notification
Aciona o reenvio das notificações de todas as parcelas de uma ou mais cobranças. Utilize este endpoint quando o cliente final não recebeu a notificação original (e-mail ou WhatsApp) e seja necessário realizar um novo envio manualmente.

Requisição#

Headers#

HeaderValor
Content-Typeapplication/json
api-keySua chave de API
secret-keySua senha de API

Body#

{
  "billing_numbers": ["BN-001", "BN-002"],
  "integration_identifiers": ["PEDIDO-123"]
}
CampoTipoObrigatórioDescrição
billing_numbersstring[]CondicionalLista de números de cobrança gerados pela Neofin (ex.: BN-001)
integration_identifiersstring[]CondicionalLista de identificadores do seu sistema enviados na criação da cobrança
Importante: Pelo menos um dos campos deve ser informado. É possível enviar ambos na mesma requisição. As cobranças serão deduplicadas automaticamente.

Comportamento#

Ao receber a requisição, o endpoint:
1.
Localiza todas as cobranças informadas (por billing_numbers, por integration_identifiers ou por ambos).
2.
Para cada cobrança encontrada, busca todas as suas parcelas.
3.
Enfileira o reenvio da notificação de cada parcela individualmente.
O processamento é assíncrono. A API retorna 202 Accepted assim que a solicitação é enfileirada, antes que as notificações sejam efetivamente enviadas.
Cobranças não encontradas são ignoradas silenciosamente e a API ainda retornará 202 Accepted.

Respostas#

202 Accepted#

Solicitação enfileirada com sucesso.
{}

400 Bad Request#

Nenhum identificador informado.
{
  "msg": "billing_numbers or integration_identifiers is required"
}

500 Internal Server Error#

Erro inesperado durante o processamento.
{
  "msg": "A error occurred when send notification"
}

Exemplos#

Reenviar por número de cobrança#

Reenviar por identificador de integração#

Reenviar múltiplas cobranças#


Observações#

O envio das notificações respeita os canais configurados para a cobrança (e-mail, sms e/ou WhatsApp).
Se uma cobrança possuir múltiplas parcelas, cada parcela receberá uma notificação individual.
Previous
Anexando um Boleto a uma cobrança pelo Integration Identifier
Next
enviando notificações
Built with