[Cielo2] Solicitar devolução de transação Pix

Caso a sua loja precise devolver uma transferência Pix, é possível realizar uma operação chamada de devolução. Quando uma devolução é acatada, uma notificação será enviada para a sua loja.

  • É necessário que o comprador (usuário pagador) solicite para a loja (usuário recebedor) a devolução total ou parcial de um pagamento realizado, via algum meio de comunicação adequado;
  • A loja (usuário recebedor) concorda e identifica o pagamento original realizado pelo Pix.

Quando posso solicitar uma devolução Pix?

É possível solicitar uma devolução Pix quando, por exemplo, houver devolução do produto, erro na cobrança e indisponibilidade do produto em estoque.

Quem solicita a devolução Pix pelo Gateway de Pagamentos?

A loja (vendedor que recebeu a transação Pix) é quem solicita a devolução ao Gateway de Pagamentos, por conta própria ou por solicitação do usuário pagador. É importante se atentar aos prazos (de acordo com regulamento do Banco Central).

Como solicitar à devolução Pix?

Via API do Gateway de Pagamentos.

Regras para devolução Pix

  • A devolução ocorrerá somente se houver saldo na conta de pagamento do estabelecimento. Para ter saldo, é necessário escolher a Gestão de Livre Movimentação na conta Pix;
  • Os valores da taxa e/ou tarifa de criação da transação Pix não serão devolvidos;
  • Para transferências, vendas e demais transações com o Pix o prazo para cancelamento é em até 90 dias a partir da data que tiver sido realizada a transação original, conforme especificação do Banco Central;
  • A devolução de um Pix pode ser integral (valor total da transação) ou parcial (parte do valor da transação).

⚠️

Atenção

Os estabelecimentos que optarem pela transferência automática da conta Pix (Gestão Simplificada) não terão saldo em conta de pagamento. Com isso, não será possível efetuar a devolução com sucesso, e o retorno será “Lojista com saldo insuficiente para devolução”.

Requisição

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

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 devolução de um 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.