Notification Post
Notification Post is a webhook that sends notifications about changes in transaction status or recurring order creation.
During your cielo registration, you must set up an endpoint for Cielo to send notifications and you can also configure the events for which you want to receive notifications.
Notified Events
Events that can be notified by payment method are:
Payment Method | Events that can be notified |
---|---|
Credit Card | Capture; Cancellation; Queries. |
Debit Card | Capture; Queries. |
Boleto | Conciliation; Manual cancellation |
Electronic transfer | Confirmed transers. |
Notification also occurs at events related to Cielo Scheduled Recurrence:
Recurrence Events |
---|
Disabled when reaching maximum number of attempts (denied transactions) |
Rehabilitation |
Finalized / Completion date reached |
Deactivation |
Creation of the recurring order recurrence transaction. |
Events are only notified when you request this type of notification from Cielo Support.
Notification Endpoint
You must report an endpoint (PAYMENT STATUS URL
) to Cielo Support for the Notification Post to run.
Characteristics of Payment Status URL
- Must be static;
- Limit of 255 characters.
Characteristics of Post notification
- It is sent every 30 minutes;
- In the event of a failure, three retries are made.
To increase security, you can register header return information for your endpoint. With this, your endpoint will only accept the notification if Cielo sends the header.
To set up the header information, please inform Cielo Support of the following:
KEY
- Parameter nameVALUE
- Static value to be returned
You can register up to 3 types of return information in the header.
The merchant should return in response to the notification: HTTP Status Code 200 OK.
The content of the notification will consist of three fields:
RecurrentPaymentId
: identifier that represents a set of recurring transactions;PaymentId
: payment identification number;ChangeType
: specifies the type of notification.
Using this data you can identify the transaction via PaymentId
or RecurrentPaymentId
and the change that ocurred. After the notification, you can get more details about the transaction by Searching for a transaction via PaymentId or by Searching for recurrence information.
Here's 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
}
Property | Description | Type | Size | Required |
---|---|---|---|---|
RecurrentPaymentId | Identifier representing the Recurring request (only applicable for ChangeType 2 or 4). | GUID | 36 | No |
PaymentId | Payment identification number. | GUID | 36 | Yes |
ChangeType | Specifies the type of notification. | Number | 1 | Yes |
ChangeType table
ChangeType | Description |
---|---|
1 | Payment status change. |
2 | Recurrence created. |
3 | Antifraude status change. Exclusive for customers integrated with Antifraude. |
4 | Recurring payment status change (eg automatic deactivation). |
5 | Cancellation denied. |
7 | Chargeback notification. Exclusive for merchants integrated with Risk Notification API (deprecated). |
8 | Fraud alert. |
Risk Notification API is being deprecated. The new Cielo service for querying, accepting and disputing a chargeback is Chargeback API.
Updated 21 days ago