v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Prepayment

Consultar posição do crédito por contrato

O objetivo dessa rota é exibir a posição do contrato.

get/prepayment/{contract_number}/balance

Path parameters

contract_numberstring required

Identificador do contrato

Example:6764459321/EP

Identificação do contrato

Query parameters

fund_tax_idstring required

CNPJ/CPF

Example:15996430000182

Identificação do fundo

position_datestring

Data de vencimento

Example:2023-09-14T00:00:00

Data da posição (default dia atual)

Response

Sucesso

amortization_typestring

Tipo de amortização

balance_datestring

Data da posição

contract_numberstring

Identificação do contrato da operação

currencystring

Moeda

is_vnpboolean

Indicador se o contrato está inadimplente

position_datestring

Data da posição

trade_idstring

Identificador do trade

Example response

[
  {
    "amortization_type": "InstallmentFlow",
    "balance_date": "2023-08-02T00:00:00.000Z",
    "contract_number": "1247244/HYD",
    "currency": "BRL",
    "installments": [
      {
        "amount_at_maturity": 136.1,
        "curve_value": 140.62,
        "installment_number": 1,
        "principal": 117.28,
        "status_description": "Opened"
      }
    ],
    "is_vnp": true,
    "position_date": "2023-08-02T00:00:00.000Z"
  }
]