It is sent to the status change URL and contains the checkout_cielo_order_number, the new status and some transaction data.
To find out more details about the transaction, make a query using checkout_cielo_order_number.
Warning
The status change notification may take up to 3 minutes to be sent after the transaction completion notification.
Notification via POST
The status change notification format is POST (form data).
checkout_cielo_order_number: "b918afea483d4c6c8615d8a8e19803c1",
amount: "134",
order_number: "024f77ac98cb493b86d8c818eb6e79cd",
payment_status: "3",
test_transaction: "False",
brand: "Visa",
nsu: "000001",
authorization_code: "01234567"
checkout_cielo_order_number: "b918afea483d4c6c8615d8a8e19803c1",
amount: "134",
order_number: "024f77ac98cb493b86d8c818eb6e79cd",
payment_status: "3",
test_transaction: "False",
brand: "Visa",
nsu: "000001",
authorization_code: "01234567"
payment_end_to_end_id: "E00416968202410221813X6L1laUpSKC"
| PARAMETER | DESCRIPTION | TYPE | MAXIMUM SIZE |
|---|---|---|---|
checkout_cielo_order_number | Unique identifier generated by Checkout Cielo. | alphanumeric | 32 |
amount | Unit price of the product, in cents (ex: R$ 1.00 = 100) | number | 10 |
order_number | Order number sent by the store. If it is not sent, Checkout Cielo will generate a number, which will be viewed by the consumer. | alphanumeric For reconciliation purposes, the characters allowed are only a-z, A-Z, 0-9. Special characters and blank spaces are not allowed. | 62 For your order number to be sent in the transaction to the statement for reconciliation purposes, the functional maximum limit is 20 characters. |
payment_method_brand | Brand - only for transactions using a credit card payment method. Full list | number | 20 |
payment_status | Transaction status. Full List | number | 1 |
test_transaction | Indicates whether the transaction was generated with Test Mode activated | boolean | 32 |
nsu | NSU - Unique sequential number of the transaction. | alphanumeric | 6 |
authorization_code | Authorization code. | alphanumeric | 8 |
payment_end_to_end_id | Unique Pix identifier generated by the bank, for use in reconciling PIX transactions. | String | 64 |
Notification via JSON
Notification via JSON is a safer and more flexible method for performing a query on the Link de Pagamento Cielo. In this method, the merchant receives the MerchantId and the MerchantOrderNumber and a URL to perform a query (GET) with the Cielo database and access the transaction details.
Notification content via JSON
MerchantId=c89fdfbb-dbe2-4e77-806a-6d75cd397dac&
MerchantOrderNumber=12345&
Url=https://cieloecommerce.cielo.com.br/api/public/v1/orders/c89fdfbb-dbe2-4e77-806a-6d75cd397dac/12345
| PARÂMETRO | DESCRIÇÃO | TIPO DO CAMPO |
|---|---|---|
URL | URL with the data needed to search for transaction data. | string |
MerchantId | Merchant identifier in the Link de Pagamento; available on the Cielo website in the Configuration > Registration Data menu. | alphanumeric(guid) |
MerchantOrderNumber* | Merchant order number. If not sent, the Link de Pagamento Cielo will generate a number, which will be viewed by the consumer. | alphanumeric For reconciliation purposes, the only allowed characters are a-z, A-Z, 0-9. Special characters and whitespace are not allowed. |
*In other requests and responses it may be called OrderNumber.
The merchant server must send the return HTTP Status = 200 (OK) to the Payment Link API, indicating that the notification was received and processed successfully.
Example of a query to the URL returned via JSON for credit card
Response
{
"$id": "1",
"order_number": "12345",
"amount": 1000,
"checkout_cielo_order_number": "8245e94dcf4c4de3906118e38f376822",
"created_date": "05/02/2024 15:05:44",
"customer_name": "leo menezes",
"customer_phone": "11234123411",
"customer_identity": "12345678909",
"customer_identity_type": 0,
"customer_email": "[email protected]",
"shipping_type": 1,
"shipping_price": 0,
"payment_method_type": 1,
"payment_method_brand": 2,
"payment_maskedcreditcard": "521199******4859",
"payment_installments": 1,
"payment_status": 4,
"tid": "0205030548978",
"recurrent_payment_id": "0207ce76-8144-48dc-8b17-876465bc3a6d",
"interval": "Anual",
"recurrent_status": "Ativa",
"start_date": "05/02/2024",
"end_date": "30/03/2026",
"test_transaction": "False",
"product_id": "1a4a8abe-bb73-4661-b4e9-b2c7adae0328",
"product_type": 5,
"nsu": "622269",
"authorization_code": "362902"
}
See the description of the sale details in the Notification content
Example of a query to the URL returned via JSON for the Pix payment method
{
"$id": "1",
"order_number": "924d5ba4e9b74ad39701",
"amount": 5000,
"checkout_cielo_order_number": "afab88cd316e44d29f67",
"created_date": "20/12/2024 10:02:16",
"customer_name": "Victor Barbosa",
"customer_phone": "11954962272",
"customer_phone_country": "",
"customer_identity": "12345678909",
"customer_identity_type": 0,
"customer_country": "",
"customer_email": "[email protected]",
"shipping_type": 6,
"shipping_price": 0,
"payment_method_type": 6,
"payment_installments": 1,
"payment_status": 1,
"test_transaction": "False",
"product_id": "efc24d9c-bab1-4eb5-aaf7-797ce7aa3c6f",
"product_type": 4,
"pagador_end_to_end_id": "E7482019356710248901234567890123"
}