Gerar um QR Code via API

Cria uma transação de QR Code

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Produçãohttps://api.cieloecommerce.cielo.com.br/1/sales/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

Uma transação de QR Code é semelhante a uma transação de cartão de crédito, mas é necessário enviar o parâmetro Payment.Type como "qrcode".

⚠️

Atenção

  • Não é possível realizar uma transação com valor (Amount) = 0;
  • Facilitadores de Pagamento (ou subcredenciadores) devem, obrigatoriamente, enviar os parâmetros do nó PaymentFacilitator por exigência do Banco Central e das bandeiras. Caso não sejam enviados, a bandeira pode aplicar penalidades ao facilitador de pagamento.

Resposta da criação da transação de QR Code

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com QR Code.

PropriedadeDescriçãoTipoTamanho
QrCodeBase64ImageQRCode codificado na base 64. Por exemplo, a imagem poderá ser apresentada na página utilizando o código HTML como este:
<pre lang="html"><img src="data:image/png;base64, código_da_imagem_na_base_64"></pre>
stringvariável
PaymentIdNúmero de identificação do pagamento, necessário para futuras operações como consulta, captura e cancelamento.GUID36
StatusStatus da Transação. No caso de uma transação de geração de QRCode de pagamento, o status inicial é 12 (Pending). Veja a tabela completa de Status transacionalbyte***
ReturnCodeCódigo de retorno.string32
ReturnMessageMensagem de retorno.string512
Language
Click Try It! to start a request and see the response here!