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:

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

Resposta:

Campo	Descrição	Formato	Nullable
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	Horário de solicitação e liquidação da devolução	object	Sim
status	Apresenta o status da devolução, conforme a tabela Status Devolução	string	Não

Devolução - Solicitar

Consulta de devolução

Funcionalidade permite consultar uma devolução solicitada.

Solicitamos os campos:

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

Resposta:

Campo	Descrição	Formato	Nullable
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	Horário de solicitação e liquidação da devolução	object	Sim
status	Apresenta o status da devolução, conforme a tabela Status Devolução	string	Nã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:

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

Resposta:

Campo	Descrição	Formato	Nullable
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 associada ao recebimento	Array	Sim

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:

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

Resposta:

Campo	Descrição	Formato	Nullable
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.	array	Sim

Recebimento - Consultar