Cancelar 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 invalidar um link de autorização que ainda não foi concluído. Depois do cancelamento, o cliente não consegue mais autorizar por esse link.

POSTv3/automatic_pix/links/:link_id/cancel

Importante

Cancelar o link não afeta uma autorização já aprovada. Para encerrar uma autorização ativa, use Revogar Autorização.

Request Variable Path

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

Response Object

Retorna o link com os mesmos campos de Consultar Link, com current_status igual a canceled.

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 cancelado

Request

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

Response200

{
  "link_id": "zXc6Vb1NmQ4wEr7TyU0i",
  "item_id": "MATRICULA_2026_00124",
  "current_status": "canceled",
  "authorization_url": "https://checkout.marlim.co/automatic-pix/zXc6Vb1NmQ4wEr7TyU0i",
  "authorization_id": null,
  "error": null,
  "metadata": {},
  "date_created": "2026-11-12T15:02:10.000Z",
  "date_updated": "2026-11-12T16:05:12.300Z",
  "expires_at": "2026-11-20T23:59:59.000Z"
}

Link já concluído

Request

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

Response400

{
  "errors": [
    {
      "type": "status",
      "message": "Only links with created or processing status can be canceled."
    }
  ]
}

Link não encontrado

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/links/AABBCCDD/cancel" \
-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"
    }
  ]
}