Voltar
Fortbix
Documentação da API

Garantias

Endpoints para consulta dos cálculos de LTV (Loan-to-Value) das garantias.

Cada recálculo de LTV gera um snapshot com o retrato da garantia naquele momento: saldo devedor, colateral bruto e líquido (após haircut), limites de alerta e liquidação e o status resultante.

Status possíveis

StatusSignificado
OKGarantia saudável — LTV abaixo do limite de alerta
ALERTLTV atingiu o limite de alerta ou colateral líquido abaixo do mínimo requerido
RELEASE_LIQUIDATIONLTV atingiu o limite de liquidação

Retorna os últimos snapshots de LTV de um contrato.

Query Parameters

ParamTipoObrigatórioDefaultDescrição
contractIdint > 0simID do contrato
limitint (1–100)não10Quantidade de snapshots mais recentes
RESPONSES
200Snapshots de LTV
{
  "contractId": 123,
  "count": 2,
  "snapshots": [
    {
      "contractId": "123",
      "timestamp": "2026-05-13T18:00:00.000Z",
      "trigger": "SCHEDULED_RECALC",
      "outstandingBalance": 95000,
      "grossCollateral": 150000,
      "liquidCollateral": 142500,
      "minimumGuaranteeRequired": 142500,
      "currentLtv": 0.6667,
      "collateralCoverageRatio": 1.5,
      "alertLtv": 0.75,
      "releaseLiquidationLtv": 0.85,
      "appliedHaircut": 0.05,
      "status": "OK",
      "reason": null
    },
    {
      "contractId": "123",
      "timestamp": "2026-05-13T17:00:00.000Z",
      "trigger": "SCHEDULED_RECALC",
      "outstandingBalance": 95000,
      "grossCollateral": 145000,
      "liquidCollateral": 137750,
      "minimumGuaranteeRequired": 142500,
      "currentLtv": 0.6897,
      "collateralCoverageRatio": 1.45,
      "alertLtv": 0.75,
      "releaseLiquidationLtv": 0.85,
      "appliedHaircut": 0.05,
      "status": "OK",
      "reason": null
    }
  ]
}
400contractId ausente ou inválido
401Não autenticado

Notas

  • contractsWithoutSnapshot conta contratos ativos que ainda não tiveram cálculo de LTV (por exemplo, garantia ainda sem depósito).
  • Mudanças de status da garantia também são publicadas como webhooks (collateral.ltv_alert, collateral.liquidated — ver Guia de Webhooks).