Receber retorno
Webhooks
Configure uma URL para receber notificações assíncronas quando uma operação chegar a um resultado final.
Webhook não substitui o contrato de eventos
Esta página explica como receber a chamada HTTP. Para decidir o resultado de cada operação, consulte a aba Webhook da rota correspondente na API Reference.
Entrega
POSTURL configurada no portal
| Campo | Tipo | Descrição |
|---|---|---|
| Portal do parceiro | configuração | Configure a URL no menu Integração. O token é recomendado, mas opcional.obrigatório |
| Body | JSON | O corpo usa o envelope descrito na aba Webhook da rota correspondente.obrigatório |
Headers do evento
| Campo | Tipo | Descrição |
|---|---|---|
| Authorization | HTTP header | Enviado como Bearer <token> quando o parceiro configurou token no portal. |
| X-ConnectTEF-Event-Id | HTTP header | Identificador único do evento para rastreio e idempotência.obrigatório |
| X-ConnectTEF-Event-Type | HTTP header | Tipo do evento (ex: pagamento.aprovado, estorno.falhou).obrigatório |
| Content-Type | HTTP header | application/json.obrigatório |
Responda antes de processar
Salve o evento e retorne HTTP 2xx rapidamente dentro de 1 ou 2 segundos no máximo. A conclusão da venda ou pedido, conciliação ou emissão fiscal devem rodar depois, fora do request do webhook.
Idempotência obrigatória
Cada evento pode ser reenviado. Use o identificador do evento para garantir que a mesma operação não seja processada mais de uma vez.