get
https://api-sandbox.asaas.com/v3/pix/automatic/authorizations
Endpoint utilizado para consultar as autorizações de Pix Automático cadastradas na conta.
Essa chamada retorna uma lista de autorizações existentes, permitindo acompanhar o estado atual das recorrências criadas no sistema.
Parâmetros de consulta
offset- Define a posição inicial da listagem. A posição inicial é sempre 0limit- Define a quantidade de registros retornados por requisição. O limite máximo é 100status- Permite filtrar as autorizações pelo status atual.
Valores possíveis:
| Status | Descrição |
|---|---|
CREATED | A autorização foi criada, mas ainda não foi ativada. Normalmente significa que o QR Code foi gerado, mas o pagamento inicial ainda não foi realizado. |
ACTIVE | A autorização está ativa. O pagamento inicial foi realizado e o pagador concedeu autorização para cobranças recorrentes. |
REFUSED | A autorização foi recusada. Pode ocorrer quando o QR Code expira sem pagamento ou quando o pagador não conclui o processo de autorização. |
CANCELLED | A autorização foi cancelada manualmente. |
EXPIRED | A autorização atingiu o fim do período de vigência definido em finishDate. |
- **
customerId**- Permite listar apenas as autorizações vinculadas a um cliente específico.
Casos de uso
Esse endpoint é útil para:
- monitoramento das autorizações criadas
- geração de relatórios
- validações antes da criação de novas cobranças recorrentes
- acompanhamento do ciclo de vida das autorizações de Pix Automático
Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.