Receber Notificação de Operações (Remessas) — Webhook
POST
/returnSituationCnab
Parâmetros
| Atributo | Tipo | Obrig | Tam | Ocorr | Descrição |
|---|---|---|---|---|---|
| token | Sim | 1:1 | Estrutura do token de autenticação | ||
| cnabList | Sim | 1:N | Lista de CNABs (remessas) aprovados ou rejeitados | ||
| cnpjNumber | Num | Sim | - | 1:1 | Raiz do CNPJ do fundo (os oito primeiros números) |
| cnpjSubsidiary | Num | Sim | - | 1:1 | Filial do CNPJ (os quatro dígitos seguintes após a barra) |
| cnpjDigit | Num | Sim | - | 1:1 | Dígito verificador do CNPJ (os dois últimos dígitos, após o traço) |
| additiveNumber | Num | Sim | - | 1:1 | Número do aditivo (Identificador da operação dentro do sistema do cliente) |
| situation | Alfa | Sim | 1 | 1:1 | Situação da remessa (ver tabela Situação da Remessa) |
| observation | Alfa | Não | - | 0:1 | Observações feitas aos documentos que foram rejeitados |
Situação da Remessa
| Código | Descrição |
|---|---|
| S | Aprovada |
| N | Rejeitada |
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/returnSituationCnab' \
--header 'Content-Type: application/json' \
--data '{
"token": "###############################################",
"cnabList": [
{
"cnpjNumber": 99999999,
"cnpjSubsidiary": 9999,
"cnpjDigit": 99,
"additiveNumber": 999999,
"situation": "N",
"observation": "DESCRICAO OBSERVACAO"
}
]
}'Response Response Example
200 - response
{
"status": "OK"
}Modified at 2026-06-01 13:33:11