Cancelar uma autorização

Endpoint responsável por encerrar uma autorização de Pix Automático ativa.

A requisição utiliza o identificador da autorização (id) no endpoint:

DELETE /v3/pix/automatic/authorizations/{id}

Quando uma autorização é cancelada:

  • novas instruções de pagamento não podem mais ser criadas
  • instruções de pagamento já agendadas podem ser canceladas automaticamente
  • a recorrência deixa de existir para aquele cliente

Quando utilizar este endpoint

Esse endpoint deve ser utilizado quando for necessário interromper o ciclo de cobranças automáticas, por exemplo:

  • cancelamento de um serviço
  • encerramento de contrato
  • solicitação do cliente pagador
  • alteração das condições da recorrência

Status após o cancelamento

Após o cancelamento, o status da autorização passa para:

CANCELLED

Caso seja necessário continuar cobrando o cliente, será preciso criar uma nova autorização de Pix Automático.

Path Params
string
required
Responses

404

Not found

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