Notification Post

Notification Post is a webhook that reports changes in transaction status and events related to recurring payments.

To receive notifications, configure the endpoint URL on the Cielo Website and select the events you want to receive.

Notified events

Notification Post can report events related to cards, Pix, boleto, digital wallets, Open Finance, voids, and recurrence.

The available events may vary according to the products and services enabled for the merchant.

To receive notifications, configure the endpoint URL on the Cielo Website and select the events you want.

See Notification URL to learn how to configure the URL, custom headers, and the events that must generate notifications.

Notifications are sent only for the events selected in the configuration.

Endpoint requirements

The endpoint configured to receive Notification Post must:

• Use the HTTPS protocol;
• Use the standard HTTPS port (443);
• Be static;
• Have a maximum of 255 characters;
• Receive content in application/json format.

The endpoint must return the HTTP status code 200 OK when it receives the notification.

Custom headers

To increase security, you can configure custom headers that are sent to the endpoint along with the notification.

Each header consists of:

• KEY: parameter name, limited to 256 characters;
• VALUE: static value to be returned, limited to 1500 characters.

You can register up to three headers.

You configure the headers on the Cielo Website. For more information, see Notification URL.

Notification content

The Notification Post content consists of the following fields:

• RecurrentPaymentId: identifier of the recurring order, when applicable;
• PaymentId: payment identification number;
• ChangeType: identifies the type of notification.

With the PaymentId or the RecurrentPaymentId, query the updated transaction data in Query by PaymentId or Query recurrence.

Here is an example of the Notification Post content:

{
  "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
}

ChangeType table

The ChangeType field identifies the event that generated the notification.