Skip to main content
GET
Consultar autorização
GET /pix-authorizations/:id Faz parte do recurso Pix Automático — a tabela de status e o que produz cada um estão lá. Devolve a autorização como ela está agora. O webhook é o caminho principal para saber que o pagador autorizou ou revogou; esta consulta serve para conferir o estado quando você perdeu um evento ou precisa decidir algo na hora — por exemplo, antes de criar a assinatura.
ID de outra conta responde 404. A autorização pertence à conta da chave que a abriu; fora dela, o endereço não existe.
O QR não volta nesta consulta. charge só vem na resposta da abertura. O primeiro pagamento continua consultável pela transação de charge.transactionId.

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

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.