Reverse Pix Webhook notification

Notification

When any change in the transaction’s status occurs, we will make a POST request to notify them of the change.

{
  "order": "1e7ce9c5-75b1-40c2-949a-bb221aafe70d",
  "status": "PAID",
  "reference": "your-internal-reference",
  "type": "REVERSE_PIX"
}

{
  "order": "1e7ce9c5-75b1-40c2-949a-bb221aafe70d",
  "status": "REJECTED",
  "reference": "your-internal-reference",
  "type": "REVERSE_PIX",
  "rejection_reason": "pix.timeout"  
}

{
  "order": "1e7ce9c5-75b1-40c2-949a-bb221aafe70d",
  "status": "EXPIRED",
  "reference": "your-internal-reference",
  "type": "REVERSE_PIX"
}

order: Our internal reference to the transaction.
status: The current order's status.
reference: Your reference informed in transaction creation.
rejection_reason: Details related to order's rejection, when the status is REJECTED.

Possible status

Status	Description	Final status (Irreversible)	Has Webhook?
INITIALIZED	When the transaction is first registered, it receives the status INITIALIZED, but no webhook is sent at this stage.	No	No
REFUSED	The transaction will have a “Refused” status if any issue occurs with the transfer after its confirmation. In such cases, a webhook notification will be sent.	Yes	Yes
PAID	The transaction was successfully paid and processed, and the webhook is triggered.	Yes	Yes
EXPIRED	The transaction will expire when its deadline is reached. In this case, a webhook will be sent.	Yes	Yes
PROCESSING	After the confirmation request, the transaction enters this temporary status before moving to a final one. No webhook is triggered in this case..	No	No

Rejection scenarios

Some error scenarios need to be considered when handling the webhook. Below is a breakdown of possible error cases.

Reason	"error" field	Detail
Rejected transfer by receiver's bank	"rejected.by.receiver.bank"	In rare cases, the receiver’s bank may reject the transaction.
Pix Timeout	"pix.timeout"	In rare cases, a Pix transfer may reach its timeout limit.
Internal error	"server.error"