Canopy API - Latest

Get effective interest rate for an account during the given time period

GET /accounts/{account_id}/interest_rates

Path parameters

account_id string Required

ID of the Account

Query parameters

effective_at_inclusive_start string(date-time) Required

Inclusive start time for this interest rate value
effective_at_exclusive_end string(date-time) Required

Exclusive end time for this interest rate value

Responses

• 200 array[object] | null

An array of interest rates and their effective time periods
- account_id string Required
  
  The account associated with the line item
- line_item_id string | null
  
  The line item associated with this effective interest rate
- effective_at_inclusive_start string Required
  
  The Date-Time start of the window for this effective interest rate
- effective_at_exclusive_end string Required
  
  The Date-Time end of the window for this effective interest rate. The keyword 'infinity' may be used as a date later than all other dates.
- interest_rate number
  
  The interest rate percent effective during this window
- interest_rate_id number
  
  The id of the interest rate record
- tags object | null
  
  Additional information pertaining to this interest rate record
  scra boolean
  
  Denotes if an interest rate is designated as a part of the Servicemembers Civil Relief Act
- Additional properties are allowed
• 401

Unauthorized.
• 403

Forbidden.
• 404

Account not found
• 429

Too many requests.
• default

Unexpected Error.

GET /accounts/{account_id}/interest_rates

curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/interest_rates?effective_at_inclusive_start=2020-01-01T00%3A00%3A00%2B00&effective_at_exclusive_end=2020-01-01T00%3A00%3A00%2B00 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (200)

[
  {
    "account_id": 4,
    "line_item_id": "can_26",
    "effective_at_inclusive_start": "2018-07-20T09:12:30+00:00",
    "effective_at_exclusive_end": "2018-07-20T09:12:30+00:00",
    "interest_rate": "1.23",
    "interest_rate_id": "10",
    "tags": {
      "scra": "true"
    }
  }
]