Válido para a integração com o provider "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.
É possível remover um QR Code Pix já gerado caso ele não tenha sido pago. Caso o Pix tenha sido pago, veja como solicitar uma devolução Pix.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void |
| Produção | put | https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void |
Parâmetros do path
| Campo | Tipo | Descrição |
|---|---|---|
PaymentId | string | Número de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36. |
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 |
Resposta
{
"Status": 2,
"ReasonCode": 8,
"ReasonMessage": "Scheduled",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"ReturnCode": "0",
"ReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/b8c1b2ea-e06a-4135-9389-8bdbdccacd20"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/b8c1b2ea-e06a-4135-9389-8bdbdccacd20/void"
}
]
}
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na remoção de um QR Code Pix:
| Campo | Tipo | Descrição |
|---|---|---|
Status | number | Status da transação. |
ReasonCode | number | Código de retorno. |
ReasonMessage | number | Mensagem de retorno. |
ProviderReturnCode | number | Código de retorno do provedor. |
ProviderReturnMessage | string | Mensagem de retorno do provedor. |