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.

Solicitando uma 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:

Campo	Descrição	Formato
e2eid	Identificador único do recebimento original	string
idExterno	Identificador da transação gerado pelo cliente para fins de conciliação	string
valor	Valor que será devolvido	number

Resposta:

Campo	Descrição	Formato	Nullablle
id	Identificador da transação gerado pelo cliente para fins de conciliação	string	Sim
rtrId	Identificador da transação de devolução	string	Sim
valor	Valor da devolução	number	Não
horario	Apresenta: o horário de solicitação e liquidação da devolução (date-time)	object	Sim
status	Apresenta o status da devolução, conforme a tabela [Status Devolução]	string	Não

Status devolução

O status da devolução apresenta os seguintes motivos:

Campo	Descrição
EM_PROCESSAMENTO	O pedido de devolução esta em fase de processamento
DEVOLVIDO	Devolução realizada com sucesso
NAO_REALIZADO	Devolução não foi realizada com sucesso

Devolução - Solicitar

Consultando uma devolução

Funcionalidade permite consultar uma devolução solicitada.

Solicitamos os campos:

Campo	Descrição	Obrigatório
e2eid	Identificador único do recebimento original	Sim
idExterno	Identificador da transação gerado pelo cliente para fins de conciliação	Sim

Resposta:

Campo	Descrição	Formato	Nullablle
id	Identificador da transação gerado pelo cliente para fins de conciliação	string	Sim
rtrId	Identificador da transação de devolução	string	Sim
valor	Valor da devolução	number	Não
horario	Apresenta: o horário de solicitação e liquidação da devolução (date-time)	object	Sim
status	Apresenta o status da devolução, conforme a tabela [Status Devolução]	string	Não

Devolução - Consultar

Recebimento - Consultar por e2eid

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

Solicitamos os campos:

Campo	Descrição	Obrigatório
e2eid	Identificador único do recebimento original	Sim

Resposta:

Campo	Descrição	Formato	Nullablle
endToEndId	Identificador único do recebimento original	string	Sim
txid	Identificador da transação	string	Sim
valor	Valor da transação PIX	number	Sim
horario	Apresenta o horário de processamento da transação PIX	date-time	Não
pagador	Apresenta o CPF/CNPJ e nome do pagador	object	Sim
infoPagador	Apresenta informações do pagador	string	Sim
devolucoes	Apresenta informações de devolução, se houve alguma associado ao recebimento	Array	Sim

Recebimento - Consultar por e2eid

Recebimento - Consultar

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

Solicitamos os campos:

Campo	Descrição	Obrigatório
Inicio	Data inicial para consulta	Sim
Fim	Data final para consulta	Sim
TxId	Identificador da transação	Não
CPF	CPF do pagador (não deve ser utilizado ao mesmo tempo que o campo CNPJ)	Não
CNPJ	CNPJ do pagador (não deve ser utilizado ao mesmo tempo que o campo CPF)	Não

Resposta:

Campo	Descrição	Formato	Nullablle
pix	Resposta 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, se tiver.	array	Sim

Recebimento - Consultar