Create an interest rate record for an account during the given time period

POST /accounts/{account_id}/interest_rates

Path parameters

Body Required

Body of request to create 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

  • 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

Responses

  • • 200 object

    Interest rate effective for an account over a given time range

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 404

    Account not found

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

POST /accounts/{account_id}/interest_rates 
curl \
 -X POST https://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/interest_rates \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"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","tags":{"scra":"true"}}'
Request example 
{
  "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",
  "tags": {
    "scra": "true"
  }
}
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"
  }
}