documentopath · stringRequiredDocument ID, internal_id or fiscal access key.
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamentoTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Returns bank settlement status and payment evidence for a specific installment (posicao) of the document.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]documentopath · stringRequiredDocument ID, internal_id or fiscal access key.
{
"type": "string"
}posicaopath · integerRequiredInstallment ordinal number.
{
"type": "integer"
}200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
404 HTTP ResponseDocument or installment not found.
{
"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"
}