Request for Refund

Path Params
string
required

EndToEndIdentification that flows through PACS.002, PACS.004, and PACS.008

string
required

ID generated by the client to uniquely represent a refund

Body Params
string
required

Requested amount for return. The sum of all return amounts cannot exceed the total value of the Pix payment.

string
enum
Defaults to ORIGINAL

Indicates the nature of the return request. A return request by the recipient user can be related to a standard Pix (with code: MD06 in PACS.004), or to a Pix Withdrawal or Change Pix (with possible codes: MD06 and SL02 in PACS.004). In the absence of this field, the nature should be interpreted as a standard Pix (ORIGINAL).

Allowed:
string

The description field, optional, specifies a text to be presented to the payer with information about the return. This text will be filled in the PACS.004 by the recipient's PSP in the RemittanceInformation field. The field size in the PACS.004 is limited to 140 characters.

Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json