← InícioFleetPay / API

Liberar parcela em regra manual via serviço

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

POST/servicos/liberar-parcela
liberarParcelaServicoBase 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.

Libera parcela de bipagem (posição 1) ou conclusão (posição 2) quando a relação comercial utiliza regra de liberação manual. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Repasses e Comprovantes
Perfis Aplicáveis
Gestor de Transporte · Agregado Empresarial · 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

Identificação do documento, posição da parcela e data do evento.

application/json

documento_idinteger | nullOpcional
chave_acessostring | nullOpcional
posicaointegerObrigatório

Posição da parcela (1 ou 2).

data_eventostring · dateObrigatório

Data do evento operacional (YYYY-MM-DD).

Respostas

201 Resposta HTTP

Parcela liberada ou replay idempotente (200).

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

Regra automática ou ordem de liberação inválida.

Definição Completa da Operação
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "liberarParcelaServico",
  "summary": "Liberar parcela em regra manual via serviço",
  "description": "Libera parcela de bipagem (posição 1) ou conclusão (posição 2) quando a relação comercial utiliza regra de liberação manual. Exige escopo `operacao`.",
  "requestBody": {
    "required": true,
    "description": "Identificação do documento, posição da parcela e data do evento.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "posicao",
            "data_evento"
          ],
          "properties": {
            "documento_id": {
              "type": [
                "integer",
                "null"
              ]
            },
            "chave_acesso": {
              "type": [
                "string",
                "null"
              ]
            },
            "posicao": {
              "type": "integer",
              "description": "Posição da parcela (1 ou 2)."
            },
            "data_evento": {
              "type": "string",
              "format": "date",
              "description": "Data do evento operacional (YYYY-MM-DD)."
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Parcela liberada ou replay idempotente (`200`).",
      "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": "Regra automática ou ordem de liberação inválida."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/servicos/liberar-parcela",
  "parameters": []
}