DiscordStatus
Guias / Guides

Automatic Pix authorization cancellation reasons

See the cancellationReason values returned when an Automatic Pix authorization is canceled.

See the reasons returned when an Automatic Pix authorization is canceled.

When the PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED event is received, use authorization.cancellationReason to identify the cause of the cancellation and authorization.cancellationDate to identify the date it occurred.

When to use

See this page when:

  • an authorization has CANCELLED status;
  • the PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED event is received;
  • your application needs to identify the reason for the cancellation;
  • you need to differentiate a cancellation from the end of the authorization's validity period.

How to identify the cancellation reason

In the PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED event, check:

  • authorization.cancellationReason: reason for the cancellation;
  • authorization.cancellationDate: date the authorization was canceled.

To see the full event payload, go to Events for Automatic Pix.

If you need to confirm the current state of the authorization, use Retrieve a single authorization.

Cancellation reasons

ReasonDescription
CONFIRMATION_ERRORFailure to confirm the authorization.
REQUESTED_BY_RECEIVER_USERCancellation requested by the payee.
REQUESTED_BY_PAYER_USERCancellation requested by the payer.
OTHERUnspecified reason.
REQUESTED_BY_COURT_ORDERCancellation resulting from a court order.
📘

Authorization that was never activated

If the authorization was never activated, there is no cancellation and no cancellationReason. For example, when the initial payment is received, but the payer's institution does not send the authorization confirmation.

In this case, the event sent is PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED. See what to do in the Automatic Pix FAQ.

📘

Cancellation and expiration are different situations

The EXPIRED status indicates that the authorization reached the end of the validity period defined in finishDate. In this scenario, the PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED event occurs and there is no cancellationReason.

Cancellation, on the other hand, is reported by the PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED event, with the reason in authorization.cancellationReason.

How to handle the cancellation

When you receive the cancellation event:

  1. identify the authorization by authorization.id;
  2. record authorization.cancellationReason and authorization.cancellationDate;
  3. update the authorization state in your application to CANCELLED;
  4. do not create new recurring charges using this authorization;
  5. track the other related events, as already scheduled payment instructions may also be canceled.

To understand the sequence of events after the cancellation, see Automatic Pix Webhook Flows.

⚠️

Attention

Preserve the original value of authorization.cancellationReason received from the API. If you present the reason to the end user, map it to a message appropriate to your application's context.

API reference

📘

Important

To check the current state and data of the authorization, go to Retrieve a single authorization.

To cancel an active authorization through the API, go to Cancel an authorization.

See also

If you need to interpret the refusal of a payment instruction, rather than the cancellation of the authorization, see Refusal Reasons.

Next steps

Updated 2 days ago

Did this page help you?