Quando o protesto de uma cobrança sofrer uma troca de status, iremos notificar a sua aplicação através de nossos webhooks.
Os webhooks pagamentos são notificações enviadas pela Grafeno para seu sistema sempre que alguma cobrança tenha o seu status alterado.
Body Params
| Parâmetro | Descrição | Formato |
|---|---|---|
| signature | Assinatura criptografada para garantir a origem da informação. Não disponível em PRD. Sugerimos utilizar os custom-headers para garantir a origem da notificação. | string |
| change | Referência da alteração. | string |
| data.canceledAt | Data de cancelamento do protesto em formato "YYYY-MM-DD". | Date |
| data.chargeUuid | Identificador único da cobrança que foi protestada. | string |
| data.accountInformation.bank_code | Código do banco da conta bancária de origem da notificação. | string |
| data.accountInformation.agency | Agência da conta bancária de origem da notificação. | string |
| data.accountInformation.account | Conta bancária de origem da notificação. | string |
| data.createdAt | Data de criação do protesto em formato "YYYY-MM-DD". | Date |
| data.deletedAt | Data de remoção do protesto em formato "YYYY-MM-DD".. | Date |
| data.humanState | Status do protesto de forma legível. | string |
| data.number | Número do protesto. | string |
| data.updatedAt | Data da ultima atualização do protesto em formato "YYYY-MM-DD". | Date |
| data.uuid | Identificador único do protesto. | string |
Eventos de notificação para pagamentos
| Evento | Descrição |
|---|---|
| protesto-em-preparacao | O protesto está sendo preparado para envio e registro. |
| protesto-a-enviar | O protesto está em processo de envio. |
| protesto-em-processamento | Protesto encaminhado e em processamento. |
| falha-no-protesto | Ocorreu uma falha no processamento do protesto. |
| protesto-efetivado | O protesto foi processado e efetivado com êxito. |
| protesto-em-aceite | O protesto está em processo de aceite pelas partes envolvidas no processamento. |
| protesto-desistido | Houve desistência no aceite do protesto. |
| protesto-cancelado | O protesto foi cancelado. |
| protesto-em-cartorio | O processo está registrado no cartório. |
| protesto-pago | O valor protestado foi pago. |
| valor-repassado | O valor pago foi repassado com êxito para o recebedor. |
Exemplo
{
"signature": "VBFDP4FPvANDPPfi/hzG4fNEuR3zs3iscip5qR3PoAEmtgG0sE1F+uBrtykg\nb4WuGzP2ANmXPA7WMUSggO6OnbwWEw7EjGI/LT0yQawKjXacWSpVBxn73ydd\nTqt3bU7nXKdlKllTfeMBni/W0IZZYzfvOEimKPIY0TmIt1HGmZj5AGA4vv7B\nLuXifVcCp2g5AD3JlSnor/9R/U6CBAHVqupxtpNLsO2bWsUslsVosQoXoQbd\nvwON8rhKvCXNIBW6mzkFrQkk6tS5jviu8b2CzL+1qEdLr+pDITBGqrdeTdBc\nVQPVpuxKIoWtTcSOdWPJvEKcMjv7nzdy9hggktNZBZ1h/r22U3CpOmnx7e9o\nkV+cwAnvWEdCtg0sEeGBq29Uqw3xAIpdHHwAgmc1mPKhdzmqlXl1lYfWXx91\nwXhAQ6kaAlvN8tnVGlRGxiYjBu9P7pa3smwMOgksIGdxoa9de2mSVkPZFqLW\n4jAcnHbtEPAV8MajLWlSyaSuDn5wA+md9i8byfOXQijBKbzcYSGM+rNxglB8\nHl8ulDAS/wqmuPH7F/Gga/fiPXK12mWb+IBjH14eRrkixwnepqDEte8uC6D6\nfc1rTWW61pPw1wVrIwulLeiXr+bTo7cThj0HdVAz35MXmPc1K/c22jjxLX5H\nUhd88gEcb5abt0MpUj7QG2k=\n",
"change": "protesto-em-preparacao",
"data": {
"accountInformation": {
"agency": "0001",
"bank_code": "310",
"account": "xxxxxxxx-x"
},
"canceledAt": null,
"chargeUuid": "d649b59f-b1b2-4b58-bb00-f3fbf2e54f7d",
"createdAt": "2025-11-13T16:36:56.864-03:00",
"deletedAt": null,
"humanState": "Aguardando Aprovação da Instrução de Protesto",
"number": "1405-006",
"updatedAt": "2025-11-13T16:36:56.864-03:00",
"uuid": "8806c355-11f6-4ff3-b4c6-678cbc0bed46"
}
}