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.	62 For your order number to be sent in the transaction to the statement for reconciliation purposes, the functional maximum limit 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
`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
`pagador_recurrent_payment_id`	Identifier of the generated recurrence	alphanumeric	36
`recurrent_status`	Recurrence start	text	50
`start_date`	Recurrence start date	alphanumeric	20
`end_date`	Recurrence end date. If not sent, the recurrence ends only if canceled	alphanumeric	20
`interval`	Recurrence interval: Monthly; Bimonthly; Quarterly; Semiannual; Annual.	string	128
`payment_end_to_end_id`	Unique Pix identifier generated by the bank, for use in reconciling PIX transactions.	string	64
`pagador_end_to_end_id`	Unique Pix identifier generated by the bank, for use in reconciling PIX transactions.	string	64

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	Boleto, Pix and QR Code	Indicates that the payment is still being processed or is pending some step by the cardholder. Example: a boleto transaction with Pending status indicates that the boleto status has not been changed by the shopper.
2	Paid	All payment methods	Transaction was captured and money will be deposited into account.
3	Denied	Credit and debit cards	Transaction not authorized by the person responsible for the payment method.
4	Expired	Credit, debit and boleto cards	Credit and debit cards:* the transaction is no longer valid for capture 15 days after authorization. Boleto:* the boleto expires after the expiration date set by the Cielo E-commerce Support team at the merchant's request.
5	Voided	Credit and debit cards	Transaction canceled by the merchant.
6	NotFinalized	All payment methods	Payment awaiting new Status. This may indicate an error or processing failure. Contact Cielo E-commerce Support.
7	Authorized	Credit and debit cards	Transaction authorized by the card issuer. It must be captured for the money to be deposited in the account (by default, the transaction can be captured up to 15 days after authorization).
10	AuthorizedIdPayPending	Credit card	Indicates that facial biometrics are pending. The shopper has up to one hour to authenticate. This status will be updated after authentication to 2 (paid) or 3 (denied).If authentication does not take place, it will be changed to 5 (canceled).

Note: For order queries, the payment.status field 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.Type field 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

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.