Motivos de cancelamento da autorização do Pix Automático

Consulte os valores de cancellationReason retornados quando uma autorização do Pix Automático é cancelada.

Consulte os motivos retornados quando uma autorização do Pix Automático é cancelada.

Quando o evento PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED for recebido, utilize authorization.cancellationReason para identificar a causa do cancelamento e authorization.cancellationDate para identificar a data em que ele ocorreu.

Quando utilizar

Consulte esta página quando:

uma autorização estiver com status CANCELLED;
o evento PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED for recebido;
sua aplicação precisar identificar o motivo do cancelamento;
for necessário diferenciar um cancelamento do encerramento da vigência da autorização.

Como identificar o motivo do cancelamento

No evento PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED, consulte:

authorization.cancellationReason: motivo do cancelamento;
authorization.cancellationDate: data em que a autorização foi cancelada.

Para consultar o payload completo do evento, acesse Eventos para Pix Automático.

Caso precise confirmar o estado atual da autorização, utilize Recuperar uma única autorização.

Motivos de cancelamento

Motivo	Descrição
`CONFIRMATION_ERROR`	Falha na confirmação da autorização.
`REQUESTED_BY_RECEIVER_USER`	Cancelamento solicitado pelo recebedor.
`REQUESTED_BY_PAYER_USER`	Cancelamento solicitado pelo pagador.
`OTHER`	Motivo não especificado.
`REQUESTED_BY_COURT_ORDER`	Cancelamento decorrente de ordem judicial.

📘
Autorização que não chegou a ser ativada
Se a autorização não chegou a ser ativada, não há cancelamento nem cancellationReason. Por exemplo, quando o pagamento inicial é recebido, mas a instituição do pagador não envia a confirmação da autorização.
Nesse caso, o evento enviado é PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED. Consulte o que fazer na FAQ do Pix Automático.

📘
Cancelamento e expiração são situações diferentes
O status EXPIRED indica que a autorização chegou ao fim da vigência definida em finishDate. Nesse cenário, ocorre o evento PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED e não há cancellationReason.
O cancelamento, por outro lado, é informado pelo evento PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED, com o motivo em authorization.cancellationReason.

Como tratar o cancelamento

Ao receber o evento de cancelamento:

identifique a autorização por authorization.id;
registre authorization.cancellationReason e authorization.cancellationDate;
atualize o estado da autorização na sua aplicação para CANCELLED;
não crie novas cobranças recorrentes utilizando essa autorização;
acompanhe os demais eventos relacionados, pois instruções de pagamento já agendadas também podem ser canceladas.

Para entender a sequência dos eventos após o cancelamento, consulte Fluxos de Webhook do Pix Automático.

⚠️
Atenção
Preserve o valor original de authorization.cancellationReason recebido pela API. Caso apresente o motivo ao usuário final, faça o mapeamento para uma mensagem adequada ao contexto da sua aplicação.

Referência da API

📘
Importante
Para consultar o estado atual e os dados da autorização, acesse Recuperar uma única autorização.
Para cancelar uma autorização ativa pela API, acesse Cancelar uma autorização.

Veja também

Se você precisa interpretar a recusa de uma instrução de pagamento, e não o cancelamento da autorização, consulte Motivos de Recusa.

Próximos passos

Updated about 12 hours ago

Did this page help you?