← HomeFleetPay / API

Request payment in batch per counter-CT-e batch

Parameters, data structure and responses from the versioned contract.

POST/carriers/parcelas-repasse/pagar-por-lote
pagarParcelasPorLoteContraCteSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Triggers payment of already released installments across all counter-CT-es linked to the subcontracting batch (batch_id).

Authentication

Required Scope
operacao — Operations
Module
Subcontracting
Target Profiles
Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Request Body

Required

Batch identifier and installment position.

application/json

batch_idstringRequired

Counter-CT-e batch UUID or ID.

posicaointegerRequired

Installment number to pay.

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

422 HTTP Response

Insufficient balance or unreleased installments.

Complete Operation Definition
{
  "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": []
}