Canopy Calculations API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Calculations API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Calculations
  description: Perform financial calculations for credit products in Canopy.
paths:
  /core/v1/calculations/apr:
    post:
      tags:
      - Calculations
      summary: Calculate APR and APY for a loan
      description: Calculates the Annual Percentage Rate (APR) for a loan based on provided parameters.
      operationId: LoanCalculationsCBV_calculate_apr_core_v1_calculations_apr_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateAprInput'
              description: APR calculation parameters
        required: true
      responses:
        '200':
          description: Returns the calculated APR and APY as percentages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateAprResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '422':
          description: Your request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrValidationErrorSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
  /core/v1/calculations/nominal_interest_rate:
    post:
      tags:
      - Calculations
      summary: Calculate Nominal Interest Rate for a loan
      description: Calculates the nominal interest rate for a loan based on provided parameters.
      operationId: LoanCalculationsCBV_calculate_nominal_interest_rate_core_v1_calculations_nominal_interest_rate_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateNominalInterestRateInput'
              description: Nominal interest rate calculation parameters
        required: true
      responses:
        '200':
          description: Returns the calculated nominal interest rate as a percentage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateNominalInterestRateResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '422':
          description: Your request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrValidationErrorSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
      security:
      - HTTPBearer: []
components:
  schemas:
    CalculateNominalInterestRateResponse:
      properties:
        nominal_interest_rate:
          type: number
          title: Nominal Interest Rate
          description: The calculated nominal interest rate as a percentage
          examples:
          - 5.75
      type: object
      required:
      - nominal_interest_rate
      title: CalculateNominalInterestRateResponse
      description: "Response schema for nominal interest rate calculation.\n\nAttributes:\n    nominal_interest_rate: The calculated nominal interest rate as a percentage"
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    ErrValidationErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request failed validation.
      type: object
      required:
      - message
      title: ErrValidationErrorSchema
    CalculateAprResponse:
      properties:
        apr_percentage:
          type: number
          title: Apr Percentage
          description: The calculated Annual Percentage Rate as a percentage
          examples:
          - 5.75
      type: object
      required:
      - apr_percentage
      title: CalculateAprResponse
      description: "Response schema for APR calculation.\n\nAttributes:\n    apr_percentage: The calculated Annual Percentage Rate as a percentage"
    CalculateNominalInterestRateInput:
      properties:
        product_id:
          type: string
          title: Product Id
          description: The external product id of the loan product. This is used to identify the product in the system.
          hidden: false
        loan_amount:
          type: integer
          title: Loan Amount
          description: The loan principal amount in cents
          examples:
          - 10000
          hidden: false
        term_length:
          type: integer
          title: Term Length
          description: Number of periods in loan term
          examples:
          - 12
          hidden: false
        total_repayment_amount:
          type: integer
          title: Total Repayment Amount
          description: The total amount to be repaid over the life of the loan in cents
          examples:
          - 10500
          hidden: false
        period_interval:
          type: string
          enum:
          - monthly
          - biweekly
          - weekly
          - daily
          - annually
          title: Period Interval
          description: The interval at which payments are made (e.g., monthly, biweekly, weekly, daily, annually)
          default: monthly
          examples:
          - monthly
          - biweekly
          - weekly
          - daily
          - annually
          hidden: false
      type: object
      required:
      - product_id
      - loan_amount
      - term_length
      - total_repayment_amount
      title: CalculateNominalInterestRateInput
      description: Schema for input parameters to calculate the nominal interest rate for a loan.
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    CalculateAprInput:
      properties:
        loan_amount:
          type: integer
          title: Loan Amount
          description: The loan principal amount in cents
          examples:
          - 10000
          hidden: false
        interest_is_amortized:
          type: boolean
          title: Interest Is Amortized
          description: Whether the interest is amortized. If set to False, interest is based on the original principal balance and follows a simple interest model.
          default: false
          examples:
          - true
          - false
          hidden: false
        interest_rate_percent:
          type: number
          title: Interest Rate Percent
          description: The nominal annual interest rate as a percentage (e.g., 5.0 for 5%)
          examples:
          - 5
          hidden: false
        term_length:
          type: integer
          title: Term Length
          description: Number of periods in loan term
          examples:
          - 12
          hidden: false
        period_interval:
          type: string
          enum:
          - monthly
          - biweekly
          - weekly
          - daily
          - annually
          title: Period Interval
          description: The interval at which payments are made (e.g., monthly, biweekly, weekly, daily, annually)
          default: monthly
          examples:
          - monthly
          - biweekly
          - weekly
          - daily
          - annually
          hidden: false
      type: object
      required:
      - loan_amount
      - interest_rate_percent
      - term_length
      title: CalculateAprInput
      description: Schema for input parameters to calculate the APR and APY for a loan.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer