← InícioFleetPay / API

Solicitar pagamento em lote por batch de contra-CT-e

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

POST/carriers/parcelas-repasse/pagar-por-lote
pagarParcelasPorLoteContraCteBase 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.

Dispara o pagamento das parcelas já liberadas de todos os contra-CT-e vinculados ao lote de subcontratação (batch_id).

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Subcontratação
Perfis Aplicáveis
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

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

Identificador do lote e posição da parcela.

application/json

batch_idstringObrigatório

UUID ou ID do lote de contra-CT-e.

posicaointegerObrigatório

Número da parcela a pagar.

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.

422 Resposta HTTP

Saldo insuficiente ou parcelas não liberadas.

Definição Completa da Operação
{
  "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": []
}