[Cielo2] Remover um QR Code Pix

É 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

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Produçãohttps://api.braspag.com.br/v2/sales/

Parâmetros do path

CampoTipoDescriçãoObrigatório
PaymentIdstringNúmero de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36.Sim

Parâmetros do cabeçalho

PropriedadeDescriçãoTipoTamanhoObrigatório
MerchantIdIdentificador da loja no Gateway de Pagamentos.Text36Sim
MerchantKeyChave pública para autenticação dupla no Gateway de Pagamentos.Text40Sim
RequestIdIdentificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.Text36Não

Resposta

{
    "Status": 2,
    "ReasonCode": 8,
    "ReasonMessage": "Scheduled",
    "ProviderReturnCode": "0",
    "ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.braspag.com.br/v2/sales/34fc280a-8b98-44c9-bc8f-5911bbeef952/void"
        }
    ]
}

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pelo Gateway de Pagamentos na remoção de um QR Code Pix:

CampoTipoDescrição
StatusnumberStatus da transação.
ReasonCodenumberCódigo de retorno.
ReasonMessagenumberMensagem de retorno.
ProviderReturnCodenumberCódigo de retorno do provedor.
ProviderReturnMessagetextMensagem de retorno do provedor.