Recuperar uma única autorização

Endpoint utilizado para consultar os detalhes de uma autorização específica de Pix Automático.

A consulta é feita utilizando o identificador da autorização (id) no endpoint:

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

A resposta retorna todas as informações relacionadas à autorização.


Informações retornadas

Entre os dados retornados na resposta estão:

  • customerId - Identificador do cliente vinculado à autorização.
  • frequency - Define a frequência das cobranças recorrentes associadas à autorização.
  • startDate - Data de início da vigência da autorização.
  • finishDate - Data de término da autorização, caso tenha sido definida.
  • value - Valor fixo configurado para as cobranças recorrentes.
  • status - Status atual da autorização.

Casos de uso

Esse endpoint é utilizado principalmente para:

  • verificar se a autorização está no status ACTIVE antes de criar cobranças recorrentes
  • acompanhar alterações de status da autorização
  • validar os parâmetros da recorrência configurada
Path Params
string
required

Identificador único da autorização de Pix Automático no Asaas

Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

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