Ir para o conteúdo

7.4. Informações Pagamentos Sacado

🔔 Tipo de Notificação

Campo Valor
tipoNotificacao 4

🧾 Descrição

Esta notificação será enviada via POST para o endpoint de WebHook configurado previamente quando recebermos o retorno da registradora referente à solicitação de informações de pagamento para o sacado. Ela indica se o processamento foi aceito ou se houve erro.


📤 Payload Enviado

✅ Sucesso

{
  "tipoNotificacao": 4,
  "sucessoProcessamento": true,
  "dadosPagamentoSacado": {
    "identificadorParticipante": "PART001",
    "cpfOuCnpj": "98765432000155",
    "codigoControle": "CTRL-001"
  },
  "erros": ""
}

❌ Erro

{
  "tipoNotificacao": 4,
  "sucessoProcessamento": false,
  "dadosPagamentoSacado": null,
  "erros": "Descrição do erro retornado pela registradora."
}

🧾 Detalhamento dos Campos

🔹 Raiz

Campo Tipo Descrição
tipoNotificacao integer Identifica o tipo da notificação (4 = Informações pagamentos sacado)
sucessoProcessamento boolean true = processamento aceito, false = erro
dadosPagamentoSacado object|null Dados retornados pela registradora (null em caso de erro)
erros string|null Mensagem de erro quando houver falha

🔹 dadosPagamentoSacado

Campo Tipo Descrição
identificadorParticipante string Identificação do participante admitido
cpfOuCnpj string CPF ou CNPJ do sacado
codigoControle string Código de controle da solicitação

📪 Exemplo de envio

POST /webhook/duplicata-escritural HTTP/1.1
Content-Type: application/json
Authorization: Bearer {seu_token}

{
  "tipoNotificacao": 4,
  "sucessoProcessamento": true,
  "dadosPagamentoSacado": {
    "identificadorParticipante": "PART001",
    "cpfOuCnpj": "98765432000155",
    "codigoControle": "CTRL-001"
  },
  "erros": ""
}

🕒 Observações

  • Esta notificação é assíncrona e disparada após o processamento do retorno recebido da registradora (arquivo ADUP020RET).
  • Em caso de erro técnico no processamento (arquivo ADUP020ERR), dadosPagamentoSacado será null e o campo erros conterá a descrição do problema.
  • O resultado é associado à solicitação feita via endpoint 6.3. Solicitar Informações de Pagamentos do Sacado.