Vaults

Get vault forward repayment schedule

Projected weekly repayment volume carried forward at each facility's trailing run-rate, bucketed on UTC-Monday calendar weeks — the same buckets the realized series uses. The first projected entry is the next Monday; entries remains realized-only for the in-progress week (paid rows only, never partial). The in-progress week is additionally carried by the top-level currentWeek object: realized receipts to date plus, per facility, a projected gap-to-pace remainder — a re-projection of numbers already public elsewhere in this response, not new information. There is no on-chain instalment schedule — every entry is an explicit projection (status: "projected"), not clamped to deadline (most borrowers roll over; deadline is a UI marker only). Only the single v2 vault is supported; other vaults 404.

get/v3/vaults/{id}/repayment-schedule

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/vaults/{id}/repayment-schedule
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)
    • none

Path parameters

idstring uuid required

Vault ID

Query parameters

fromstring date

Start date (YYYY-MM-DD). When in the past, realized repayments are merged in as status: "paid" entries.

tostring date

End date (YYYY-MM-DD), inclusive, for the realized-repayment merge.

granularity'week'
facilityIdstring

Restrict the schedule to a single facility (lineTokenId, a numeric id).

Response

Default Response

vaultIdstring uuid required
networkIdstring required

CAIP-2 network identifier

granularity'week' required
asOfstring required

Calendar date (YYYY-MM-DD) the projection was computed from

facilitiesWithoutProjectionstring[] required

lineTokenIds with no usable deadline or WALD, so no schedule could be built

Changes

No recorded changes to this operation across all 1 revision of this API.