documentopath · stringObrigatórioID, internal_id ou chave fiscal do documento.
Restrições
{
"type": "string"
}Parâmetros, estrutura de dados e respostas do contrato versionado.
/carriers/parcelas-repasse/{documento}/parcelas/{posicao}/pagamentoDescriçõ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.
operacao — Operação[
{
"oauth2": []
},
{
"chaveApi": []
}
]documentopath · stringObrigatórioID, internal_id ou chave fiscal do documento.
{
"type": "string"
}posicaopath · integerObrigatórioNúmero ordinal da parcela.
{
"type": "integer"
}200 Resposta HTTPOperação processada com sucesso.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTPCredencial ausente, inválida ou de outro ambiente.
403 Resposta HTTPEscopo do painel não habilitado ou recurso fora do escopo da company.
404 Resposta HTTPDocumento ou parcela não encontrada.
{
"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"
}