The refund flow is very similar to a regular payment, with the difference being that the latter occurs at the very beginning. The end customer, based on a PIX received, requests that their institution send a refund.

A PIX received may be refunded within 90 days of the date of receipt, at the initiative of the receiving customer.

Several refund transactions related to the same receipt may be carried out, as long as the sum of these returns is less than or equal to the initial payment received.

Refund Request

In this feature, you can send a refund.

The following fields are required:

Field	Description	Format	Mandatory
endToEndId	Identifier of the payment that originated the refund	string	Sim
idExterno	Transaction identifier provided by the indirect participant when requesting the refund	string	Sim
valor	Full or partial refund amount	double	Sim
motivo	Message to recipient	string	Não
código	Code for refund reason that will be sent in PACS004, as shown in the table Reasons for refund	string	Sim
prioridadeTransacao	Type of transaction priority, as shown in the table Type of Priority	string	Sim

Response:

Field	Description	Format	Nullable
solicitadoEmUtc	Date and time the refund was requested by the recipient	date-time	Não
returnId	Refund transaction identifier	string	Sim
endToEndId	Identifier of the payment that originated the refund	string	Sim
idExterno	Transaction identifier provided by the indirect participant when requesting the refund	string	Sim

Solicitar uma devolução

Viewing refunds

This feature allow users to view a specific return list or transaction.

List of refunds

In this functionality we allow you to obtain a list of refunds associated with a received payment.

The following fields are required:

Field	Description	Format	Mandatory
endToEndId	Identifier of the transaction that originated the refund	string	Sim
status	Refund status, if you want to retrieve a specific status. As per table Status of refund	string	Não

Resposta:

Field	Description	Format	Nullable
idExterno	idExterno Transaction identifier provided by the indirect participant when requesting the refund	string	Sim
endToEndId	Identifier of the receipt that originated the refund	string	Sim
returnId	Refund transaction identifier	string	Sim
valor	Transaction amount	double	Não
status	Status of refund, as shown in the table Status of refund	string	Não
motivo	Message to recipient	string	Sim
tipo	Type of refund, as shown in the table Type of refund	string	Não
codigo	Refund reason code that will be sent in PACS004, as shown in the table Reasons for refund	string	Não
prioridadeTransacao	Type of transaction priority, as shown in the table Type of Priority	string	Não
erroDescricao	Description of the refund error	string	Sim
motivoRejeicao	Code and description of the reason the refund that was informed by BACEN in PACS002 was denied	object	Sim

Listar devoluções

View a specific refund

This functionality allows you to view a specific refund.

The following fields are required:

Field	Description	Format	Mandatory
endToEndId	Identifier of the payment that originated the refund	string	Sim
returnId	Pix refund transaction identifier	string	Sim

Resposta:

Field	Description	Format	Nullable
idExterno	Transaction identifier provided by the indirect participant when requesting the refund	string	Sim
endToEndId	Identifier of the payment that originated the refund	string	Sim
returnId	Refund transaction identifier	string	Sim
valor	Transaction amount	double	Não
status	Status of refund, as shown in the table Status of refund	string	Não
motivo	Message to recipient	string	Sim
tipo	Type of refund, as shown in the table Type of refund	string	Não
codigo	Refund reason code that will be sent in PACS004, as shown in the table Reasons for refund	string	Não
prioridadeTransacao	Type of transaction priority, as shown in the table Type of Priority	string	Não
erroDescricao	Description of refund error	string	Sim
motivoRejeicao	Code and description of the reason the refund that was informed by BACEN in PACS002 was denied	object	Sim

Obter devolução

Notification of refunds

At this stage, indirect participants are notified of the completion of the refund process, with a registered notification.

Please go to Webhooks for indirect participants for orientation on how to register notifications.