Devolução

No contexto do Pix, o usuário que recebe um pagamento via Pix, pode devolver por própria vontade o valor total ou parcial da transação, desde que não tenha excedido o prazo de 90 dias a partir da data da transação original.

Sendo assim, disponibilizamos as funcionalidades abaixo que permitem aos nossos clientes efetuar este tipo de transação.

Solicitação de devolução

Esta operação permite solicitar a devolução de um valor recebido. A devolução pode ser parcial ou total. Podem ser criadas quantas devoluções forem necessárias até que o valor total devolvido seja equivalente ao valor total recebido.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
e2eidIdentificador único do recebimento originalstringSim
idExternoIdentificador da transação gerado pelo cliente para fins de conciliaçãostringSim
valorValor que será devolvidonumber Sim

Resposta:

CampoDescriçãoFormatoNullable
idIdentificador da transação gerado pelo cliente para fins de conciliaçãostringSim
rtrIdIdentificador da transação de devoluçãostringSim
valorValor da devoluçãonumber Não
horarioHorário de solicitação e liquidação da devoluçãoobjectSim
statusApresenta o status da devolução, conforme a tabela Status DevoluçãostringNão

Devolução - Solicitar

Consulta de devolução

Funcionalidade permite consultar uma devolução solicitada.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
e2eidIdentificador único do recebimento originalstringSim
idExternoIdentificador da transação gerado pelo cliente para fins de conciliaçãostringSim

Resposta:

CampoDescriçãoFormatoNullable
idIdentificador da transação gerado pelo cliente para fins de conciliaçãostringSim
rtrIdIdentificador da transação de devoluçãostringSim
valorValor da devoluçãonumber Não
horarioHorário de solicitação e liquidação da devoluçãoobjectSim
statusApresenta o status da devolução, conforme a tabela Status DevoluçãostringNão

Devolução - Consultar

Consulta a devolução por EndToEnd

Nessa funcionalidade, possibilitamos a consulta a um recebimento pelo EndToEnd, que contém uma seção com informações de devoluções vinculadas ao recebimento, caso houver.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
e2eidIdentificador único do recebimento originalstringSim

Resposta:

CampoDescriçãoFormatoNullable
endToEndIdIdentificador único do recebimento originalstringSim
txidIdentificador da transaçãostringSim
valorValor da transação Pixnumber Sim
horarioApresenta o horário de processamento da transação Pixdate-timeNão
pagadorApresenta o CPF/CNPJ e nome do pagadorobjectSim
infoPagadorApresenta informações do pagadorstringSim
devolucoesApresenta informações de devolução, se houve alguma associada ao recebimentoArraySim

Recebimento - Consultar por e2eid

Consulta a devolução por parâmetros

Nessa funcionalidade, possibilitamos a consulta a um recebimento por meio de vários filtros, que contém uma seção com informações de devoluções vinculadas ao recebimento, caso houver.

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
InicioData inicial para consultadate-timeSim
FimData final para consultadate-timstringeSim
TxIdIdentificador da transaçãostringNão
CPFCPF do pagador (não deve ser utilizado ao mesmo tempo que o campo CNPJ)stringNão
CNPJCNPJ do pagador (não deve ser utilizado ao mesmo tempo que o campo CPF)stringNão

Resposta:

CampoDescriçãoFormatoNullable
pixResposta com os dados da transação Pix (EndToEnd, txId, valor, dados do pagador, dados do recebedor, dados da conta do pagador e recebedor, situação, chave Pix e dados de devolução vinculadas ao recebimento.arraySim

Recebimento - Consultar