Request for Refund

put https://api.pix.pagstar.com/pix/{e2eid}/devolucao/{id}

Endpoint to request a return using the Pix E2EID and the return ID. The reason to be assigned to the PACS.004 will be either "MD06" or "SL02" as specified in the RTReason tab of the PACS.004 message, according to the Pix Message Catalogue, depending on the nature of the return (see description of this field).

Path Params

e2eid

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

valor

string

required

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

natureza

string

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).

descricao

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

201201

400400

403403

404404

503503