← InicioFleetPay / API

Solicitar pago en lote por batch de contra-CT-e

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/carriers/parcelas-repasse/pagar-por-lote
pagarParcelasPorLoteContraCteBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Dispara el pago de las cuotas ya liberadas de todos los contra-CT-e vinculados al lote de subcontratación (batch_id).

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Subcontratación
Perfiles Aplicables
Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

Identificador del lote y posición de la cuota.

application/json

batch_idstringObligatorio

UUID o ID del lote de contra-CT-e.

posicaointegerObligatorio

Número de cuota por pagar.

Respuestas

200 Respuesta HTTP

Operación procesada con éxito.

application/json

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

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

422 Respuesta HTTP

Saldo insuficiente o cuotas no liberadas.

Definición Completa de la Operación
{
  "tags": [
    "CT-e de subcontratação",
    "Parcelas"
  ],
  "operationId": "pagarParcelasPorLoteContraCte",
  "summary": "Solicitar pagamento em lote por batch de contra-CT-e",
  "description": "Dispara o pagamento das parcelas já liberadas de todos os contra-CT-e vinculados ao lote de subcontratação (`batch_id`).",
  "requestBody": {
    "required": true,
    "description": "Identificador do lote e posição da parcela.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "batch_id",
            "posicao"
          ],
          "properties": {
            "batch_id": {
              "type": "string",
              "description": "UUID ou ID do lote de contra-CT-e."
            },
            "posicao": {
              "type": "integer",
              "description": "Número da parcela a pagar."
            }
          }
        }
      }
    }
  },
  "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": "Saldo insuficiente ou parcelas não liberadas."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "subcontratacao",
  "x-fleetpay-profiles": [
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/carriers/parcelas-repasse/pagar-por-lote",
  "parameters": []
}