← InícioFleetPay / API

Revogar credencial AT&M de Seguro Obrigatório de Carga (RCTR-C / RC-DC)

Parâmetros, estrutura de dados e respostas do contrato versionado.

POST/seguro-carga/credenciais-atm/{id}/revogar
revogarCredencialAtmSeguroCargaBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Revoga imediatamente uma credencial AT&M vinculada ao Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023).

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Seguro Obrigatório de Carga (RCTR-C / RC-DC)
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · Embarcador · Transportador Frotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

idpath · integerObrigatório

ID numérico da credencial AT&M.

Restrições
{
  "type": "integer"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

404 Resposta HTTP

Credencial não encontrada.

Definição Completa da Operação
{
  "tags": [
    "Seguro de Carga"
  ],
  "operationId": "revogarCredencialAtmSeguroCarga",
  "summary": "Revogar credencial AT&M de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
  "description": "Revoga imediatamente uma credencial AT&M vinculada ao Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023).",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "ID numérico da credencial AT&M.",
      "schema": {
        "type": "integer"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    },
    "404": {
      "description": "Credencial não encontrada."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "seguro-carga",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "embarcador",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/seguro-carga/credenciais-atm/{id}/revogar"
}