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.
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
Vault ID
Query parameters
Start date (YYYY-MM-DD). When in the past, realized repayments are merged in as status: "paid" entries.
End date (YYYY-MM-DD), inclusive, for the realized-repayment merge.
Restrict the schedule to a single facility (lineTokenId, a numeric id).
Response
Default Response
Changes
No recorded changes to this operation across all 1 revision of this API.