Consultar Autorização

Disponível apenas em Sandbox

Este endpoint está disponível somente no ambiente Sandbox. Não há suporte para Pix Automático em produção no momento.

A autorização é o consentimento recorrente aprovado pelo cliente no banco dele. Ela define quem recebe, a periodicidade e os limites de valor, e é necessária para agendar cobranças.

Use esta rota para retornar os dados e o status atual de uma autorização.

GETv3/automatic_pix/authorizations/:authorization_id

Request Variable Path

Atributo	Tipo	Descrição
authorization_id	string	ID Marlim da autorização, retornado na consulta do link e no webhook.

Response Object

Propriedade	Tipo	Descrição
authorization_id	string	ID Marlim da autorização.
link_id	string	ID Marlim do link que originou a autorização.
item_id	string	ID do link na sua plataforma.
current_status	string	Status atual da autorização. Valores possíveis: awaiting_authorization, partially_accepted, authorized, rejected, revoked, consumed, canceled e expired. Veja Status da Autorização.
contract_id	string	Contrato informado na criação do link.
interval	string	Periodicidade aprovada.
reference_start_date	date	Data de referência do primeiro ciclo, no formato YYYY-MM-DD.
fixed_amount	int32	Valor fixo aprovado, em centavos. Retorna null quando o valor é variável.
min_variable_amount	int32	Valor mínimo por cobrança, em centavos. Retorna null quando o valor é fixo.
max_variable_amount	int32	Valor máximo por cobrança, em centavos. Retorna null quando o valor é fixo.
is_retry_accepted	boolean	Indica se o cliente aceitou retentativas.
start_date_time	dateTime	Início da vigência no formato ISODateTime.
expiration_date_time	dateTime	Fim da vigência no formato ISODateTime. Retorna null quando o prazo é indeterminado.
customer	object	Objeto Pagador.
customer[name]	string	Nome do pagador.
customer[document_number]	string	CPF ou CNPJ do pagador.
contract_debtor	object	Objeto Devedor do contrato.
contract_debtor[name]	string	Nome do devedor do contrato.
contract_debtor[document_number]	string	CPF ou CNPJ do devedor do contrato.
creditors	array	Recebedor(es) exibidos ao cliente.
creditors[][name]	string	Nome do recebedor.
creditors[][document_number]	string	CNPJ ou CPF do recebedor.
participant	object	Objeto Banco do pagador.
participant[participant_id]	string	ID do banco do pagador.
participant[name]	string	Nome do banco do pagador.
rejection	object	Preenchido quando a autorização é rejeitada. Retorna null nos demais casos.
rejection[rejected_by]	string	Quem rejeitou. Valores possíveis: customer (o cliente recusou) e bank (o banco do cliente recusou).
rejection[code]	string	Código da rejeição. Veja Rejeições de Autorização.
rejection[detail]	string	Detalhe da rejeição, em texto livre.
revocation	object	Preenchido quando a autorização é revogada. Retorna null nos demais casos.
revocation[revoked_by]	string	Quem revogou. Valores possíveis: customer (o cliente revogou pelo app do banco), seller (você revogou pela rota de revogação) e bank (o banco do cliente revogou).
revocation[detail]	string	Detalhe da revogação, em texto livre.
metadata	object	Objeto livre enviado na criação do link.
date_authorized	dateTime	Data da aprovação pelo cliente no formato ISODateTime. Retorna null enquanto não houver aprovação.
date_created	dateTime	Data de criação da autorização no formato ISODateTime.
date_updated	dateTime	Data de atualização da autorização no formato ISODateTime.

Error Object

Atributo	Tipo	Descrição
errors	array	Array com todos os erros encontrados ao processar a requisição.
errors[][type]	string	Tipo de erro ocorrido.
errors[][message]	string	Mensagem detalhada do erro ocorrido.

Exemplos

Autorização aprovada

Request

curl -X GET "https://sandbox.api.marlim.co/v3/automatic_pix/authorizations/aUt7Hq2LmZ9xVb3KcR8s" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "authorization_id": "aUt7Hq2LmZ9xVb3KcR8s",
  "link_id": "pXq3Lk9TzR2mWb7NcA1e",
  "item_id": "MATRICULA_2026_00123",
  "current_status": "authorized",
  "contract_id": "CTR_2026_00123",
  "interval": "monthly",
  "reference_start_date": "2026-12-01",
  "fixed_amount": null,
  "min_variable_amount": 50000,
  "max_variable_amount": 80000,
  "is_retry_accepted": true,
  "start_date_time": "2026-11-12T14:22:38.000Z",
  "expiration_date_time": null,
  "customer": {
    "name": "Luke Skywalker",
    "document_number": "00099988877"
  },
  "contract_debtor": {
    "name": "Luke Skywalker",
    "document_number": "00099988877"
  },
  "creditors": [
    {
      "name": "Academia Jedi Ltda",
      "document_number": "11222333000181"
    }
  ],
  "participant": {
    "participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
    "name": "Banco da Aliança"
  },
  "rejection": null,
  "revocation": null,
  "metadata": {
    "plano": "anual"
  },
  "date_authorized": "2026-11-12T14:22:38.000Z",
  "date_created": "2026-11-12T14:20:05.000Z",
  "date_updated": "2026-11-12T14:22:40.112Z"
}

Autorização rejeitada

Request

curl -X GET "https://sandbox.api.marlim.co/v3/automatic_pix/authorizations/bNm4Jk7LpQ1wRt5YxC9v" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "authorization_id": "bNm4Jk7LpQ1wRt5YxC9v",
  "link_id": "zXc6Vb1NmQ4wEr7TyU0i",
  "item_id": "MATRICULA_2026_00124",
  "current_status": "rejected",
  "contract_id": "CTR_2026_00124",
  "interval": "monthly",
  "reference_start_date": "2026-12-01",
  "fixed_amount": 65000,
  "min_variable_amount": null,
  "max_variable_amount": null,
  "is_retry_accepted": true,
  "start_date_time": null,
  "expiration_date_time": null,
  "customer": {
    "name": "Han Solo",
    "document_number": "00022233344"
  },
  "contract_debtor": {
    "name": "Han Solo",
    "document_number": "00022233344"
  },
  "creditors": [
    {
      "name": "Academia Jedi Ltda",
      "document_number": "11222333000181"
    }
  ],
  "participant": {
    "participant_id": "c8f0bf49-4744-4933-8960-7add6e590841",
    "name": "Banco da Aliança"
  },
  "rejection": {
    "rejected_by": "customer",
    "code": "rejected_by_customer",
    "detail": "The customer refused the authorization in the bank app."
  },
  "revocation": null,
  "metadata": {},
  "date_authorized": null,
  "date_created": "2026-11-12T15:03:00.000Z",
  "date_updated": "2026-11-12T15:04:31.000Z"
}

Autorização não encontrada

Request

curl -X GET "https://sandbox.api.marlim.co/v3/automatic_pix/authorizations/AABBCCDD" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response404

{
  "errors": [
    {
      "type": "not_found",
      "message": "Authorization with id [AABBCCDD] was not found"
    }
  ]
}