Consultar Link de 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.

Use esta rota para retornar os dados e o status atual de um link de autorização, como contingência aos webhooks ou para acompanhar a jornada do cliente.

GETv3/automatic_pix/links/:link_id

Request Variable Path

Atributo	Tipo	Descrição
link_id	string	ID Marlim do link de autorização.

Dica

Se precisar acompanhar a jornada sem webhook, consulte esta rota a cada 2 segundos enquanto o status for created ou processing, e pare assim que chegar a um status final.

Response Object

Propriedade	Tipo	Descrição
link_id	string	ID Marlim do link de autorização.
item_id	string	ID do link na sua plataforma.
current_status	string	Status atual do link. Valores possíveis: created, processing, completed, canceled, expired e error. Veja Status do Link.
authorization_url	string	URL da jornada de autorização.
authorization_id	string	ID Marlim da autorização gerada pelo link. Retorna null enquanto o cliente não concluir a jornada. Guarde este ID: é com ele que você consulta, revoga e agenda cobranças na autorização.
error	object	Preenchido quando o current_status é error. Retorna null nos demais casos.
error[code]	string	Código do erro. Veja Rejeições de Autorização.
error[title]	string	Título do erro.
error[detail]	string	Detalhe do erro, em texto livre.
metadata	object	Objeto livre enviado na criação do link.
date_created	dateTime	Data de criação do link no formato ISODateTime.
date_updated	dateTime	Data de atualização do link no formato ISODateTime.
expires_at	dateTime	Data de expiração do link no formato ISODateTime.

Importante

O status completed indica apenas que a jornada terminou. Para saber se o cliente aprovou, consulte a autorização pelo authorization_id.

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

Link encontrado

Request

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

Response200

{
  "link_id": "pXq3Lk9TzR2mWb7NcA1e",
  "item_id": "MATRICULA_2026_00123",
  "current_status": "completed",
  "authorization_url": "https://checkout.marlim.co/automatic-pix/pXq3Lk9TzR2mWb7NcA1e",
  "authorization_id": "aUt7Hq2LmZ9xVb3KcR8s",
  "error": null,
  "metadata": {
    "plano": "anual"
  },
  "date_created": "2026-11-12T14:19:18.051Z",
  "date_updated": "2026-11-12T14:22:40.112Z",
  "expires_at": "2026-11-20T23:59:59.000Z"
}

Link não encontrado

Request

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

Response404

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