← HomeFleetPay / API

Query payout installment payment details

Parameters, data structure and responses from the versioned contract.

GET/carriers/parcelas-repasse/{documento}/pagamento
consultarPagamentoRepasseSandbox Base: https://api.fleetpay.site/v1

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

Returns the consolidated financial breakdown and bank payout receipts linked to the specified document.

Authentication

Required Scope
operacao — Operations
Module
Disbursements & Receipts
Target Profiles
Transport Manager · Dedicated Fleet Contractor · 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

documentopath · stringRequired

Document ID, internal_id or fiscal access key.

Constraints
{
  "type": "string"
}

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.

404 HTTP Response

Document not found.

Complete Operation Definition
{
  "tags": [
    "Parcelas"
  ],
  "operationId": "consultarPagamentoRepasse",
  "summary": "Consultar detalhes de pagamento das parcelas de repasse",
  "description": "Retorna o consolidado financeiro e comprovantes bancários de repasse vinculados ao documento informado.",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "description": "ID, internal_id ou chave fiscal do documento.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "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 não encontrado."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "repasses-comprovantes",
  "x-fleetpay-profiles": [
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "GET",
  "path": "/carriers/parcelas-repasse/{documento}/pagamento"
}