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 se a venda deve ser baixada, recusada, estornada ou apenas registrada, consulte Eventos e decisões.

Entrega

POSTURL configurada no portal
CampoTipoDescrição
Portal do parceiroconfiguraçãoConfigure a URL no menu Integração. O token é recomendado, mas opcional.obrigatório
BodyJSONO corpo usa o mesmo envelope descrito em Eventos e decisões.obrigatório

Headers do evento

CampoTipoDescrição
AuthorizationHTTP headerEnviado como Bearer <token> quando o parceiro configurou token no portal.
X-ConnectTEF-Event-IdHTTP headerIdentificador único do evento para rastreio e idempotência.obrigatório
X-ConnectTEF-Event-TypeHTTP headerTipo do evento (ex: pagamento.aprovado, estorno.falhou).obrigatório
Content-TypeHTTP headerapplication/json.obrigatório

Responda antes de processar

Se houver token configurado, valide-o. Em seguida, salve o evento e retorne HTTP 2xx rapidamente. Baixa de pedido, conciliação, emissão fiscal ou integração com ERP 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.