Válido para a integração com o provedor "Cielo2".
Esta página descreve o método para criar um QR Code Pix na nova integração, com o provedor "Cielo2".
Saiba mais sobre essa funcionalidade na documentação.
Para gerar um QR code Pix através da API E-commerce Cielo, faça a integração conforme a especificação a seguir.
O campo obrigatório Payment.Type deve ser enviado como "Pix". A resposta da requisição irá retornar o código base64 da imagem do QR Code Pix, que a loja deverá disponibilizar ao comprador.
O tempo de expiração máximo do QR Code Pix pela Cielo é 24 horas. Esse tempo de expiração pode ser alterado no campo
Payment.QrCode.Expiration.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales |
| Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales |
{
"MerchantOrderId": "123456789asdf",
"Customer": {
"Name": "Aline de Souza",
"Identity": "066...",
"IdentityType": "CPF"
},
"Payment": {
"Type": "Pix",
"Provider": "Cielo2",
"Amount": 100,
"QrCode": {
"Expiration": 86400
}
}
}
Parâmetros do cabeçalho
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
MerchantId | Identificador da loja na API E-commerce Cielo. | GUID | 36 | Sim |
MerchantKey | Chave pública para autenticação dupla na API E-commerce Cielo. | string | 40 | Sim |
RequestId | Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT. | GUID | 36 | Não |
Parâmetros do corpo
| Campo | Tipo | Descrição |
|---|---|---|
MerchantOrderId | string | Número de identificação do pedido. Caracteres especiais não são permitidos. Tamanho: 25 |
Customer.Name | string | Nome do comprador. Tamanho: 255. |
Customer.Identity | string | Número do CPF ou CNPJ do comprador. Tamanho: 18. |
Payment.Type | string | Tipo do meio de pagamento. Neste caso, insira “Pix”. Tamanho: 15. |
Payment.Provider | string | Nome do provedor do meio de pagamento. Neste caso, “Cielo2”. |
Payment.Amount | number | Valor do pedido, em centavos. |
Payment.QrCode | object | Objeto contendo informações adicionais para o QR Code. |
Payment.QrCode.Expiration | number | Tempo de expiração do QR Code, em segundos. (Ex: 30 minutos = 1800). O envio é opcional. Caso não seja informado, o valor padrão será 86400 segundos (24 horas). |
Resposta
{
"MerchantOrderId": "********************************",
"Customer": {
"Name": "Aline de Souza",
"Identity": "066....",
"IdentityType": "CPF"
},
"Payment": {
"QrCode": {
"Expiration": 86400
},
"QrCodeBase64Image": "iVBg3[...]",
"QrCodeString": "00020[...]",
"SentOrderId": "********************************",
"Amount": 100,
"ReceivedDate": "2024-11-28 16:29:52",
"Provider": "Cielo2",
"Status": 12,
"IsSplitted": false,
"ReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"ReturnCode": "0",
"PaymentId": "********-****-****-****-************",
"Type": "Pix",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/********-****-****-****-************"
}
]
}
Parâmetros da resposta
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na geração de um QR code para pagamento em Pix:
| Campo | Tipo | Descrição |
|---|---|---|
Payment.QrCodeBase64Image | string | Base64 da imagem do QRCode gerado para pagamento do Pix. |
Payment.QrCodeString | string | Código do Pix (copia e cola) que pode ser usado para pagamento. |
Payment.SentOrderId | string | Identificador da transação Pix, representa o txid. |
Payment.ReturnCode | string | Código de retorno. |
Payment.ReturnMessage | string | Mensagem de retorno. |
Payment.PaymentId | string | Identificador da transação usado para consulta. |
Mudanças nos campos
Confira as mudanças nos campos retornados ao atualizar o provedor Cielo para Cielo2:
| Campos | Integração anterior | Integração nova (Cielo2) |
|---|---|---|
Payment.QrCode.Expiration | Não existia. Anteriormente o tempo padrão de expiração do QR Code Pix era de duas horas. | Representa o tempo de expiração do QR Code Pix em segundos e pode ser determinado pela loja. Caso não seja informado, o tempo de expiração padrão será de 24 horas. |
Tid | Representava o ID do QR Code. | Não existe mais. |
ProofOfSale | Representava o NSU do Pix. | Não existe mais. |
SentOrderId | Representava o Ecommerce Order Id | Passou a representar o txid. |
Os demais campos se mantém iguais.