← InícioFleetPay / API

Consultar pagamento de parcela específica por posição

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

GET/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamento
consultarPagamentoParcelaEspecificaBase 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.

Retorna o status de liquidação bancária e evidências de pagamento de uma parcela específica (posicao) do documento.

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

documentopath · stringObrigatório

ID, internal_id ou chave fiscal do documento.

Restrições
{
  "type": "string"
}
posicaopath · integerObrigatório

Número ordinal da parcela.

Restrições
{
  "type": "integer"
}

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.

404 Resposta HTTP

Documento ou parcela não encontrada.

Definição Completa da Operação
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "consultarPagamentoParcelaEspecifica",
  "summary": "Consultar pagamento de parcela específica por posição",
  "description": "Retorna o status de liquidação bancária e evidências de pagamento de uma parcela específica (`posicao`) do documento.",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "description": "ID, internal_id ou chave fiscal do documento.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "posicao",
      "in": "path",
      "required": true,
      "description": "Número ordinal da parcela.",
      "schema": {
        "type": "integer"
      }
    }
  ],
  "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."
    },
    "404": {
      "description": "Documento ou parcela não encontrada."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamento"
}