Post de Notificação

O Post de Notificação é um webhook que informa mudanças no status das transações e eventos relacionados a pagamentos recorrentes.

Para receber as notificações, configure no Site Cielo a URL do endpoint e selecione os eventos que deseja receber.

Eventos notificados

O Post de Notificação pode informar eventos relacionados a cartões, Pix, boleto, carteiras digitais, Open Finance, cancelamentos e recorrência.

Os eventos disponíveis podem variar de acordo com os produtos e serviços habilitados para o estabelecimento.

Para receber as notificações, configure no Site Cielo a URL do endpoint e selecione os eventos desejados.

Consulte URL de notificações para saber como configurar a URL, os headers personalizados e os eventos que devem gerar notificações.

As notificações são enviadas apenas para os eventos selecionados na configuração.

Requisitos do endpoint

O endpoint configurado para receber o Post de Notificação deve:

• Ter protocolo HTTPS;
• Usar a porta padrão HTTPS (443);
• Ser estático;
• Ter, no máximo, 255 caracteres;
• Receber conteúdo no formato application/json.

O endpoint deve retornar o HTTP Status Code 200 OK ao receber a notificação.

Headers personalizados

Para aumentar a segurança, é possível configurar headers personalizados que serão enviados ao endpoint junto com a notificação.

Cada header é composto por:

• KEY : nome do parâmetro, limitado a 256 caracteres;
• VALUE: valor estático a ser retornado, limitado a 1500 caracteres.

É possível cadastrar até três headers.

A configuração dos headers é realizada no Site Cielo. Para mais informações, consulte URL de notificações.

Conteúdo da notificação

O conteúdo do Post de Notificação é formado pelos seguintes campos:

• RecurrentPaymentId: identificador do pedido recorrente, quando aplicável;
• PaymentId: número de identificação do pagamento;
• ChangeType: identifica o tipo de notificação.

Com o PaymentId ou o RecurrentPaymentId, consulte os dados atualizados da transação em Consulta por PaymentId ou Consulta de Recorrência.

Veja o exemplo do conteúdo do Post de Notificação:

{
  "RecurrentPaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "PaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "ChangeType": 2
}

curl
--header "key: value"
{
   "RecurrentPaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   "PaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   "ChangeType": 2
}

Tabela de ChangeType

O campo ChangeType identifica o evento que gerou a notificação.