Return

In the context of Pix, the user who receives a payment via Pix can return the full or partial amount of the transaction at will, as long as it has not exceeded 90 days from the date of the original transaction.

Therefore, we provide the functionalities below that allow our clients to carry out this type of transaction.transação.

Request a return

This operation allows requesting the return of an amount received. The return can be partial or total. As many returns as necessary can be created until the total amount returned is equivalent to the total amount received.

We request the fields:

Field	Description	Format	Mandatory
e2eid	Unique identifier of the original receipt	string	Yes
idExterno	Client-generated transaction identifier for reconciliation purposes	string	Yes
valor	Amount that will be returned	number	Yes

Response:

Field	Description	Format	Nullablle
id	Client-generated transaction identifier for reconciliation purposes	string	Yes
rtrId	Return transaction identifier	string	Yes
valor	Return amount	number	No
horario	Return request and settlement times	object	Yes
status	Displays the status of the return, see table [Return Status]	string	No

Devolução - Solicitar

Checking a return

This functionality allows checking a requested return.

We request the fields:

Mandatory	Description	Format	Mandatory
e2eid	Unique identifier of the original receipt	string	Yes
string	Client-generated transaction identifier for reconciliation purposes	string	Yes

Response:

Field	Description	Format	Nullablle
id	Client-generated transaction identifier for reconciliation purposes	string	Yes
rtrId	Return transaction identifier	string	Yes
valor	Return amount	number	No
horario	Return request and settlement times	object	Yes
status	Displays the status of the return, see table [Return Status]	string	No

Devolução - Consultar

Receipt - Check by e2eid

This functionality allows checking a receipt using EndToEnd, which contains a section with information on returns linked to the receipt, if any.

We request the field:

Field	Description	Format	Mandatory
e2eid	Unique identifier of the original receipt	string	Yes

Response:

Field	Description	Format	Nullablle
endToEndId	Unique identifier of the original receipt	string	Yes
txid	Transaction identifier	string	Yes
valor	Pix transaction amount	number	Yes
horario	Displays the Pix transaction processing time	date-time	No
pagador	Displays the CPF/CNPJ and the name of the payer	object	Yes
infoPagador	Displays payer information	string	Yes
devolucoes	Displays return information, if there was any associated with the receipt	Array	Yes

Recebimento - Consultar por e2eid

Receipt - Check

This functionality allows checking a receipt through several filters, which contains a section with returns information linked to the receipt, if any.

We request the fields:

Field	Description	Format	Mandatory
Inicio	Check start date	date-time	Yes
Fim	Check end date	date-time	Yes
TxId	Transaction identifier	string	No
CPF	Payer's CPF (should not be used at the same time as the CNPJ field)	string	No
CNPJ	Payer's CNPJ (should not be used at the same time as the CPF field)	string	No

Response:

Field	Description	Format	Nullablle
pix	Response with Pix transaction data (EndToEnd, txId, amount, payer data, receiver data, payer and receiver account data, status, Pix key and return data linked to receipt, if any.	array	Yes

Recebimento - Consultar

Return status

The return status has the following reasons:

Field	Description
EM_PROCESSAMENTO	The return request is being processed
DEVOLVIDO	Return successfully completed
NAO_REALIZADO	Return was not successful