Get the amortization schedule for a specific loan

GET /accounts/{account_id}/amortization_schedule

Path parameters

Query parameters

  • offset number

    The zero-indexed starting point for paginated line item requests sorted by line item effective date.

  • limit number

    The maximum number of line items to be returned. Defaults to 100.

Responses

  • • 200 array[object]

    Amortization schedule for a loan

    • line_item_id string Required

      The ID of this generated amortization schedule.

    • cycle_exclusive_end string(date-time) | null Required

      The date-time the am cycle ends.

    • min_pay_due_at string(date-time) | null Required

      The date the minimum payment for the am schedule is due.

    • am_min_pay_cents number Required

      The amount due just for the am schedule. This accounts for principal, interest, and deferred interest balance but does not include fees.

    • am_cycle_payment_cents number Required

      The amount in cents that was actually paid towards the loan during the billing cycle

    • am_interest_cents number Required

      The amount in cents allocated to interest from this am payment

    • am_deferred_cents number Required

      The amount in cents allocated to deferred interest from this am payment

      Default value is 0.

    • am_principal_cents number Required

      The amount in cents allocated to principal from this am payment

    • am_fees_cents number

      The amount in cents allocated to fees from this am payment

    • am_start_principal_balance_cents number

      The starting principal balance on the loan before this payment

    • am_end_principal_balance_cents number

      The ending principal balance on the loan after this payment

    • am_start_total_balance_cents number Required

      The starting balance on the loan before this payment

    • am_end_total_balance_cents number Required

      The ending balance on the loan after this payment

    • paid_on_time boolean

      Indicates whether the amount for this am payment was paid on time; only present if the date scheduled for the am payment has passed as of the time of the request.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 404

    Amortization Schedule not found

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

GET /accounts/{account_id}/amortization_schedule 
curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/amortization_schedule \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
[
  {
    "line_item_id": 400,
    "cycle_exclusive_end": "2018-07-20T09:10:14+00:00",
    "min_pay_due_at": "2018-07-20T09:10:14+00:00",
    "am_min_pay_cents": 84000,
    "am_cycle_payment_cents": 18325,
    "am_interest_cents": 10000,
    "am_deferred_cents": 4000,
    "am_principal_cents": 70000,
    "am_fees_cents": 1500,
    "am_start_principal_balance_cents": 136691,
    "am_end_principal_balance_cents": 136691,
    "am_start_total_balance_cents": 136691,
    "am_end_total_balance_cents": 136691,
    "paid_on_time": false
  }
]