Cria transação com o meio de pagamento Pix.
Saiba mais sobre essa funcionalidade na documentaçã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/ |
CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.
O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.
Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.
AtençãoA Cielo permite contratar mais de uma modalidade de Pix (como Pix Cielo, Pix Banco do Brasil ou Pix Bradesco). No entanto, apenas uma modalidade pode ficar ativa por vez para todo o CNPJ.CNPJ.
A habilitação e a alteração da modalidade de Pix são feitas no site da Cielo. Para mais informações, consulte Com habilitar o Pix.
Resposta da criação do QR Code Pix
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um QR Code Pix.
| PROPRIEDADE | DESCRIÇÃO | TIPO | TAMANHO |
|---|---|---|---|
Payment.PaymentId | Campo identificador do pedido. | GUID | 40 |
Payment.AcquirerTransactionId | Identificador da transação na Cielo. | GUID | 36 |
Payment.ProofOfSale | NSU Pix. | string | 20 |
Payment.QrcodeBase64Image | Código em base64 da imagem do QR code. | string | - |
Payment.QrCodeString | Texto codificado para o comprador "copiar" e "colar" no campo do internet banking em pagamentos feitos no ambiente mobile. A disponibilização deste código é de responsabilidade da loja. Recomendamos a exibição de um botão que, ao clicar, o comprador copie o código. | string | Variável |
Payment.Status | Status da transação. Em caso de sucesso, o status inicial é “12” (Pendente). Veja a tabela completa de Status transacional | integer | - |
Payment.ReturnCode | Código retornado pelo provedor do meio de pagamento. | string | 32 |
Payment.ReturnMessage | Mensagem retornada pelo provedor do meio de pagamento. | string | 512 |