Notificação de finalização da transação

Notificação via POST

Contém todos os dados da transação, inclusive o merchant_order_number e o checkout_cielo_order_number, que poderão ser usados para a consulta de transações.

Exemplo:

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_method_brand: "2",  
payment_ maskedcreditcard: "550209******7201",  
payment_installments: "1",  
payment_antifraudresult: "1",  
payment_status: "1",  
tid: "28234896273NT8MFJBPE", 
test_transaction: "False",  
product_id: "0f48e580-d0a2-4e3b-a748-6704927f1725",  
product_type: "3",  
product_description: "123",  
nsu: "00339922" 
authorization_code: "913812" 
start_date: "29/04/2024 09:38:53" 
recurrent_status: "Ativa" 
interval: "Mensal" 
pagador_recurrent_payment_id: "9cfc236e-8600-4306-9c83-d409d1f86937"

Veja a descrição dos detalhes da transação na sessão Conteúdo das notificações.

Notificação via JSON

A notificação via JSON é um método mais seguro e flexível para realizar uma consulta no Link de Pagamento Cielo. Nessa modalidade a loja recebe o MerchantId e o MerchantOrderNumber e uma URL para realizar uma consulta (GET) junto à base de dados do Link de Pagamento Cielo e acessar os detalhes da transação.

Conteúdo da notificação 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"

PARÂMETRO	DESCRIÇÃO	TIPO DO CAMPO
`URL`	URL com os dados necessários para realizar a busca dos dados da transação.	string
`MerchantId`	Identificador da loja no Link de Pagamento; consta no site Cielo no menu Configuração > Dados Cadastrais.	alfanumérico (guid)
`MerchantOrderNumber`*	Número do pedido da 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.

*Em outras requisições e respostas pode se chamar OrderNumber.

O servidor da loja deve enviar o retorno HTTP Status = 200 (OK) para a API do Link de Pagamento, indicando que a notificação foi recebida e processada com sucesso.

Exemplo de uma consulta à URL retornada via JSON

Resposta

{ 
    "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", 
    "interval": "Monthly", 
    "recurrent_status": "Ativa", 
    "start_date": "20/02/2024", 
    "end_date": "04/10/2028", 
    "product_id": "adf8905e-68ef-4433-9692-9d63aa3d8f77", 
    "product_type": 5, 
    "nsu": "038002", 
    "authorization_code": "039186" 
}

Veja a descrição dos detalhes da venda na sessão Conteúdo das notificações.

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.	64 Para fins de conciliação, o tamanho máximo é de 20
`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

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 DA TRANSAÇÃO	TRANSACTION STATUS	MEIOS DE PAGAMENTO	DESCRIÇÃO
1	Pendente	Pending	Para todos os meios de pagamento	Indica que o pagamento ainda está sendo processado; OBS: Boleto - Indica que o boleto não teve o status alterado pelo lojista
2	Pago	Paid	Para todos os meios de pagamento	Transação capturada e o dinheiro será depositado em conta.
3	Negado	Denied	Somente para Cartão Crédito	Transação não autorizada pelo responsável do meio de pagamento
4	Expirado	Expired	Cartões de Crédito e Boleto	Transação deixa de ser válida para captura - 15 dias após a autorização
5	Cancelado	Voided	Para cartões de crédito	Transação foi cancelada pelo lojista
6	Não Finalizado	NotFinalized	Todos os meios de pagamento	Pagamento esperando Status - Pode indicar erro ou falha de processamento. Entre em contato com o Suporte Cielo
7	Autorizado	Authorized	Somente para Cartão de Crédito	Transação autorizada pelo emissor do cartão. Deve ser capturada para que o dinheiro seja depositado em conta
8	Chargeback	Chargeback	somente para Cartão de Crédito	Transação cancelada pelo consumidor junto ao emissor do cartão. O Dinheiro não será depositado em conta.

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
9	HiperCard

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)

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.