Create Pix reversals
POST {{baseInfraUrl}}/{{version}}/pix-reversal
Send back a received Pix. Direction: Outbound.
| Parameters | Value Type | Description |
|---|---|---|
| amount | REQUIRED | A positive integer that represents the amount in cents to be reversed from the Pix. Example: amount=100 (R$1.00). |
| externalId | REQUIRED | Url safe string that must be unique among all your Pix Reversals. Example: externalId=my-internal-id-12345678. |
| endToEndId | REQUIRED | Central Bank's unique transaction id of the Pix to be reversed. Example: endToEndId=E24152649202201172211u34srod19le. |
| reason | REQUIRED | Reason why the Pix is being reversed. Options: bankError, fraud, cashierErrorand customerRequest |
| tags | OPTIONAL | List of strings to tag the entity for future queries. All tags will be converted to lowercase. Example: tags=[iron, armor] |
Request Body
{"reversals"=>[{"amount"=>10000, "endToEndId"=>"E20018183202201201450u34sDGd19lz", "externalId"=>"my_unique_id", "reason"=>"fraud", "tags"=>["lannister", "chargeback"]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Pix reversal successfully created","reversals":[{"amount":10000,"created":"2022-05-17T21:17:32.137392+00:00","endToEndId":"E00000000202205101842qKEsJyvmE9n","externalId":"my_unique_id","fee":0,"flow":"out","id":"6265829213601792","reason":"fraud","returnId":"D34052649202205172117ziFN5c16GYj","status":"created","tags":["lannister","chargeback"],"updated":"2022-05-17T21:17:32.137400+00:00"}]}