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 pela API E-commerce Cielo?
A loja (vendedor que recebeu a transação Pix) é quem solicita a devolução à API E-commerce Cielo, 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 E-commerce Cielo, App Cielo Gestão ou site Cielo.
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
Ambiente | Método | Endpoint |
---|---|---|
Sandbox | put | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={Amount} |
Produção | put | https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={Amount} |
Parâmetros no 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 na query string
Campo | Tipo | Descrição |
---|---|---|
Amount | string | Valor do pedido de devolução. Opcional. Para devolução total, não é necessário informar o valor ( Amount ).Para devolução parcial, informe o valor desejado para devolução em ( Amount ), que deve ser inferior ao valor total da transação. |
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",
"AuthorizationCode": "E01027058202412021928yOpJfcc9zLl",
"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 devolução de um 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. |
AuthorizationCode | string | Corresponde ao EndToEndId da transação Pix. |
Mudanças nos campos
Confira as mudanças nos campos retornados no estorno ao atualizar o provedor Cielo para Cielo2:
Campos | Antes | Depois |
---|---|---|
Tid | Representava o ID do QR Code. | Não existe mais. |
ProofOfSale | Representava o NSU do Pix. | Não existe mais. |
AuthorizationCode | Não existia. | Representa o EndToEndId da transação Pix. |