Notificação enviada quando ocorre mudança no status da transação
É enviada para a URL de mudança de status e contém o checkout_cielo_order_number, o novo status e alguns dados da transação.
Para saber mais detalhes da transação, faça uma consulta usando o checkout_cielo_order_number.
Notificação via POST
O formato da notificação de mudança de status é POST (form data).
Exemplo:
checkout_cielo_order_number: "b918afea483d4c6c8615d8a8e19803c1",
amount: "134",
order_number: "024f77ac98cb493b86d8c818eb6e79cd",
payment_status: "3",
test_transaction: "False",
brand: "Visa",
nsu: "000001",
authorization_code: "01234567"
| 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. |
payment_method_brand | Bandeira- somente para transações com meio de pagamento cartão de crédito. Lista Completa | Número | 20 |
payment_status | Status da transação. Lista Completa | Número | 1 |
test_transaction | Indica se a transação foi gerada com o Modo de teste ativado | Boolean | 32 |
nsu | NSU - Número sequencial único da transação. | Alfanumérico | 6 |
authorization_code | Código de autorização. | Alfanumérico | 8 |
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 Cielo e acessar os detalhes da transação.
Conteúdo da notificação via JSON:
MerchantId=c89fdfbb-dbe2-4e77-806a-6d75cd397dac&
MerchantOrderNumber=12345&
Url=https://cieloecommerce.cielo.com.br/api/public/v1/orders/c89fdfbb-dbe2-4e77-806a-6d75cd397dac/12345
| 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
{
"$id": "1",
"order_number": "12345",
"amount": 1000,
"checkout_cielo_order_number": "8245e94dcf4c4de3906118e38f376822",
"created_date": "05/02/2024 15:05:44",
"customer_name": "leo menezes",
"customer_phone": "11234123411",
"customer_identity": "12345678909",
"customer_identity_type": 0,
"customer_email": "[email protected]",
"shipping_type": 1,
"shipping_price": 0,
"payment_method_type": 1,
"payment_method_brand": 2,
"payment_maskedcreditcard": "521199******4859",
"payment_installments": 1,
"payment_status": 4,
"tid": "0205030548978",
"recurrent_payment_id": "0207ce76-8144-48dc-8b17-876465bc3a6d",
"interval": "Anual",
"recurrent_status": "Ativa",
"start_date": "05/02/2024",
"end_date": "30/03/2026",
"test_transaction": "False",
"product_id": "1a4a8abe-bb73-4661-b4e9-b2c7adae0328",
"product_type": 5,
"nsu": "622269",
"authorization_code": "362902"
}
Veja a descrição dos detalhes da venda na sessão Conteúdo das notificações.