Conteúdo das notificações

Tanto na notificação via POST ou via JSON, o conteúdo dos dados retornados é o mesmo. A seguir são descritos todos os campos retornados, assim como suas definições e tamanhos:

PARÂMETRO	DESCRIÇÃO	TIPO DO CAMPO	TAMANHO MÁXIMO
`checkout_cielo_order_number`	Identificador único gerado pelo Link de Pagamento Cielo.	Alfanumérico	32
`amount`	Preço unitário do produto, em centavos (ex: R$ 1,00 = 100)	Número	10
`order_number`	Número do pedido enviado pela loja. Se não for enviado, o Link de Pagamento Cielo gerará um número, que será visualizado pelo consumidor.	Alfanumérico Para fins de conciliação, os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.	62 Para que o número do pedido percorra todo o fluxo transacional até a conciliação financeira, o limite máximo funcional é de 20 caracteres.
`created_date`	Data da criação do pedido - dd-MM-yyyy HH:mm:ss	Alfanumérico	20
`customer_name`	Nome do consumidor. Se enviado, esse valor já vem preenchido na tela do Link de Pagamento Cielo	Alfanumérico	289
`customer_identity`	Identificação do consumidor (CPF ou CNPJ) Se enviado, esse valor já vem preenchido na tela do Link de Pagamento Cielo	Alfanumérico	14
`customer_email`	E-mail do consumidor. Se enviado, esse valor já vem preenchido na tela do Link de Pagamento Cielo	Alfanumérico	64
`customer_phone`	Telefone do consumidor. Se enviado, esse valor já vem preenchido na tela do Link de Pagamento Cielo	Número	11
`discount_amount`	Valor do desconto fornecido (enviado somente se houver desconto)	Número	10
`shipping_type`	Modalidade de frete	Número	1
`shipping_name`	Nome do frete	Alfanumérico	128
`shipping_price`	Valor do serviço de frete, em centavos (ex: R$ 10,00 = 1000)	Número	10
`shipping_address_zipcode`	CEP do endereço de entrega	Número	8
`shipping_address_district`	Bairro do endereço de entrega	Texto	64
`shipping_address_city`	Cidade do endereço de entrega	Alfanumérico	64
`shipping_address_state`	Estado de endereço de entrega	Alfanumérico	64
`shipping_address_line1`	Endereço de entrega	Alfanumérico	256
`shipping_address_line2`	Complemento do endereço de entrega	Alfanumérico	14
`shipping_address_number`	Número do endereço de entrega	Número	8
`payment_method_type`	Cód. do tipo de meio de pagamento	Número	1
`payment_method_brand`	Bandeira (somente para transações com meio de pagamento cartão de crédito)	Número	1
`payment_method_bank`	Banco emissor (Para transações de Boleto e Débito Automático)	Número	1
`payment_maskedcreditcard`	Cartão Mascarado (para transações com meio de pagamento cartão de crédito e débito)	Alfanumérico	20
`payment_installments`	Número de parcelas	Número	1
`payment_antifrauderesult`	Status das transações de cartão de Crédito no Antifraude	Número	1
`payment_boletonumber`	número do boleto gerado	String	1
`payment_boletoexpirationdate`	Data de vencimento para transações realizadas com boleto bancário	String	10
`payment_status`	Status da transação	Número	1
`tid`	TransactionId Cielo gerado no momento da autorização da transação	Alfanumérico	20
`test_transaction`	Indica se a transação foi gerada com o Modo de teste ativado	Boolean	32
`product_id`	Identificador do Botão/Link de pagamento que gerou a transação	Alfanumérico	36
`product_type`	Tipo de Botão que gerou o pedido (Ver tabela de ProductID)	Alfanumérico	32
`product_sku`	Identificador do produto cadastro no link de pagamento	texto	16
`product_max_number_of_installments`	Número de parcelas liberado pelo lojistas para o link de pagamento	Número	2
`product_expiration_date`	Data de validade do botão/Link de pagamento	Alfanumérico	12
`product_quantity`	Número de transações restantes até que o link deixe de funcionar	Alfanumérico	2
`product_description`	Descrição do link de pagamentos registrada pelo lojista	texto	256
`nsu`	NSU - Número sequencial único da transação.	Alfanumérico	6
`authorization_code`	Código de autorização.	Alfanumérico	8
`pagador_recurrent_payment_id`	Identificador da recorrência gerada.	Alfanumérico	36
`recurrent_status`	Status da recorrência.	texto	50
`start_date`	Data de início da recorrência.	Alfanumérico	20
`end_date`	Data de encerramento da recorrência. Se não enviado, a recorrência se encerra somente se cancelada.	Alfanumérico	20
`interval`	Intervalo da recorrência: Mensal; Bimensal; Trimestral; Semestral; Anual.	string	128
`payment_end_to_end_id`	Identificador único do Pix gerado pelo banco, para uso em conciliação de transações PIX.	string	64
`pagador_end_to_end_id`	Identificador único do Pix gerado pelo banco, para uso em conciliação de transações PIX.	string	64

Tipos de productID

TIPO DE LINK DE PAGAMENTO	ENUN
Material físico	1
Digital	2
Serviço	3
Pagamento	4
Recorrência	5

Payment_status

O Link de Pagamento possui status próprios, diferente do site Cielo ou da API E-commerce Cielo. Veja a seguir a lista completa.

VALOR	STATUS DE TRANSAÇÃO	TRANSACTION STATUS	MEIOS DE PAGAMENTO	DESCRIÇÃO
1	Pendente	Pending	Boleto, Pix e QR Code	Indica que o pagamento ainda está sendo processado ou está pendente de alguma etapa por parte do portador. Exemplo: uma transação de boleto com status Pendente indica que o boleto não teve o status alterado pelo comprador.
2	Pago	Paid	Todos os meios de pagamento	A transação foi capturada e o dinheiro será depositado em conta.
3	Negado	Denied	Cartão de crédito e débito	Transação não autorizada pelo responsável do meio de pagamento.
4	Expirado	Expired	Cartão de crédito, débito e boleto	Cartão de crédito e débito:* a transação deixa de ser válida para captura 15 dias após autorização. Boleto:* o boleto expira após data de expiração configurada pelo time de Suporte Cielo E-commerce conforme solicitação do estabelecimento.
5	Cancelado	Voided	Cartão de crédito e débito	Transação cancelada pela loja.
6	Não Finalizado	NotFinalized	Todos os meios de pagamento	Pagamento esperando novo Status. Pode indicar erro ou falha de processamento. Entre em contato com o Suporte Cielo E-commerce.
7	Autorizado	Authorized	Cartão de crédito e débito	Transação autorizada pelo emissor do cartão. Deve ser capturada para que o dinheiro seja depositado em conta (por padrão, a transação pode ser capturada até 15 dias após autorização).
10	Aguardando biometria facial	AuthorizedIdPayPending	Cartão de crédito	Indica que a biometria facial está pendente. O comprador tem até uma hora para fazer a autenticação. Esse status será atualizado após a autenticação para 2 (pago) ou 3 (negado). Caso a autenticação não for feita, será alterado para 5 (cancelado).

Observação: Para consultas de pedido, o campo payment.status será retornado no formato texto, sempre em inglês (coluna Transaction Status).

Payment_antifrauderesult

O Antifraude possui o conceito de Status e SubStatus, onde o primeiro representa o nível de risco que uma transação possui de ser uma fraude, e o segundo, uma informação adicional sobre a transação.

VALOR	STATUS ANTIFRAUDE	SUBSTATUS	DESCRIÇÃO
1	Baixo Risco	Baixo Risco	Baixo risco de ser uma transação fraudulenta.
2	Alto Risco	Alto Risco	Alto risco de ser uma transação fraudulenta. São canceladas automaticamente.
4	Não finalizado	Não finalizado	Não foi possível finalizar a consulta.
N/A	N/A	Não aplicável	Transação de cartão de débito que foi autenticada pelo 3ds 2.0, por isso não é elegível a análise de antifraude.
N/A	N/A	N/A	Meio de pagamento não analisável como boleto, Pix, QR Code, e transação de cartão de crédito que foi negada pelo emissor.
N/A	N/A	Transação de recorrência	Para casos de recorrência, após a primeira transação paga, as próximas transações de uma recorrência não são analisadas pelo antifraude. Somente a primeira transação é analisada.

Payment_method_type

O Link de Pagamento permite apenas um tipo de Boleto por estabelecimento, sendo assim a notificação não retorna se o provedor usado foi Bradesco ou Banco do Brasil, pois apenas um deles estará ativo na afiliação.

VALOR	DESCRIÇÃO	DESCRIPTION
1	Cartão de Crédito	CreditCard
2	Boleto Bancário	Boleto
4	Cartão de Débito	DebitCard
5	QR Code Crédito	QrCode
6	Pix	Pix
7	QRCode Débito	QrCodeDebit

Observação: Para consultas o Type é retornado no campo Payment.Type e vem preenchida com o valor literal (Description).

Payment_method_brand

É a bandeira do cartão.

VALOR	DESCRIÇÃO
1	Visa
2	Master
3	AmericanExpress
4	Diners
5	Elo
6	Aura
7	JCB
8	Discover

Nas consultas a bandeira do cartão é retornada no campo Payment.Brand e vem preenchida com o valor literal.

Payment_method_bank

VALOR	DESCRIÇÃO
1	Banco do Brasil
2	Bradesco

Shipping_type

VALOR	DESCRIÇÃO
1	Correios
2	Frete fixo
3	Frete grátis
4	Retirar em mãos/loja
5	Sem cobrança de frete (serviços ou produtos digitais)

⚠️
Atenção
Serviço de frete Correios indisponível no momento. Caso uma requisição com essa opção de frete seja enviada, você receberá um retorno com erro 400 e a mensagem: "O serviço de frete por correios está indisponível." Caso utilize o serviço em seus links de pagamento ou páginas de checkout, altere o tipo de frete para as outras opções disponíveis.