APIs
Sub-processorsAbout PismoContact us

Pix reversal

post
https://sandbox-cdn.pismolabs.io/pix/v1/pix/in/reversal

Reverse a Pix-out transfer.

This endpoint generates a Pix-out reversed event and a Pix reconciliation notification received event.

This endpoint also generates a Pix-in reversed 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request Body

integer
required

Pismo account ID.

number
required

Amount to be transferred.

string
required

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.

On reversal flow, the end_to_end_id is the original transaction end_to_end_id.

string
enum
required

Reversal reason.

Allowed:
string
length ≤ 105

Additional information

string
length ≤ 140

Reversal description

Headers
string
required

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

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

Responses

Updated 22 days ago

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

Updated 22 days ago