Repayment Schedule

The repayment schedule endpoint generates a detailed breakdown of loan repayments for a specific confirmed offer. This helps customers understand exactly what they'll pay and when, building confidence and transparency before they commit.

Why repayment schedules matter to your customers

Showing customers a clear repayment schedule upfront helps them plan their cash flow, compare different loan amounts, and make informed decisions. Transparency around repayments improves conversion rates and reduces questions later in the process.

How it works

1. 1
   Retrieve a confirmed offer

   First, retrieve the customer's offers using GET /offers/. You'll need the offer_id of a confirmed offer – repayment schedules are only generated for confirmed offers.

2. 2
   Request the repayment schedule

   Use the offer_id to generate a repayment schedule:

   GET /offers/{offer_id}/repayment_schedule/

3. 3
   Customise with parameters (optional)

   You can optionally include query parameters:

   • amount=[number] – Sets a simulated draw down amount (minimum 100, maximum is the offer max amount).
   • pay_off_early_on=[date] – Simulates early repayment; specify the last payment date in the format YYYY-MM-DD.

   Requests can include none, either, or both parameters.