Skip to main content
DELETE
Encerrar autorização
DELETE /pix-authorizations/:id Faz parte do recurso Pix Automático — quem mais pode encerrar uma autorização, e como você fica sabendo, está lá. Encerra a autorização primeiro no banco do pagador e depois do nosso lado, e ela passa a canceled. Nenhuma fatura seguinte vai a débito: a assinatura continua, e as renovações passam a ser enviadas ao pagador por e-mail, com o link para pagar por Pix. Você também recebe o webhook pix_authorization.canceled.
Se o banco do pagador recusar o encerramento, a resposta é 409 e nada muda. A autorização continua active e as faturas continuam indo a débito. Tente de novo.
Encerrar o que já está encerrado devolve 200. Uma autorização canceled ou expired volta com o estado dela, sem nova chamada ao banco — repetir a requisição é seguro.
Cancelar a assinatura, a assinatura cumprir todos os ciclos (maxCycles) ou trocar a forma de pagamento dela também encerra a autorização. Nesses casos você não precisa chamar esta rota.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID da autorização (pxa_)

Response

Autorização encerrada

id
string

ID da autorização (pxa_).

customerId
string | null

Cliente pagador (cust_). Na resposta da abertura vem nulo quando o pagador foi enviado em customer: o vínculo é preenchido logo depois, e o GET já o traz.

subscriptionId
string | null

Assinatura que usa esta autorização como forma de pagamento. Nulo até a assinatura ser criada — e para sempre numa autorização que nunca virou assinatura.

status
enum<string>

Situação da autorização: pending, active, canceled ou expired. canceled e expired são finais.

Available options:
pending,
active,
canceled,
expired
frequency
enum<string>

Periodicidade que o pagador autorizou: weekly, monthly, quarterly, semiannual ou annual. Precisa ser a mesma da assinatura.

Available options:
weekly,
monthly,
quarterly,
semiannual,
annual
recurrenceBeginningDay
string

Primeiro dia em que o débito pode acontecer (YYYY-MM-DD), no calendário da sua conta. Na abertura pela API é o dia seguinte — o primeiro pagamento sai na hora, pelo QR.

endDay
string | null

Último dia de validade (YYYY-MM-DD), resolvido a partir do endDate enviado. Nulo quando a autorização vale até ser encerrada.

createdAt
string

Criação, ISO 8601.

updatedAt
string

Última alteração, ISO 8601.