post
https://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Cria uma transação de QR Code
| 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/ |
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ó
PaymentFacilitatorpor 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.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
IsQrCode | Booleano indicando se é QR Code. | booleano | - |
QrCodeId | Identificador do QR Code. | string | - |
QrCodeString | Código do pix (Copia e cola) que pode ser usado para pagamento. | string | - |
QrCodeBase64Image | QRCode 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> | string | variável |
PaymentId | Número de identificação do pagamento, necessário para futuras operações como consulta, captura e cancelamento. | GUID | 36 |
Status | Status 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 transacional | byte | *** |
ReturnCode | Código de retorno. | string | 32 |
ReturnMessage | Mensagem de retorno. | string | 512 |