Post de Notificação

O Post de Notificação é um webhook que envia notificações sobre mudanças no status da transação ou sobre criação de pedido recorrente.

Durante seu cadastro, você deve configurar uma URL (um endpoint) para que a nossa API envie as notificações.

Características da URL e do Post de notificação

	Características
URL	O endereço deve ser HTTPS; Não se deve utilizar uma porta fora de padrão HTTPS (443); A URL deve ser estática; Tem limite de 255 caracteres.
Post de notificação	É disparado a cada 30 minutos; Em caso de falha, são realizadas três novas tentativas.

Para aumentar a segurança, é possível cadastrar até três tipos de informações de retorno no cabeçalho para o seu endpoint. Com isso, seu endpoint só vai aceitar a notificação se a Cielo enviar o cabeçalho.

Para configurar as informações do header, informe ao Atendimento os itens a seguir:

KEY : nome do parâmetro;
VALUE: valor estático a ser retornado.

⚠️
Como existe a possibilidade de ocorrerem intermitências entre as APIs de envio e de recebimento, é recomendado fazer a sondagem (consulta) das transações pendentes (não pagas) que ainda não tenham sido atualizadas no dia.

Os parâmetros serão enviados à URL cadastrada, conforme demonstrado no exemplo a seguir.

Notificação enviada

{
   "PaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   "ChangeType": 1
}

Propriedade	Descrição	Tipo	Tamanho
`PaymentId`	Identificador que representa a transação.	GUID	36
`ChangeType`	Especifica o tipo de notificação. Obs.: Consulte a tabela abaixo.	Número	1

ChangeType	Descrição
1	Mudança de status do pagamento.
2	Recorrência criada.
3	Mudança de status do Antifraude.
4	Mudança de status do pagamento recorrente (Ex.: desativação automática).
5	Cancelamento/estorno negado.
6	Boleto registrado pago a menor.
7	Notificação de chargeback. Exclusivo para clientes integrados à Risk Notification API (legado).
8	Alerta de fraude.
25	Transação cancelada ou estornada parcialmente.

Resposta esperada

A loja deve responder à notificação com: HTTP Status Code 200 OK.

Caso não seja retornada a resposta acima, haverá mais duas tentativas de envio do Post de Notificação.