Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Pix

Pix reversal

Reverse a Pix-out transfer.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/pix-pix-out-reversal-1">Pix-out reversed</a> event and a <a href="https://developers.pismo.io/events/docs/pix-financial-reconciliation-1">Pix reconciliation notification received</a> event.

This endpoint also generates a <a href="https://developers.pismo.io/events/docs/pix-pix-in-reversal-1">Pix-in reversed</a> event when the funds are transferred from the payee's account, which can be a Pismo account or an external account.

For all events, the status or result field indicates operation success or failure.

For more information, see the Pix instant payments guide.

post/pix/v1/pix/in/reversal

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Request body

account_idinteger required

Account ID

amountnumber double required

Fee amount.

end_to_end_idstring required

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. <br /> Basically, there are two steps to a Pix transaction:<br />

  1. Initialize a transaction <br />
  2. Confirm a transaction<br />

The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.<br />

On reversal flow, the end_to_end_id is the original transaction end_to_end_id.<br />

reason'USER_REQUESTED' | 'FRAUD' | 'BANK_ERROR' required

Reversal reason.

additional_informationstring

Additional information

descriptionstring

Reversal description

Example request

{
  "account_id": 6912345,
  "amount": 215,
  "end_to_end_id": "E3030629420200808195101608910248",
  "reason": "USER_REQUESTED"
}

Response

Response Body

end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

reversal_end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction:

  1. Initialize a transaction
  2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

Here, the reversal_end_to_end_id is generated automatically and begins with a "D".

reversal_status'SETTLED' | 'PROCESSING' | 'ERROR'

Reversal status

Example response

{
  "end_to_end_id": "E3030629420200808195101608910248",
  "reversal_status": "SETTLED"
}