Revogar 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 encerrar uma autorização ativa por iniciativa sua (por exemplo, quando o contrato é encerrado). Após a revogação, nenhuma nova cobrança pode ser agendada nessa autorização.

POSTv3/automatic_pix/authorizations/:authorization_id/revoke

Atenção

O cliente também pode cancelar o Pix Automático diretamente no app do banco dele. Nesse caso você é avisado no seu webhook com o current_status igual a revoked. Não agende novas cobranças para autorizações revogadas.

Request Variable Path

Atributo	Tipo	Descrição
authorization_id	string	ID Marlim da autorização.

Response Object

Retorna a autorização com os mesmos campos de Consultar Autorização, com current_status igual a revoked e o objeto revocation preenchido.

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 revogada

Request

curl -X POST "https://sandbox.api.marlim.co/v3/automatic_pix/authorizations/aUt7Hq2LmZ9xVb3KcR8s/revoke" \
-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": "revoked",
  "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": {
    "revoked_by": "seller",
    "detail": "Revoked by the receiver."
  },
  "metadata": {
    "plano": "anual"
  },
  "date_authorized": "2026-11-12T14:22:38.000Z",
  "date_created": "2026-11-12T14:20:05.000Z",
  "date_updated": "2027-03-02T10:15:00.000Z"
}

Autorização não ativa

Request

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

Response400

{
  "errors": [
    {
      "type": "status",
      "message": "Only authorizations with authorized status can be revoked."
    }
  ]
}

Autorização não encontrada

Request

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