🔔 Tipo de Notificação
| Campo | Valor |
| tipoNotificacao | 3 |
🧾 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 gerais do sacado. Ela indica se o processamento foi concluído com sucesso ou se houve erro, e retorna os dados da solicitação.
📤 Payload Enviado
✅ Sucesso
{
"tipoNotificacao": 3,
"sucessoProcessamento": true,
"dadosSacado": {
"identificadorParticipante": "PART001",
"cpfOuCnpj": "98765432000155",
"codigoControle": "CTRL-001",
"mensagemRetorno": "Informações registradas com sucesso."
},
"erros": ""
}
❌ Erro
{
"tipoNotificacao": 3,
"sucessoProcessamento": false,
"dadosSacado": 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 (3 = Informações sacado) |
| sucessoProcessamento | boolean | true = processamento concluído com sucesso, false = erro |
| dadosSacado | object|null | Dados retornados pela registradora (null em caso de erro) |
| erros | string|null | Mensagem de erro quando houver falha |
🔹 dadosSacado
| 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 |
| mensagemRetorno | string | Mensagem de retorno da solicitação de informações gerais |
📪 Exemplo de envio
POST /webhook/duplicata-escritural HTTP/1.1
Content-Type: application/json
Authorization: Bearer {seu_token}
{
"tipoNotificacao": 3,
"sucessoProcessamento": true,
"dadosSacado": {
"identificadorParticipante": "PART001",
"cpfOuCnpj": "98765432000155",
"codigoControle": "CTRL-001",
"mensagemRetorno": "Informações registradas com sucesso."
},
"erros": ""
}
🕒 Observações
- Esta notificação é assíncrona e disparada após o processamento do retorno recebido da registradora (arquivo ADUP018RET).
- Em caso de erro técnico no processamento (arquivo ADUP018ERR),
dadosSacado será null e o campo erros conterá a descrição do problema. - O resultado é associado à solicitação feita via endpoint 6.2. Solicitar Informações Gerais do Sacado.