It is the notification sent to the Notification URL and can be in POST or JSON format.
Notification via POST
Contains all transaction data, including merchant_order_number and checkout_cielo_order_number, which can be used for transaction query .
Example:
order_number: "40e00eefbf094763a147af713fa07ece",
amount: "5000",
checkout_cielo_order_number: "b9ab1956738d45cc88edf51d7d03b13e",
created_date: "02/02/2023 17:01:35",
customer_name: "nome do cliente",
customer_phone: "2222222222",
customer_identity: "12312312344",
customer_email: "[email protected]",
shipping_type: "5",
shipping_price: "0",
payment_method_type: "6",
payment_installments: "1",
payment_status: "1",
test_transaction: "False",
product_id: "0f48e580-d0a2-4e3b-a748-6704927f1725",
product_type: "3",
product_description: "123",
nsu: "00339922"
See the description of the transaction details in the Notification content section.
Notification via JSON
Notification via JSON is a safer and more flexible method for making a query on the Payment Link. In this modality, the store receives the MerchantId and MerchantOrderNumber and a URL to perform a query (GET) on the Cielo Payment Link database and access the transaction details.
Notification content via JSON
MerchantId: "799g0de8-89c3-5d17-c670-6b29d7f00175",
MerchantOrderNumber: "1db9226geg8b54e6b2972e9b745b89c7",
Url: "https://cieloecommerce.cielo.com.br/api/public/v1/orders/799g0de8-89c3-5d17-c670-6b29d7f00175 /1db9226geg8b54e6b2972e9b745b89c7"
| PARAMETER | DESCRIPTION | TYPE |
|---|---|---|
URL | URL with the data necessary to search for transaction data. | string |
MerchantId | Merchant identifier at Cielo; It appears on the Cielo website in the Configuração > Dados Cadastrais menu. | alphanumeric (guid) |
MerchantOrderNumber* | Merchant order number. If not sent, 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 whitespace are not allowed. |
*In other requests and responses it may be called OrderNumber.
The store 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 URL query returned via JSON
Response
{
"order_number": "1db9226geg8b54e6b2972e9b745b89c7",
"amount": 101,
"discount_amount": 0,
"checkout_cielo_order_number": "65930e7460bd4a849502ed14d7be6c03",
"created_date": "10-03-2023 14:38:56",
"customer_name": "Test Test",
"customer_phone": "11987654321",
"customer_identity": "445556667",
"customer_email": "[email protected]",
"shipping_type": 1,
"shipping_name": "Motoboy",
"shipping_price": 1,
"shipping_address_zipcode": "06455-030",
"shipping_address_district": "Alphaville",
"shipping_address_city": "Barueri",
"shipping_address_state": "SP",
"shipping_address_line1": "Alameda Xingu",
"shipping_address_line2": "Apto 25",
"shipping_address_number": "512",
"payment_method_type": 1,
"payment_method_brand": 1,
"payment_maskedcreditcard": "482852******6856",
"payment_installments": 1,
"payment_status": 3,
"tid": "10558590697J62OH9BPB",
"test_transaction": "False"
}
See the description of the sale details in the Notification content section.
Notification content
Whether notifying via POST or via JSON, the content of the data returned is the same. All returned fields are described below, as well as their definitions and sizes:
| PARAMETER | DESCRIPTION | TYPE | MAXIMUM SIZE |
|---|---|---|---|
checkout_cielo_order_number | Unique identifier generated by Cielo | alphanumeric | 32 |
amount | Unit price of the product, in cents (e.g.: R$ 1,00 = 100) | numeric | 10 |
order_number | Order number sent by the store. If not sent, Cielo will generate a number that will be viewed by the consumer | alphanumeric For reconciliation purposes, the characters allowed are only a-z, A-Z, 0-9. Special characters and whitespace are not allowed. | 32 For reconciliation purposes, the maximum length is 20 characters. |
created_date | Date of order creation - `dd/MM/yyyy HH:mm:ss | alphanumeric | 20 |
customer_name | Name of the customer. If sent, this value is already filled in the Cielo screen | alphanumeric | 289 |
customer_identity | Customer identification (CPF or CNPJ). If sent, this value is already filled in the Cielo screen | alphanumeric | 14 |
customer_email | Consumer email. If sent, this amount is already filled in on the Cielo screen. | alphanumeric | 64 |
customer_phone | Customer phone number. If sent, this value is already filled in the Cielo screen. | numeric | 11 |
discount_amount | Discount amount provided (sent only if there was a discount). | numeric | 10 |
first_installment_discount | Discount, in percentage, for payments by credit card. | Whole number from 1 to 100 | 3 |
shipping_type | Shipping mode | numeric | 1 |
shipping_name | Shipping name | alphanumeric | 128 |
shipping_price | Value of the shipping service, in cents (e.g.: R$ 10,00 = 1000) | numeric | 10 |
shipping_address_zipcode | Delivery address zip code | numeric | 8 |
shipping_address_district | Delivery address neighborhood | text | 64 |
shipping_address_city | Delivery address city | alphanumeric | 64 |
shipping_address_state | Delivery address state | alphanumeric | 64 |
shipping_address_line1 | Delivery address | alphanumeric | 256 |
shipping_address_line2 | Delivery address complement | alphanumeric | 14 |
shipping_address_number | Delivery address number | numeric | 8 |
payment_method_type | Payment method type code | numeric | 1 |
payment_method_brand | Card brand (only for transactions with credit card payment method) | numeric | 1 |
payment_method_bank | Issuer bank (For Automatic Debit and Boleto transactions) | numeric | 1 |
payment_maskedcredicard | Masked Card (for transactions using credit and debit card payment methods) | alphanumeric | 20 |
payment_installments | Number of installments | numeric | 1 |
payment_antifrauderesult | Status of Credit Card Transactions in Antifraude | numeric | 1 |
payment_boletonumber | Number of boleto generated | string | 1 |
payment_boletoexpirationdate | Due date for transactions made with boleto | string | 10 |
payment_status | Transaction status | numeric | 1 |
tid | TransactionId Cielo generated at the time of transaction authorization | alphanumeric | 20 |
test_transaction | Indicates whether the transaction was generated with 'Test Mode' enabled | boolean | 32 |
product_id | Identifier of the Payment Button/Link that generated the transaction | alphanumeric | 36 |
product_type | Type of Button that generated the order (See ProductID table) | alphanumeric | 32 |
product_sku | Product identifier registered in the payment link | text | 16 |
product_max_number_of_installments | Number of installments released by retailers for the payment link | number | 2 |
product_expiration_date | Button/Payment Link expiration date | alphanumeric | 12 |
product_quantity | Number of transactions remaining until the link stops working | alphanumeric | 2 |
product_description | Description of the payment link registered by the merchant | text | 256 |
nsu | NSU - Unique sequential number of the transaction. | alphanumeric | 6 |
authorization_code | Authorization code. | alphanumeric | 8 |
ProductID types
| PAYMENT LINK TYPE | ENUN |
|---|---|
| Physical asset | 1 |
| Digital | 2 |
| Service | 3 |
| Payment | 4 |
| Recurrence | 5 |
Payment_status
The Payment Link has its own status, different from the Cielo website or the Cielo E-commerce API. See the complete list below.
| VALUE | TRANSACTION STATUS | PAYMENT METHODS | DESCRIPTION |
|---|---|---|---|
| 1 | Pending | For all payment methods | Indicates that the payment is still being processed; Boleto - Indicates that the status of the bill has not been changed by the merchant |
| 2 | Paid | For all payment methods | Transaction was captured and money will be deposited into account. |
| 3 | Denied | Only for Credit Card | Transaction not authorized by the person responsible for the payment method |
| 4 | Expired | Credit and Boleto Cards | Transaction is no longer valid for capture - 15 days after authorization |
| 5 | Voided | For credit cards | Transaction was canceled by the merchant |
| 6 | NotFinalized | All payment methods | Payment waiting Status - May indicate an error or processing failure. Contact Cielo Support |
| 7 | Authorized | Credit Card Only | Transaction authorized by the card issuer. It must be captured for the money to be deposited into the account |
| 8 | Chargeback | Only for Credit Card | Transaction canceled by the shopper along with the card issuer. The money will not be deposited into the account. |
Note: For order queries, the
payment.statusfield will be returned in text format, always in English (Transaction Status column).
Payment_antifrauderesult
Antifraude has the concept of Status and SubStatus, where the first represents the level of risk that a transaction has of being a fraud, and the second, additional information about the transaction.
| VALUE | ANTIFRAUDE STATUS | SUBSTATUS | DESCRIPTION |
|---|---|---|---|
| 1 | Low risk | Low risk | Low risk of being a fraudulent transaction. |
| 2 | High risk | High risk | High risk of being a fraudulent transaction. They are canceled automatically. |
| 4 | Not finished | Not finished | The query could not be finalized. |
| N/A | N/A | Not applicable | Debit card transaction that was authenticated by 3DS 2.0, therefore not eligible for anti-fraud analysis. |
| N/A | N/A | N/A | Non-analyzable payment method such as boleto, Pix, QR Code, and credit card transaction that was denied by the issuer. |
| N/A | N/A | Recurrence transaction | For recurrence cases, after the first paid transaction, the next transactions of a recurrence are not analyzed by anti-fraud. Only the first transaction is analyzed. |
Payment_method_type
The Payment Link only allows one type of Boleto per establishment, so the notification does not return whether the provider used was Bradesco or Banco do Brasil, as only one of them will be active in the affiliation.
| VALUE | DEFINITION | DESCRIPTION |
|---|---|---|
| 1 | Credit card | CreditCard |
| 2 | Boleto | Boleto |
| 4 | Debit card | DebitCard |
| 5 | QR code credit | QrCode |
| 6 | Pix | Pix |
| 7 | QR code debit | QrCodeCredit |
Note: For queries, the Type is returned in the
Payment.Typefield and is filled with the literal value (Description).
Payment_method_brand
The card brand.
| VALUE | DESCRIPTION |
|---|---|
| 1 | Visa |
| 2 | Master |
| 3 | AmericanExpress |
| 4 | Diners |
| 5 | Elo |
| 6 | Aura |
| 7 | JCB |
| 8 | Discover |
| 9 | HiperCard |
In queries, the card brand is returned in the Payment.Brand field and is filled in with the literal value.
Payment_method_bank
| VALUE | DESCRIPTION |
|---|---|
| 1 | Banco do Brasil |
| 2 | Bradesco |
Shipping_type
| VALUE | DESCRIPTION |
|---|---|
| 1 | Correios |
| 2 | Fixed shipping |
| 3 | Free shipping |
| 4 | In store pick up |
| 5 | No shipping (digital services or products) |
Correios shipping service currently unavailable.
If a request with this shipping option is sent, you will receive a return with error 400 and the message: "The shipping service by Correios is unavailable". If you use the service on your payment links or checkout pages, change the shipping type to the other available options.