É a notificação enviada para a URL de Notificação e pode ser no formato POST ou JSON.
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.