policy_modelstringOpcional"provider_own" · "fleetpay_managed"Parámetros, estructura de datos y respuestas del contrato versionado.
/seguro-carga/apolicesLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Registra o actualiza póliza de Seguro Obligatorio de Carga (RCTR-C y RC-DC — Ley 14.599/2023; no se trata de seguro de crédito) con vínculo opcional a la credencial AT&M.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]No hay parámetros declarados para esta operación.
Obligatorio
Datos de la póliza de Seguro Obligatorio de Carga (RCTR-C / RC-DC).
application/jsonpolicy_modelstringOpcional"provider_own" · "fleetpay_managed"policy_typestringOpcionalRamo de la póliza (ej.: rctrc, rcdc).
policy_numberstringObligatorioinsurer_namestringObligatorioinsurer_cnpjstringObligatorioCNPJ de la aseguradora con 14 dígitos.
atm_credential_idinteger | nullOpcional200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
422 Respuesta HTTPDatos obligatorios de la póliza inválidos.
{
"tags": [
"Seguro de Carga"
],
"operationId": "cadastrarAtualizarApoliceSeguroCarga",
"summary": "Cadastrar ou atualizar apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC)",
"description": "Registra ou atualiza apólice de Seguro Obrigatório de Carga (RCTR-C e RC-DC — Lei 14.599/2023; não se trata de seguro de crédito) com vínculo opcional à credencial AT&M.",
"requestBody": {
"required": true,
"description": "Dados da apólice de Seguro Obrigatório de Carga (RCTR-C / RC-DC).",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"policy_number",
"insurer_name",
"insurer_cnpj"
],
"properties": {
"policy_model": {
"type": "string",
"enum": [
"provider_own",
"fleetpay_managed"
]
},
"policy_type": {
"type": "string",
"description": "Ramo da apólice (ex: rctrc, rcdc)."
},
"policy_number": {
"type": "string"
},
"insurer_name": {
"type": "string"
},
"insurer_cnpj": {
"type": "string",
"description": "CNPJ da seguradora com 14 dígitos."
},
"atm_credential_id": {
"type": [
"integer",
"null"
]
}
}
}
}
}
},
"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."
},
"422": {
"description": "Dados obrigatórios da apólice inválidos."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "seguro-carga",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"embarcador",
"transportador_frotista"
],
"method": "POST",
"path": "/seguro-carga/apolices",
"parameters": []
}