← HomeFleetPay / API

Get transfer installments for a document

Parameters, data structure and responses from the versioned contract.

GET/carriers/parcelas-repasse/{documento}

consultarParcelasRepasseSandbox Base: https://api.fleetpay.site/v1

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

The complete transfer ledger for this document: how much the driver receives, in how many installments, each installment's state, and which have generated a payment.

Use this to determine what to do next — status tells you whether an installment is waiting for an event, waiting for your payment order, or already moving toward payment.

A document belonging to another carrier returns 404, not 403: a 403 would confirm that the document exists in FleetPay.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

documentopath · stringRequired

FleetPay internal ID, document number (internal_id), or the 44-digit CT-e key. The key accepts dotted formatting.

For counter-CT-e documents, also accepts counter_cte_id (the UUID returned by the subcontracting batch), the leg's documento_financeiro (ROUTE:<lote>:<hex>), and, after authorization, the counter-CT-e's own key. In 1:1 mode, the document is the contracting company's CT-e imported as your own — its key resolves the document.

Constraints

{
  "type": "string"
}

Responses

200 HTTP Response

The document's installments

`application/json`

RespostaParcelasRepasse ↗

dataobjectOptional

ParcelaRepasse ↗

401 HTTP Response

Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.

`application/json`

Erro ↗

errorobjectOptional

403 HTTP Response

The credential does not have the operacao scope enabled. The ledger exposes how much each driver receives and when; enable the scope in the dashboard before querying.

`application/json`

Erro ↗

errorobjectOptional

404 HTTP Response

Document not found or belongs to another carrier.

`application/json`

Erro ↗

errorobjectOptional

422 HTTP Response

The document exists and belongs to you, but it is not governed by an installment transfer rule — there is no ledger to display (regra_nao_parcelada). The release and payment-order endpoints return sem_regra_parcelada for the same state.

`application/json`

Erro ↗

errorobjectOptional

429 HTTP Response

Request limit exceeded (limite_requisicoes). Wait for the interval specified in the Retry-After header before retrying. This may be a limit forwarded from the provider or FleetPay's own anti-abuse limit, counted per authenticated company and route group, with a short window for bursts and a long window for slower automated traffic. Limits are intentionally generous: genuine integrations, including large batches processed at once, should remain well below them. If yours reaches a limit, contact FleetPay.

`application/json`

Erro ↗

errorobjectOptional

500 HTTP Response

Internal error (erro_interno)

`application/json`

Erro ↗

errorobjectOptional

Complete Operation Definition

{
  "tags": [
    "Parcelas"
  ],
  "summary": "Consultar as parcelas de repasse de um documento",
  "operationId": "consultarParcelasRepasse",
  "description": "O livro completo do repasse deste documento: quanto o motorista recebe, em quantas\nparcelas, em que estado cada uma está e qual já virou pagamento.\n\nÉ por aqui que você descobre **o que fazer em seguida** — o campo `status` diz se a parcela\nespera evento, espera a sua ordem de pagamento, ou já está a caminho.\n\nDocumento de outra transportadora responde `404`, não `403`: um `403` confirmaria que\naquele documento existe na FleetPay.\n",
  "parameters": [
    {
      "name": "documento",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "O ID interno FleetPay, o número do documento (`internal_id`) ou a chave do CT-e de 44\ndígitos. A chave aceita a máscara com pontos.\n\nPara **contra-CT-e** vale também o `counter_cte_id` (o UUID devolvido pelo lote de\nsubcontratação), o `documento_financeiro` da perna (`ROUTE:<lote>:<hex>`) e, depois\nde autorizado, a chave do próprio contra-CT-e. No 1:1 o documento é o CT-e da\ncontratante importado como seu — a chave dele resolve.\n"
    }
  ],
  "responses": {
    "200": {
      "description": "As parcelas do documento",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaParcelasRepasse"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "description": "Credencial sem o escopo `operacao` habilitado. O livro expõe quanto cada motorista recebe e quando — habilite o escopo no painel antes de consultar.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "404": {
      "description": "Documento não encontrado, ou de outra transportadora.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "O documento existe e é seu, mas não está sob uma regra de repasse parcelada — não há\nlivro para mostrar (`regra_nao_parcelada`). Nos endpoints de liberação e ordem o mesmo\nestado responde `sem_regra_parcelada`.\n",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "429": {
      "$ref": "#/components/responses/Erro429"
    },
    "500": {
      "$ref": "#/components/responses/Erro500"
    }
  },
  "method": "GET",
  "path": "/carriers/parcelas-repasse/{documento}"
}