Canopy Servicing Core API

API Overview
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.

This is the documentation for version 1.3 of the API. Last update on Jan 15, 2021.

Base URL
https://sandbox.canopyservicing.com

Getting Started

Get started in four easy steps.

1) Review the Authentication section to connect and experiment with our Sandbox environment.

2) Contact us to request Production API Keys and learn more about our business.

3) Configure policies
      a) For most uses, we recommend using the Policy Management Dashboard
      b) If you will be configuring many credit products programmatically or require niche configurations, you can also configure products in Canopy directly through our Policy Management API.

4) Once your product is configured and launched in Canopy, you have access to the full power of the Servicing API! You can take advantage of sample workflows provided by our team, or construct your own using this API documentation.


Authentication

To create your organization within Canopy, contact our team. Once created, review our API Users routes to handle all subsequent authentication-related activities, including inviting your team members to join your organization.



Test it out

To get going quickly, we recommend using an API collaboration tool called Postman. You can use the button below to import our collection of endpoints. Be sure to define the required environment variables.

Run in Postman


Products

Create and launch credit products within the Canopy system.

Get all available products

If you have configured and launched multiple products within Canopy, retrieve information related to all of your configured products at once.

URL parameters
  • offset integer

    The zero-indexed starting point for paginated product requests sorted by reverse product created date.

    Minimum value is 0, maximum value is 10.

  • limit integer

    The maximum number of products to be returned. Defaults to 100.

    Minimum value is 0, maximum value is 100.

Responses
  • 200 array[object]

    Array of Products

    • product_id Required / integer

      The Canopy-generated ID for the product.

    • created_at Required / string(date-time)

      The Date-Time that this product was created on the server.

    • effective_at string(date-time)

      The Date-Time as of which this product is effective on the server.

    • external_product_id string

      A unique external ID that may be used interchangeably with the Canopy-generated product ID

    • product_overview Required / object

      A series of static fields about the product.

      • product_overview.product_name Required / string

        Name of Product, i.e. Express Card.

      • product_overview.product_type Required / string

        The Type of Product

        Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

      • product_overview.product_short_description string

        A short description of the product ranging from 0 - 60 characters.

      • product_overview.product_long_description Required / string

        Description of the Product ranging from 0 - 1000.

      • product_overview.product_color string

        A color to be associated with the product for UI purposes.

      • product_overview.external_fields array[object]
        • product_overview.external_fields.key string
        • product_overview.external_fields.value string
    • product_lifecycle_policies Required / object
      • product_lifecycle_policies.payment_due_policies object

        The set of policies governing payment due information for the product.

        • product_lifecycle_policies.payment_due_policies.delinquent_on_n_consecutive_late_fees integer

          After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent

        • product_lifecycle_policies.payment_due_policies.charge_off_on_n_consecutive_late_fees integer

          After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off

      • product_lifecycle_policies.fee_policies object

        The set of policies governing fees for the product.

        • product_lifecycle_policies.fee_policies.late_fee_grace string

          Defaults to 0 days. The amount of time after a payment is late after which you would like for a late fee to be incurred.

      • product_lifecycle_policies.billing_cycle_policies object

        The set of policies governing the billing cycle for the product.

        • product_lifecycle_policies.billing_cycle_policies.cycle_interval Required / string

          The length of the billing cycle. after which a statement is generated, and a due date assigned. IE '1 month' '3 months' or '7 days' (most common is monthly)

        • product_lifecycle_policies.billing_cycle_policies.cycle_due_interval string

          Defaults to 0 days. The amount of time before statement cut that the payment should be due for the billing cycle. If positive, it will count days from the start of the cycle. Note, this field has a signage convention: if negative, it will count days back from the end of the cycle. IE '25 days' indicates that payments are due 25 days after the statement is cut. -5 days indicates that payments will be due five days prior to the cut of the next cycle. Cannot exceed the duration of the billing cycle.

        • product_lifecycle_policies.billing_cycle_policies.first_cycle_interval string

          Defaults to 0 days. If applicable, the amount of time you would like between origination and the first statement cut. IE '10 days'. If you would like the first billing cycle to be the same length as all other billing cycles, either do not include this field in the request, or set its value to the same as billing_cycle_period

        • product_lifecycle_policies.billing_cycle_policies.close_of_business_time string(time)

          Defaults to EST Midnight. Time of the close of business. Note* this value will be converted into the product_time_zone This is used for statement cuts and partner-level and issuing bank-level reconciliation

        • product_lifecycle_policies.billing_cycle_policies.product_time_zone string

          Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

      • product_lifecycle_policies.interest_policies object

        The Interest Policy Object

        • product_lifecycle_policies.interest_policies.interest_calc_time string(time)

          Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.

      • product_lifecycle_policies.default_attributes object
        • product_lifecycle_policies.default_attributes.default_credit_limit_cents Required / integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

        • product_lifecycle_policies.default_attributes.default_late_fee_cents integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

        • product_lifecycle_policies.default_attributes.default_payment_reversal_fee_cents integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

    • promotional_policies Required / object

      If applicable, a promotional configuration for the product.

      • promotional_policies.promo_len integer

        The number of billing cycles from account origination during which accounts on this product are on a promotional period.

      • promotional_policies.promo_min_pay_type string

        Current due calculation method for the promotional period.

        Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, and NONE.

      • promotional_policies.promo_purchase_window_len integer

        If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

      • promotional_policies.promo_min_pay_percent number

        Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.

      • promotional_policies.promo_interest_deferred boolean

        Indicates whether interest accrued during the promotional period is deferred interest.

      • promotional_policies.promo_default_interest_rate_percent number

        The rate that serves as the active interest rate for accounts during the promotional period.

      • promotional_policies.promo_apr_range_inclusive_lower number

        Optional lower bound for APR Range for the product (i.e. 2 = 2%).

      • promotional_policies.promo_apr_range_inclusive_upper number

        Optional upper bound for APR Range for the product (i.e. 5 = 5%).

    • post_promotional_policies Required / object
      • post_promotional_policies.post_promo_default_am_len integer

        Default duration for the amortization period during post-promotion

      • post_promotional_policies.post_promo_am_len_range_inclusive_lower integer

        Optional lower bound for amortization length in billing cycles for the product.

      • post_promotional_policies.post_promo_am_len_range_inclusive_upper integer

        Optional upper bound for amortization length in billing cycles for the product.

      • post_promotional_policies.post_promo_min_pay_type string

        Current due calculation method for the post-promotional period.

        Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, and NONE.

      • post_promotional_policies.post_promo_default_interest_rate_percent number

        The rate that serves as the active interest rate for accounts during the post-promotional period.

      • post_promotional_policies.post_promo_apr_range_inclusive_lower number

        Optional lower bound for APR Range for the product (i.e. 2 = 2%).

      • post_promotional_policies.post_promo_apr_range_inclusive_upper number

        Optional upper bound for APR Range for the product (i.e. 5 = 5%).

    • product_summary object

      Summary of product information

      • product_summary.accounts_overview object
        • product_summary.accounts_overview.account_count_total Required / integer

          Total number of accounts under the product.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Unable to get products

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/products
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/products \ -H "Content-Type: application/json"
Response example (200)
[ { "product_id": 6, "created_at": "2019-03-20T09:12:28+00:00", "effective_at": "2016-11-27T13:19:56+00:00", "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_overview": { "product_name": "Blue Cash Express", "product_type": "REVOLVING", "product_short_description": "12mm3apr.", "product_long_description": "Student credit card.", "product_color": "#0000FF", "external_fields": [ { "key": "client_product_id", "value": "3e93a899-d267-4193-8509-6dba53c13b7b" } ] }, "product_lifecycle_policies": { "payment_due_policies": { "delinquent_on_n_consecutive_late_fees": 42, "charge_off_on_n_consecutive_late_fees": 42 }, "fee_policies": { "late_fee_grace": "5 days" }, "billing_cycle_policies": { "cycle_interval": "1 month", "cycle_due_interval": "-5 days", "first_cycle_interval": "25 days", "close_of_business_time": "17:00:00-05:00", "product_time_zone": "America/Chicago" }, "interest_policies": { "interest_calc_time": "11:21:04-08:00" }, "default_attributes": { "default_credit_limit_cents": 600000, "default_late_fee_cents": 50000, "default_payment_reversal_fee_cents": 10000 } }, "promotional_policies": { "promo_len": 6, "promo_min_pay_type": "PERCENT_PRINCIPAL", "promo_purchase_window_len": 5, "promo_min_pay_percent": 100, "promo_interest_deferred": true, "promo_default_interest_rate_percent": 3, "promo_apr_range_inclusive_lower": 2, "promo_apr_range_inclusive_upper": 5 }, "post_promotional_policies": { "post_promo_default_am_len": 48, "post_promo_am_len_range_inclusive_lower": 2, "post_promo_am_len_range_inclusive_upper": 5, "post_promo_min_pay_type": "AM", "post_promo_default_interest_rate_percent": 3, "post_promo_apr_range_inclusive_lower": 2, "post_promo_apr_range_inclusive_upper": 5 }, "product_summary": { "accounts_overview": { "account_count_total": 10005 } } } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Create a new product

At its core, Canopy allows you to create credit products that meet the specific needs of your users. We offer robust options to configure these products within our system.

For most use cases, we recommend configuring products by sending an excel file detailing your preferred configurations to the Canopy team; however, you can also configure and manage products programmatically using this API documentation.

Request body for creating a new product.

Body
  • effective_at string(date-time)

    The Date-Time as of which this product is effective on the server.

  • product_overview Required / object

    A series of static fields about the product.

    • product_overview.external_product_id string

      A unique external ID that may be used interchangeably with the Canopy-generated product ID

    • product_overview.product_name Required / string

      Name of Product, i.e. BNPL 24 Month Standard.

    • product_overview.product_type Required / string

      The Type of Product

      Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

    • product_overview.product_short_description Required / string

      A short description of the product ranging from 0 - 60 characters.

    • product_overview.product_long_description Required / string

      Description of the Product ranging from 0 - 1000.

    • product_overview.product_color string

      A color to be associated with the product for UI purposes.

  • product_lifecycle_policies Required / object
    • product_lifecycle_policies.payment_due_policies object

      The set of policies governing payment due information for the product.

      • product_lifecycle_policies.payment_due_policies.delinquent_on_n_consecutive_late_fees integer

        After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent

      • product_lifecycle_policies.payment_due_policies.charge_off_on_n_consecutive_late_fees integer

        After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off

    • product_lifecycle_policies.fee_policies object

      The set of policies governing fees for the product.

      • product_lifecycle_policies.fee_policies.late_fee_grace string

        Defaults to 0 days. The amount of time after a payment is late after which you would like for a late fee to be incurred.

    • product_lifecycle_policies.billing_cycle_policies object

      The set of policies governing the billing cycle for the product.

      • product_lifecycle_policies.billing_cycle_policies.cycle_interval Required / string

        The length of the billing cycle. after which a statement is generated, and a due date assigned. IE '1 month' '3 months' or '7 days' (most common is monthly)

      • product_lifecycle_policies.billing_cycle_policies.cycle_due_interval string

        Defaults to 0 days. The amount of time before statement cut that the payment should be due for the billing cycle. If positive, it will count days from the start of the cycle. Note, this field has a signage convention: if negative, it will count days back from the end of the cycle. IE '25 days' indicates that payments are due 25 days after the statement is cut. -5 days indicates that payments will be due five days prior to the cut of the next cycle. Cannot exceed the duration of the billing cycle.

      • product_lifecycle_policies.billing_cycle_policies.first_cycle_interval string

        Defaults to 0 days. If applicable, the amount of time you would like between origination and the first statement cut. IE '10 days'. If you would like the first billing cycle to be the same length as all other billing cycles, either do not include this field in the request, or set its value to the same as billing_cycle_period

      • product_lifecycle_policies.billing_cycle_policies.close_of_business_time string(time)

        Defaults to EST Midnight. Time of the close of business. Note* this value will be converted into the product_time_zone This is used for statement cuts and partner-level and issuing bank-level reconciliation

      • product_lifecycle_policies.billing_cycle_policies.product_time_zone string

        Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

    • product_lifecycle_policies.interest_policies object

      The Interest Policy Object

      • product_lifecycle_policies.interest_policies.interest_calc_time string(time)

        Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.

    • product_lifecycle_policies.default_attributes object
      • product_lifecycle_policies.default_attributes.default_credit_limit_cents Required / integer

        The default maximum principal credit (in cents) available for a customer account. For risk-based-pricing, this default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product in the Create Account call. Credit limits for an account can also be updated post-account creation.

  • promotional_policies Required / object

    If applicable, a promotional configuration for the product.

    • promotional_policies.promo_len integer

      Defaults to 0. The number of billing cycles from account origination during which accounts on this product are on a promotional period.

    • promotional_policies.promo_min_pay_type string

      Current due calculation method for the promotional period.

      Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, and NONE.

    • promotional_policies.promo_purchase_window_len integer

      If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

    • promotional_policies.promo_interest_deferred boolean

      Indicates whether interest accrued during the promotional period is deferred interest.

    • promotional_policies.promo_default_interest_rate_percent number

      The rate that serves as the active interest rate for accounts during the promotional period.

    • promotional_policies.promo_min_pay_percent number

      Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.

    • promotional_policies.promo_apr_range_inclusive_lower number

      Optional lower bound for APR Range for the product (i.e. 2 = 2%).

    • promotional_policies.promo_apr_range_inclusive_upper number

      Optional upper bound for APR Range for the product (i.e. 5 = 5%).

  • post_promotional_policies Required / object
    • post_promotional_policies.post_promo_default_am_len integer

      Default duration for any amortization period during post-promotion

    • post_promotional_policies.post_promo_am_len_range_inclusive_lower integer

      Optional lower bound for amortization length in billing cycles for the product.

    • post_promotional_policies.post_promo_am_len_range_inclusive_upper integer

      Optional upper bound for amortization length in billing cycles for the product.

    • post_promotional_policies.post_promo_min_pay_type string

      Current due calculation method for the post-promotional period.

      Values are AM, PERCENT_INTEREST, and PERCENT_PRINCIPAL.

    • post_promotional_policies.post_promo_default_interest_rate_percent number

      The rate that serves as the active interest rate for accounts during the post-promotional period.

    • post_promotional_policies.post_promo_apr_range_inclusive_lower number

      Optional lower bound for APR Range for the product (i.e. 2 = 2%).

    • post_promotional_policies.post_promo_apr_range_inclusive_upper number

      Optional upper bound for APR Range for the product (i.e. 5 = 5%).

Responses
  • 200 object

    Product

    • product_id Required / integer

      The Canopy-generated ID for the product.

    • created_at Required / string(date-time)

      The Date-Time that this product was created on the server.

    • effective_at string(date-time)

      The Date-Time as of which this product is effective on the server.

    • external_product_id string

      A unique external ID that may be used interchangeably with the Canopy-generated product ID

    • product_overview Required / object

      A series of static fields about the product.

      • product_overview.product_name Required / string

        Name of Product, i.e. Express Card.

      • product_overview.product_type Required / string

        The Type of Product

        Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

      • product_overview.product_short_description string

        A short description of the product ranging from 0 - 60 characters.

      • product_overview.product_long_description Required / string

        Description of the Product ranging from 0 - 1000.

      • product_overview.product_color string

        A color to be associated with the product for UI purposes.

      • product_overview.external_fields array[object]
        • product_overview.external_fields.key string
        • product_overview.external_fields.value string
    • product_lifecycle_policies Required / object
      • product_lifecycle_policies.payment_due_policies object

        The set of policies governing payment due information for the product.

        • product_lifecycle_policies.payment_due_policies.delinquent_on_n_consecutive_late_fees integer

          After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent

        • product_lifecycle_policies.payment_due_policies.charge_off_on_n_consecutive_late_fees integer

          After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off

      • product_lifecycle_policies.fee_policies object

        The set of policies governing fees for the product.

        • product_lifecycle_policies.fee_policies.late_fee_grace string

          Defaults to 0 days. The amount of time after a payment is late after which you would like for a late fee to be incurred.

      • product_lifecycle_policies.billing_cycle_policies object

        The set of policies governing the billing cycle for the product.

        • product_lifecycle_policies.billing_cycle_policies.cycle_interval Required / string

          The length of the billing cycle. after which a statement is generated, and a due date assigned. IE '1 month' '3 months' or '7 days' (most common is monthly)

        • product_lifecycle_policies.billing_cycle_policies.cycle_due_interval string

          Defaults to 0 days. The amount of time before statement cut that the payment should be due for the billing cycle. If positive, it will count days from the start of the cycle. Note, this field has a signage convention: if negative, it will count days back from the end of the cycle. IE '25 days' indicates that payments are due 25 days after the statement is cut. -5 days indicates that payments will be due five days prior to the cut of the next cycle. Cannot exceed the duration of the billing cycle.

        • product_lifecycle_policies.billing_cycle_policies.first_cycle_interval string

          Defaults to 0 days. If applicable, the amount of time you would like between origination and the first statement cut. IE '10 days'. If you would like the first billing cycle to be the same length as all other billing cycles, either do not include this field in the request, or set its value to the same as billing_cycle_period

        • product_lifecycle_policies.billing_cycle_policies.close_of_business_time string(time)

          Defaults to EST Midnight. Time of the close of business. Note* this value will be converted into the product_time_zone This is used for statement cuts and partner-level and issuing bank-level reconciliation

        • product_lifecycle_policies.billing_cycle_policies.product_time_zone string

          Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

      • product_lifecycle_policies.interest_policies object

        The Interest Policy Object

        • product_lifecycle_policies.interest_policies.interest_calc_time string(time)

          Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.

      • product_lifecycle_policies.default_attributes object
        • product_lifecycle_policies.default_attributes.default_credit_limit_cents Required / integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

        • product_lifecycle_policies.default_attributes.default_late_fee_cents integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

        • product_lifecycle_policies.default_attributes.default_payment_reversal_fee_cents integer

          The default maximum principal credit (in cents) available for a customer account. This default limit can be overridden on a per-account basis if a credit_limit is selected at the time of assigning an account to a product. Credit limits for an account can also be updated post-account creation.

    • promotional_policies Required / object

      If applicable, a promotional configuration for the product.

      • promotional_policies.promo_len integer

        The number of billing cycles from account origination during which accounts on this product are on a promotional period.

      • promotional_policies.promo_min_pay_type string

        Current due calculation method for the promotional period.

        Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, and NONE.

      • promotional_policies.promo_purchase_window_len integer

        If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

      • promotional_policies.promo_min_pay_percent number

        Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.

      • promotional_policies.promo_interest_deferred boolean

        Indicates whether interest accrued during the promotional period is deferred interest.

      • promotional_policies.promo_default_interest_rate_percent number

        The rate that serves as the active interest rate for accounts during the promotional period.

      • promotional_policies.promo_apr_range_inclusive_lower number

        Optional lower bound for APR Range for the product (i.e. 2 = 2%).

      • promotional_policies.promo_apr_range_inclusive_upper number

        Optional upper bound for APR Range for the product (i.e. 5 = 5%).

    • post_promotional_policies Required / object
      • post_promotional_policies.post_promo_default_am_len integer

        Default duration for the amortization period during post-promotion

      • post_promotional_policies.post_promo_am_len_range_inclusive_lower integer

        Optional lower bound for amortization length in billing cycles for the product.

      • post_promotional_policies.post_promo_am_len_range_inclusive_upper integer

        Optional upper bound for amortization length in billing cycles for the product.

      • post_promotional_policies.post_promo_min_pay_type string

        Current due calculation method for the post-promotional period.

        Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, and NONE.

      • post_promotional_policies.post_promo_default_interest_rate_percent number

        The rate that serves as the active interest rate for accounts during the post-promotional period.

      • post_promotional_policies.post_promo_apr_range_inclusive_lower number

        Optional lower bound for APR Range for the product (i.e. 2 = 2%).

      • post_promotional_policies.post_promo_apr_range_inclusive_upper number

        Optional upper bound for APR Range for the product (i.e. 5 = 5%).

    • product_summary object

      Summary of product information

      • product_summary.accounts_overview object
        • product_summary.accounts_overview.account_count_total Required / integer

          Total number of accounts under the product.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/products
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/products \ -H "Content-Type: application/json" \ -d '{"effective_at":"2016-11-27T13:19:56+00:00","product_overview":{"external_product_id":"95fea111-d121-40f8-9e8e-a6c335e48a45","product_name":"BNPL 24 Month Standard","product_type":"REVOLVING","product_short_description":"12mm3apr.","product_long_description":"Student credit card.","product_color":"#0000FF"},"product_lifecycle_policies":{"payment_due_policies":{"delinquent_on_n_consecutive_late_fees":42,"charge_off_on_n_consecutive_late_fees":42},"fee_policies":{"late_fee_grace":"5 days"},"bi...}'
Request payload example
{ "effective_at": "2016-11-27T13:19:56+00:00", "product_overview": { "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_name": "BNPL 24 Month Standard", "product_type": "REVOLVING", "product_short_description": "12mm3apr.", "product_long_description": "Student credit card.", "product_color": "#0000FF" }, "product_lifecycle_policies": { "payment_due_policies": { "delinquent_on_n_consecutive_late_fees": 42, "charge_off_on_n_consecutive_late_fees": 42 }, "fee_policies": { "late_fee_grace": "5 days" }, "billing_cycle_policies": { "cycle_interval": "1 month", "cycle_due_interval": "-5 days", "first_cycle_interval": "25 days", "close_of_business_time": "17:00:00-05:00", "product_time_zone": "America/Chicago" }, "interest_policies": { "interest_calc_time": "11:21:04-08:00" }, "default_attributes": { "default_credit_limit_cents": 600000 } }, "promotional_policies": { "promo_len": 6, "promo_min_pay_type": "PERCENT_PRINCIPAL", "promo_purchase_window_len": 5, "promo_interest_deferred": true, "promo_default_interest_rate_percent": 3, "promo_min_pay_percent": 100, "promo_apr_range_inclusive_lower": 2, "promo_apr_range_inclusive_upper": 5 }, "post_promotional_policies": { "post_promo_default_am_len": 48, "post_promo_am_len_range_inclusive_lower": 2, "post_promo_am_len_range_inclusive_upper": 5, "post_promo_min_pay_type": "AM", "post_promo_default_interest_rate_percent": 3, "post_promo_apr_range_inclusive_lower": 2, "post_promo_apr_range_inclusive_upper": 5 } }
Response example (200)
{ "product_id": 6, "created_at": "2019-03-20T09:12:28+00:00", "effective_at": "2016-11-27T13:19:56+00:00", "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_overview": { "product_name": "Blue Cash Express", "product_type": "REVOLVING", "product_short_description": "12mm3apr.", "product_long_description": "Student credit card.", "product_color": "#0000FF", "external_fields": [ { "key": "client_product_id", "value": "3e93a899-d267-4193-8509-6dba53c13b7b" } ] }, "product_lifecycle_policies": { "payment_due_policies": { "delinquent_on_n_consecutive_late_fees": 42, "charge_off_on_n_consecutive_late_fees": 42 }, "fee_policies": { "late_fee_grace": "5 days" }, "billing_cycle_policies": { "cycle_interval": "1 month", "cycle_due_interval": "-5 days", "first_cycle_interval": "25 days", "close_of_business_time": "17:00:00-05:00", "product_time_zone": "America/Chicago" }, "interest_policies": { "interest_calc_time": "11:21:04-08:00" }, "default_attributes": { "default_credit_limit_cents": 600000, "default_late_fee_cents": 50000, "default_payment_reversal_fee_cents": 10000 } }, "promotional_policies": { "promo_len": 6, "promo_min_pay_type": "PERCENT_PRINCIPAL", "promo_purchase_window_len": 5, "promo_min_pay_percent": 100, "promo_interest_deferred": true, "promo_default_interest_rate_percent": 3, "promo_apr_range_inclusive_lower": 2, "promo_apr_range_inclusive_upper": 5 }, "post_promotional_policies": { "post_promo_default_am_len": 48, "post_promo_am_len_range_inclusive_lower": 2, "post_promo_am_len_range_inclusive_upper": 5, "post_promo_min_pay_type": "AM", "post_promo_default_interest_rate_percent": 3, "post_promo_apr_range_inclusive_lower": 2, "post_promo_apr_range_inclusive_upper": 5 }, "product_summary": { "accounts_overview": { "account_count_total": 10005 } } }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Customers

Onboard customers into your system, so they can begin using your credit products

Get all accounts for all customers

Returns all accounts from the perspective of each customer. For instance, if one account has two customers, these are reflected as two separate items in the response array. Similarly, if one customer has multiple accounts, each account is reflected as a separate item in the response array.

URL parameters
  • offset integer

    The zero-indexed starting point for paginated customer account requests sorted by account created date.

  • limit integer

    The maximum number of customer accounts to be returned. Defaults to 100.

Responses
  • 200 object

    Array of Customers and their corresponding Accounts

    • results array[object]

      An array of information for all customer-account correspondences within the requested range.

      • results.customer_id Required / integer

        A Canopy-generated unique ID for the customer

      • results.name_prefix string

        Prefix to the customer's name

      • results.name_first string

        Customer's first name

      • results.name_middle string

        Customer's middle name

      • results.name_last string

        Customer's last name

      • results.name_suffix string

        Prefix to the customer's name

      • results.phone_number string

        Phone number of the customer

      • results.address_line_one string

        Address line one

      • results.address_line_two string

        Address line two

      • results.address_city string

        Address city

      • results.address_state string

        Address state

      • results.address_zip string

        Address zip code

      • results.ssn string

        Social security number of the customer

      • results.email string(email)

        The email address of this Customer

      • results.date_of_birth string(date-time)

        Customer's date of birth

      • results.customer_account_role string

        The role of the customer for the account.

        Values are PRIMARY and SECONDARY.

      • results.customer_account_external_id string

        A unique number for the customer on the account. For instance, a credit card number. If none is provided, a Canopy-generated ID can be used.

      • results.account object
        • results.account.account_id Required / integer

          This is generated by Canopy. A unique ID for the account.

        • results.account.created_at Required / string(date-time)

          The Date-Time which the account was created in the API.

        • results.account.effective_at Required / string(date-time)

          The Date-Time that this account became/becomes active.

        • results.account.account_overview object
          • results.account.account_overview.account_status Required / string

            The Status of the Account. Active upon account creation.

          • results.account.account_overview.account_status_subtype string

            The subtype of the Status of the Account. Null upon account creation.

        • results.account.account_product object

          The product associated with the account

          • results.account.account_product.product_id Required / integer

            The Canopy-generated ID for the product.

          • results.account.account_product.external_product_id string

            A unique external ID that may be used interchangeably with the Canopy-generated product ID

          • results.account.account_product.product_overview object
            • results.account.account_product.product_overview.product_name Required / string

              Name of Product, i.e. Express Card.

            • results.account.account_product.product_overview.product_color string

              A color to be associated with the product for UI purposes.

            • results.account.account_product.product_overview.product_short_description string

              Short description of the Product - max of 30 characters.

            • results.account.account_product.product_overview.product_long_description Required / string

              Description of the Product.

            • results.account.account_product.product_overview.product_time_zone string

              Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

            • results.account.account_product.product_overview.product_type Required / string

              The Type of Product. If not included, defaults to REVOLVING

              Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

          • results.account.account_product.product_lifecycle object
            • results.account.account_product.product_lifecycle.late_fee_impl_cents Required / integer

              The fee charged for late payments on the account.

            • results.account.account_product.product_lifecycle.payment_reversal_fee_impl_cents Required / integer

              The fee charged for payment reversals on the account.

            • results.account.account_product.product_lifecycle.loan_end_date string(date-time)

              If applicable, the account's loan repayment date.

          • results.account.account_product.promo_overview object
            • results.account.account_product.promo_overview.promo_purchase_window_inclusive_start string(date-time)

              If applicable, the start date for a purchase window for the account

            • results.account.account_product.promo_overview.promo_purchase_window_exclusive_end string(date-time)

              If applicable, the end date for a purchase window for the account

            • results.account.account_product.promo_overview.promo_inclusive_start string(date-time)

              If applicable, the start date for a promotional period for the account.

            • results.account.account_product.promo_overview.promo_exclusive_end string(date-time)

              If applicable, the start date for a promotional period for the account.

            • results.account.account_product.promo_overview.promo_impl_interest_rate_percent number

              The percentage interest applied to the account during the promotional period (i.e. 6.2%)

          • results.account.account_product.post_promo_overview object
            • results.account.account_product.post_promo_overview.post_promo_inclusive_start string(date-time)

              If applicable, the start date for a promotional period for the account.

            • results.account.account_product.post_promo_overview.post_promo_exclusive_end string(date-time)

              If applicable, the start date for a promotional period for the account.

            • results.account.account_product.post_promo_overview.post_promo_impl_interest_rate_percent number

              The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

            • results.account.account_product.post_promo_overview.post_promo_impl_am_len integer

              If applicable, post-promotional amortization length in cycles.

          • results.account.account_product.product_duration_information object
            • results.account.account_product.product_duration_information.promo_len integer

              The number of billing cycles from account origination during which accounts on this product are on a promotional period.

            • results.account.account_product.product_duration_information.promo_purchase_window_len integer

              If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

        • results.account.external_fields array[object]

          An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

          • results.account.external_fields.key string

            key: i.e. Name of the External Party

          • results.account.external_fields.value string

            value: i.e. External Account ID

        • results.account.min_pay_due_cents object
          • results.account.min_pay_due_cents.min_pay_cents Required / integer

            Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

          • results.account.min_pay_due_cents.min_pay_due_at Required / string(date-time)

            The Date-Time the payment for this billing cycle is due.

        • results.account.additional_min_pay_details object
          • results.account.additional_min_pay_details.min_pay_charges_principal_cents Required / integer

            Total principal due for the billing cycle.

          • results.account.additional_min_pay_details.min_pay_interest_cents Required / integer

            Total interest due for the billing cycle.

          • results.account.additional_min_pay_details.min_pay_deferred_cents Required / integer

            Total deferred interest due for the billing cycle.

          • results.account.additional_min_pay_details.min_pay_fees_cents Required / integer

            Total fees due for the billing cycle.

          • results.account.additional_min_pay_details.previous_min_pay_cents Required / integer

            Previous amounts due, including fees. This is a subset of min_pay_cents.

        • results.account.summary object
          • results.account.summary.total_balance_cents Required / integer

            The total balance (in cents) associated with the account.

          • results.account.summary.principal_cents Required / integer

            The total balance (in cents) associated with the account.

          • results.account.summary.interest_balance_cents Required / integer

            The total interest balance (in cents) associated with the account.

          • results.account.summary.deferred_interest_balance_cents integer

            The total deferred interest balance (in cents) associated with the account.

          • results.account.summary.total_paid_to_date_cents Required / integer

            The total sum of payments made to date (in cents) associated with the account.

          • results.account.summary.total_interest_paid_to_date_cents Required / integer

            The total sum of interest allocations for payments made to date (in cents) associated with the account.

          • results.account.summary.credit_limit_cents Required / integer

            Total Amount (in cents) that this account can borrow.

          • results.account.summary.max_approved_credit_limit_cents integer

            Total Amount (in cents) that this account can borrow.

          • results.account.summary.interest_rate_percent Required / number

            The percentage interest applied to the account (i.e. 6.2 means 6.2%)

          • results.account.summary.available_credit_cents integer

            The total available credit balance (in cents) for the account.

          • results.account.summary.open_to_buy_cents integer

            If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

        • results.account.associated_entities object
          • results.account.associated_entities.merchant_name string

            A merchant name associated with the account

          • results.account.associated_entities.lender_name string

            A lender name associated with the account

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Unable to get customers

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/customers/accounts
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/customers/accounts \ -H "Content-Type: application/json"
Response example (200)
{ "results": [ { "customer_id": 8, "name_prefix": "Dr.", "name_first": "Miriam", "name_middle": "Louise", "name_last": "Trevino", "name_suffix": "Jr", "phone_number": "555-555-5555", "address_line_one": "12 Strawberry Road", "address_line_two": "Suite 101", "address_city": "Atlanta", "address_state": "GA", "address_zip": "99999-1000", "ssn": "888-88-8888", "email": "marissa@protonmail.com", "date_of_birth": "2018-06-20T09:12:30+00:00", "customer_account_role": "PRIMARY", "customer_account_external_id": "4465220133024156", "account": { "account_id": 9, "created_at": "2017-06-20T09:12:14+00:00", "effective_at": "2018-03-20T09:12:28+00:00", "account_overview": { "account_status": "suspended", "account_status_subtype": "suspended-bankruptcy" }, "account_product": { "product_id": 4, "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_overview": { "product_name": "Blue Cash Express", "product_color": "#0000FF", "product_short_description": "Consumer credit card", "product_long_description": "Student credit card.", "product_time_zone": "America/Chicago", "product_type": "REVOLVING" }, "product_lifecycle": { "late_fee_impl_cents": 2900, "payment_reversal_fee_impl_cents": 2900, "loan_end_date": "2013-01-13T05:25:13.813+00:00" }, "promo_overview": { "promo_purchase_window_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_purchase_window_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_impl_interest_rate_percent": 6.2 }, "post_promo_overview": { "post_promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "post_promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "post_promo_impl_interest_rate_percent": 6.2, "post_promo_impl_am_len": 48 }, "product_duration_information": { "promo_len": 6, "promo_purchase_window_len": 5 } }, "external_fields": [ { "key": "Umbrella Corporation", "value": "22445702-a389-431f-927d-07b8d0750787" } ], "min_pay_due_cents": { "min_pay_cents": 160000, "min_pay_due_at": "2019-10-18T23:04:48.321+00:00" }, "additional_min_pay_details": { "min_pay_charges_principal_cents": 100000, "min_pay_interest_cents": 30000, "min_pay_deferred_cents": 10000, "min_pay_fees_cents": 20000, "previous_min_pay_cents": 400000 }, "summary": { "total_balance_cents": 300000, "principal_cents": 200000, "interest_balance_cents": 60000, "deferred_interest_balance_cents": 40000, "total_paid_to_date_cents": 40000, "total_interest_paid_to_date_cents": 10000, "credit_limit_cents": 400000, "max_approved_credit_limit_cents": 400000, "interest_rate_percent": 3, "available_credit_cents": 100000, "open_to_buy_cents": 5000 }, "associated_entities": { "merchant_name": "Acme Corporation", "lender_name": "Globex Lending Corp" } } } ] }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Create a new customer

Customer can be created within Canopy with attached data managed in a secure and compliant way to facilitate providing the best service for products created through Canopy.

Body
  • name_prefix string

    Prefix to the customer's name

  • name_first Required / string

    Customer's first name

  • name_middle string

    Customer's middle name

  • name_last Required / string

    Customer's last name

  • name_suffix string

    Prefix to the customer's name

  • phone_number Required / string

    Phone number of the customer

  • address_line_one Required / string

    Address line one

  • address_line_two string

    Address line two

  • address_city Required / string

    Address city

  • address_state Required / string

    Address state

  • address_zip Required / string

    Address zip code

  • ssn Required / string

    Social security number of the customer

  • email Required / string(email)

    The email address of this Customer

  • date_of_birth Required / string(date-time)

    Customer's date of birth

  • assign_to_accounts array[object]

    An array of existing accounts to which this Customer should be assigned.

    If left empty, the customer will not be assigned to any accounts, and can be later assigned to an account via the Update an existing customer route.

    Customers only become meaningful agents in Canopy's servicing system once they are assigned to accounts.

    • assign_to_accounts.account_id integer

      This is generated by Canopy. A unique ID for the account.

    • assign_to_accounts.customer_account_role string

      The role of the customer for the account

      Values are PRIMARY and SECONDARY.

    • assign_to_accounts.customer_account_external_id string

      A unique number for the customer on the account. For instance, a credit card number. If none is provided, a Canopy-generated ID can be used.

Responses
  • 200 object

    New Customer Created

    • customer_id Required / integer

      A Canopy-generated unique ID for the customer

    • name_prefix string

      Prefix to the customer's name

    • name_first string

      Customer's first name

    • name_middle string

      Customer's middle name

    • name_last string

      Customer's last name

    • name_suffix string

      Prefix to the customer's name

    • phone_number string

      Phone number of the customer

    • address_line_one string

      Address line one

    • address_line_two string

      Address line two

    • address_city string

      Address city

    • address_state string

      Address state

    • address_zip string

      Address zip code

    • ssn string

      Social security number of the customer

    • email string(email)

      The email address of this Customer

    • date_of_birth string(date-time)

      Customer's date of birth

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/customers
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/customers \ -H "Content-Type: application/json" \ -d '{"name_prefix":"Dr.","name_first":"Miriam","name_middle":"Louise","name_last":"Trevino","name_suffix":"Jr","phone_number":"555-555-5555","address_line_one":"12 Strawberry Road","address_line_two":"Suite 101","address_city":"Atlanta","address_state":"GA","address_zip":"99999-1000","ssn":"888-88-8888","email":"marissa@protonmail.com","date_of_birth":"2018-06-20T09:12:30+00:00","assign_to_accounts":[{"account_id":103,"customer_account_role":"PRIMARY","customer_account_external_id":"446522013302...}'
Request payload example
{ "name_prefix": "Dr.", "name_first": "Miriam", "name_middle": "Louise", "name_last": "Trevino", "name_suffix": "Jr", "phone_number": "555-555-5555", "address_line_one": "12 Strawberry Road", "address_line_two": "Suite 101", "address_city": "Atlanta", "address_state": "GA", "address_zip": "99999-1000", "ssn": "888-88-8888", "email": "marissa@protonmail.com", "date_of_birth": "2018-06-20T09:12:30+00:00", "assign_to_accounts": [ { "account_id": 103, "customer_account_role": "PRIMARY", "customer_account_external_id": "4465220133024156" } ] }
Response example (200)
{ "customer_id": 8, "name_prefix": "Dr.", "name_first": "Miriam", "name_middle": "Louise", "name_last": "Trevino", "name_suffix": "Jr", "phone_number": "555-555-5555", "address_line_one": "12 Strawberry Road", "address_line_two": "Suite 101", "address_city": "Atlanta", "address_state": "GA", "address_zip": "99999-1000", "ssn": "888-88-8888", "email": "marissa@protonmail.com", "date_of_birth": "2018-06-20T09:12:30+00:00" }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Accounts

Manage the way your users use credit products you've launched in Canopy

Create a new account

At least one account should be created for customer of each of your products. Once created, you will be able to add line_items to the account.

Body
  • effective_at string(date-time)

    The Date-Time as of which this account is effective on the server.

  • product_id integer

    The Canopy-generated Product ID of the account. Either this, or the external_product_id must be passed at the time of account creation.

  • external_product_id string

    A unique external ID that may be used interchangeably with the Canopy-generated product ID. Either this, or the Canopy product ID must be passed at the time of account creation.

  • external_fields array[object]

    An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

    • external_fields.key string

      key: i.e. Name of the External Party

    • external_fields.value string

      value: i.e. External Account ID

  • summary object
    • summary.credit_limit_cents integer

      Total Amount (in cents) that this account can borrow.

    • summary.max_approved_credit_limit_cents integer

      Total Amount (in cents) that this account can borrow.

    • summary.late_fee_cents integer

      The fee charged for late payments on the account.

    • summary.payment_reversal_fee_cents integer

      The fee charged for payment reversals on the account.

    • summary.initial_principal_cents integer

      The initial principal balance (in cents) for the account.

  • promo_overview object
    • promo_overview.promo_impl_interest_rate_percent number

      The percentage interest applied to the account during the promotional period (i.e. 6.2%)

  • post_promo_overview object
    • post_promo_overview.post_promo_impl_interest_rate_percent number

      The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

    • post_promo_overview.post_promo_impl_am_len integer

      If applicable, post-promotional amortization length in cycles.

  • associated_entities object
    • associated_entities.merchant_name string

      A merchant name associated with the account

    • associated_entities.lender_name string

      A lender name associated with the account

  • assign_customers array[object]

    Array of existing customer IDs to be added to the account. At least one existing OR one new customer must be included in account creation.

    • assign_customers.customer_id integer

      Canopy-generated unique ID for this customer

    • assign_customers.customer_account_role string

      The role of the customer for the account.

      Values are PRIMARY and SECONDARY.

Responses
  • 200 object

    Successful query of information for a specific account

    • account_id integer

      This is generated by Canopy. A unique ID for the account.

    • created_at string(date-time)

      The Date-Time which the account was created in the API.

    • effective_at string(date-time)

      The Date-Time that this account became/becomes active.

    • account_overview object
      • account_overview.account_status Required / string

        The Status of the Account. Active upon account creation.

      • account_overview.account_status_subtype string

        The subtype of the Status of the Account. Null upon account creation.

    • account_product object

      The product associated with the account

      • account_product.product_id Required / integer

        The Canopy-generated ID for the product.

      • account_product.external_product_id string

        A unique external ID that may be used interchangeably with the Canopy-generated product ID

      • account_product.product_overview object
        • account_product.product_overview.product_name Required / string

          Name of Product, i.e. Express Card.

        • account_product.product_overview.product_color string

          A color to be associated with the product for UI purposes.

        • account_product.product_overview.product_short_description string

          Short description of the Product - max of 30 characters.

        • account_product.product_overview.product_long_description Required / string

          Description of the Product.

        • account_product.product_overview.product_time_zone string

          Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

        • account_product.product_overview.product_type Required / string

          The Type of Product. If not included, defaults to REVOLVING

          Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

      • account_product.product_lifecycle object
        • account_product.product_lifecycle.late_fee_impl_cents Required / integer

          The fee charged for late payments on the account.

        • account_product.product_lifecycle.payment_reversal_fee_impl_cents Required / integer

          The fee charged for payment reversals on the account.

        • account_product.product_lifecycle.loan_end_date string(date-time)

          If applicable, the account's loan repayment date.

      • account_product.promo_overview object
        • account_product.promo_overview.promo_purchase_window_inclusive_start string(date-time)

          If applicable, the start date for a purchase window for the account

        • account_product.promo_overview.promo_purchase_window_exclusive_end string(date-time)

          If applicable, the end date for a purchase window for the account

        • account_product.promo_overview.promo_inclusive_start string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.promo_overview.promo_exclusive_end string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.promo_overview.promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the promotional period (i.e. 6.2%)

      • account_product.post_promo_overview object
        • account_product.post_promo_overview.post_promo_inclusive_start string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.post_promo_overview.post_promo_exclusive_end string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.post_promo_overview.post_promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

        • account_product.post_promo_overview.post_promo_impl_am_len integer

          If applicable, post-promotional amortization length in cycles.

      • account_product.product_duration_information object
        • account_product.product_duration_information.promo_len integer

          The number of billing cycles from account origination during which accounts on this product are on a promotional period.

        • account_product.product_duration_information.promo_purchase_window_len integer

          If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

    • external_fields array[object]

      An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

      • external_fields.key string

        key: i.e. Name of the External Party

      • external_fields.value string

        value: i.e. External Account ID

    • min_pay_due_cents object
      • min_pay_due_cents.min_pay_cents Required / integer

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

      • min_pay_due_cents.min_pay_due_at Required / string(date-time)

        The Date-Time the payment for this billing cycle is due.

    • additional_min_pay_details object
      • additional_min_pay_details.min_pay_charges_principal_cents Required / integer

        Total principal due for the billing cycle.

      • additional_min_pay_details.min_pay_interest_cents Required / integer

        Total interest due for the billing cycle.

      • additional_min_pay_details.min_pay_deferred_cents Required / integer

        Total deferred interest due for the billing cycle.

      • additional_min_pay_details.min_pay_fees_cents Required / integer

        Total fees due for the billing cycle.

      • additional_min_pay_details.previous_min_pay_cents Required / integer

        Previous amounts due, including fees. This is a subset of min_pay_cents.

    • summary object
      • summary.total_balance_cents Required / integer

        The total balance (in cents) associated with the account.

      • summary.principal_cents Required / integer

        The total balance (in cents) associated with the account.

      • summary.interest_balance_cents Required / integer

        The total interest balance (in cents) associated with the account.

      • summary.deferred_interest_balance_cents integer

        The total deferred interest balance (in cents) associated with the account.

      • summary.total_paid_to_date_cents Required / integer

        The total sum of payments made to date (in cents) associated with the account.

      • summary.total_interest_paid_to_date_cents Required / integer

        The total sum of interest allocations for payments made to date (in cents) associated with the account.

      • summary.credit_limit_cents Required / integer

        Total Amount (in cents) that this account can borrow.

      • summary.max_approved_credit_limit_cents integer

        Total Amount (in cents) that this account can borrow.

      • summary.interest_rate_percent Required / number

        The percentage interest applied to the account (i.e. 6.2 means 6.2%)

      • summary.available_credit_cents integer

        The total available credit balance (in cents) for the account.

      • summary.open_to_buy_cents integer

        If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

    • associated_entities object
      • associated_entities.merchant_name string

        A merchant name associated with the account

      • associated_entities.lender_name string

        A lender name associated with the account

    • customers array[object]

      An array of customers who have been assigned to the account

      • customers.customer_id Required / integer

        A Canopy-generated unique ID for the customer

      • customers.name_prefix string

        Prefix to the customer's name

      • customers.name_first string

        Customer's first name

      • customers.name_middle string

        Customer's middle name

      • customers.name_last string

        Customer's last name

      • customers.name_suffix string

        Prefix to the customer's name

      • customers.phone_number string

        Phone number of the customer

      • customers.address_line_one string

        Address line one

      • customers.address_line_two string

        Address line two

      • customers.address_city string

        Address city

      • customers.address_state string

        Address state

      • customers.address_zip string

        Address zip code

      • customers.ssn string

        Social security number of the customer

      • customers.email string(email)

        The email address of this Customer

      • customers.date_of_birth string(date-time)

        Customer's date of birth

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/accounts
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/accounts \ -H "Content-Type: application/json" \ -d '{"effective_at":"2016-11-27T13:19:56+00:00","product_id":6,"external_product_id":"95fea111-d121-40f8-9e8e-a6c335e48a45","external_fields":[{"key":"Umbrella Corporation","value":"22445702-a389-431f-927d-07b8d0750787"}],"summary":{"credit_limit_cents":400000,"max_approved_credit_limit_cents":400000,"late_fee_cents":2900,"payment_reversal_fee_cents":2900,"initial_principal_cents":400000},"promo_overview":{"promo_impl_interest_rate_percent":6.2},"post_promo_overview":{"post_promo_impl_interest_r...}'
Request payload example
{ "effective_at": "2016-11-27T13:19:56+00:00", "product_id": 6, "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "external_fields": [ { "key": "Umbrella Corporation", "value": "22445702-a389-431f-927d-07b8d0750787" } ], "summary": { "credit_limit_cents": 400000, "max_approved_credit_limit_cents": 400000, "late_fee_cents": 2900, "payment_reversal_fee_cents": 2900, "initial_principal_cents": 400000 }, "promo_overview": { "promo_impl_interest_rate_percent": 6.2 }, "post_promo_overview": { "post_promo_impl_interest_rate_percent": 6.2, "post_promo_impl_am_len": 48 }, "associated_entities": { "merchant_name": "Acme Corporation", "lender_name": "Globex Lending Corp" }, "assign_customers": [ { "customer_id": 6, "customer_account_role": "SECONDARY" } ] }
Response example (200)
{ "account_id": 9, "created_at": "2017-06-20T09:12:14+00:00", "effective_at": "2018-03-20T09:12:28+00:00", "account_overview": { "account_status": "suspended", "account_status_subtype": "suspended-bankruptcy" }, "account_product": { "product_id": 4, "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_overview": { "product_name": "Blue Cash Express", "product_color": "#0000FF", "product_short_description": "Consumer credit card", "product_long_description": "Student credit card.", "product_time_zone": "America/Chicago", "product_type": "REVOLVING" }, "product_lifecycle": { "late_fee_impl_cents": 2900, "payment_reversal_fee_impl_cents": 2900, "loan_end_date": "2013-01-13T05:25:13.813+00:00" }, "promo_overview": { "promo_purchase_window_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_purchase_window_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_impl_interest_rate_percent": 6.2 }, "post_promo_overview": { "post_promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "post_promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "post_promo_impl_interest_rate_percent": 6.2, "post_promo_impl_am_len": 48 }, "product_duration_information": { "promo_len": 6, "promo_purchase_window_len": 5 } }, "external_fields": [ { "key": "Umbrella Corporation", "value": "22445702-a389-431f-927d-07b8d0750787" } ], "min_pay_due_cents": { "min_pay_cents": 160000, "min_pay_due_at": "2019-10-18T23:04:48.321+00:00" }, "additional_min_pay_details": { "min_pay_charges_principal_cents": 100000, "min_pay_interest_cents": 30000, "min_pay_deferred_cents": 10000, "min_pay_fees_cents": 20000, "previous_min_pay_cents": 400000 }, "summary": { "total_balance_cents": 300000, "principal_cents": 200000, "interest_balance_cents": 60000, "deferred_interest_balance_cents": 40000, "total_paid_to_date_cents": 40000, "total_interest_paid_to_date_cents": 10000, "credit_limit_cents": 400000, "max_approved_credit_limit_cents": 400000, "interest_rate_percent": 3, "available_credit_cents": 100000, "open_to_buy_cents": 5000 }, "associated_entities": { "merchant_name": "Acme Corporation", "lender_name": "Globex Lending Corp" }, "customers": [ { "customer_id": 8, "name_prefix": "Dr.", "name_first": "Miriam", "name_middle": "Louise", "name_last": "Trevino", "name_suffix": "Jr", "phone_number": "555-555-5555", "address_line_one": "12 Strawberry Road", "address_line_two": "Suite 101", "address_city": "Atlanta", "address_state": "GA", "address_zip": "99999-1000", "ssn": "888-88-8888", "email": "marissa@protonmail.com", "date_of_birth": "2018-06-20T09:12:30+00:00" } ] }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Get a specific Account

URL parameters
  • account_id Required / integer

    Account ID

Responses
  • 200 object

    Successful query of information for a specific account

    • account_id integer

      This is generated by Canopy. A unique ID for the account.

    • created_at string(date-time)

      The Date-Time which the account was created in the API.

    • effective_at string(date-time)

      The Date-Time that this account became/becomes active.

    • account_overview object
      • account_overview.account_status Required / string

        The Status of the Account. Active upon account creation.

      • account_overview.account_status_subtype string

        The subtype of the Status of the Account. Null upon account creation.

    • account_product object

      The product associated with the account

      • account_product.product_id Required / integer

        The Canopy-generated ID for the product.

      • account_product.external_product_id string

        A unique external ID that may be used interchangeably with the Canopy-generated product ID

      • account_product.product_overview object
        • account_product.product_overview.product_name Required / string

          Name of Product, i.e. Express Card.

        • account_product.product_overview.product_color string

          A color to be associated with the product for UI purposes.

        • account_product.product_overview.product_short_description string

          Short description of the Product - max of 30 characters.

        • account_product.product_overview.product_long_description Required / string

          Description of the Product.

        • account_product.product_overview.product_time_zone string

          Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

        • account_product.product_overview.product_type Required / string

          The Type of Product. If not included, defaults to REVOLVING

          Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, and FIXED_RATE_INSTALLMENT.

      • account_product.product_lifecycle object
        • account_product.product_lifecycle.late_fee_impl_cents Required / integer

          The fee charged for late payments on the account.

        • account_product.product_lifecycle.payment_reversal_fee_impl_cents Required / integer

          The fee charged for payment reversals on the account.

        • account_product.product_lifecycle.loan_end_date string(date-time)

          If applicable, the account's loan repayment date.

      • account_product.promo_overview object
        • account_product.promo_overview.promo_purchase_window_inclusive_start string(date-time)

          If applicable, the start date for a purchase window for the account

        • account_product.promo_overview.promo_purchase_window_exclusive_end string(date-time)

          If applicable, the end date for a purchase window for the account

        • account_product.promo_overview.promo_inclusive_start string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.promo_overview.promo_exclusive_end string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.promo_overview.promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the promotional period (i.e. 6.2%)

      • account_product.post_promo_overview object
        • account_product.post_promo_overview.post_promo_inclusive_start string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.post_promo_overview.post_promo_exclusive_end string(date-time)

          If applicable, the start date for a promotional period for the account.

        • account_product.post_promo_overview.post_promo_impl_interest_rate_percent number

          The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

        • account_product.post_promo_overview.post_promo_impl_am_len integer

          If applicable, post-promotional amortization length in cycles.

      • account_product.product_duration_information object
        • account_product.product_duration_information.promo_len integer

          The number of billing cycles from account origination during which accounts on this product are on a promotional period.

        • account_product.product_duration_information.promo_purchase_window_len integer

          If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

    • external_fields array[object]

      An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

      • external_fields.key string

        key: i.e. Name of the External Party

      • external_fields.value string

        value: i.e. External Account ID

    • min_pay_due_cents object
      • min_pay_due_cents.min_pay_cents Required / integer

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

      • min_pay_due_cents.min_pay_due_at Required / string(date-time)

        The Date-Time the payment for this billing cycle is due.

    • additional_min_pay_details object
      • additional_min_pay_details.min_pay_charges_principal_cents Required / integer

        Total principal due for the billing cycle.

      • additional_min_pay_details.min_pay_interest_cents Required / integer

        Total interest due for the billing cycle.

      • additional_min_pay_details.min_pay_deferred_cents Required / integer

        Total deferred interest due for the billing cycle.

      • additional_min_pay_details.min_pay_fees_cents Required / integer

        Total fees due for the billing cycle.

      • additional_min_pay_details.previous_min_pay_cents Required / integer

        Previous amounts due, including fees. This is a subset of min_pay_cents.

    • summary object
      • summary.total_balance_cents Required / integer

        The total balance (in cents) associated with the account.

      • summary.principal_cents Required / integer

        The total balance (in cents) associated with the account.

      • summary.interest_balance_cents Required / integer

        The total interest balance (in cents) associated with the account.

      • summary.deferred_interest_balance_cents integer

        The total deferred interest balance (in cents) associated with the account.

      • summary.total_paid_to_date_cents Required / integer

        The total sum of payments made to date (in cents) associated with the account.

      • summary.total_interest_paid_to_date_cents Required / integer

        The total sum of interest allocations for payments made to date (in cents) associated with the account.

      • summary.credit_limit_cents Required / integer

        Total Amount (in cents) that this account can borrow.

      • summary.max_approved_credit_limit_cents integer

        Total Amount (in cents) that this account can borrow.

      • summary.interest_rate_percent Required / number

        The percentage interest applied to the account (i.e. 6.2 means 6.2%)

      • summary.available_credit_cents integer

        The total available credit balance (in cents) for the account.

      • summary.open_to_buy_cents integer

        If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

    • associated_entities object
      • associated_entities.merchant_name string

        A merchant name associated with the account

      • associated_entities.lender_name string

        A lender name associated with the account

    • customers array[object]

      An array of customers who have been assigned to the account

      • customers.customer_id Required / integer

        A Canopy-generated unique ID for the customer

      • customers.name_prefix string

        Prefix to the customer's name

      • customers.name_first string

        Customer's first name

      • customers.name_middle string

        Customer's middle name

      • customers.name_last string

        Customer's last name

      • customers.name_suffix string

        Prefix to the customer's name

      • customers.phone_number string

        Phone number of the customer

      • customers.address_line_one string

        Address line one

      • customers.address_line_two string

        Address line two

      • customers.address_city string

        Address city

      • customers.address_state string

        Address state

      • customers.address_zip string

        Address zip code

      • customers.ssn string

        Social security number of the customer

      • customers.email string(email)

        The email address of this Customer

      • customers.date_of_birth string(date-time)

        Customer's date of birth

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Account not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/6 \ -H "Content-Type: application/json"
Response example (200)
{ "account_id": 9, "created_at": "2017-06-20T09:12:14+00:00", "effective_at": "2018-03-20T09:12:28+00:00", "account_overview": { "account_status": "suspended", "account_status_subtype": "suspended-bankruptcy" }, "account_product": { "product_id": 4, "external_product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45", "product_overview": { "product_name": "Blue Cash Express", "product_color": "#0000FF", "product_short_description": "Consumer credit card", "product_long_description": "Student credit card.", "product_time_zone": "America/Chicago", "product_type": "REVOLVING" }, "product_lifecycle": { "late_fee_impl_cents": 2900, "payment_reversal_fee_impl_cents": 2900, "loan_end_date": "2013-01-13T05:25:13.813+00:00" }, "promo_overview": { "promo_purchase_window_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_purchase_window_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "promo_impl_interest_rate_percent": 6.2 }, "post_promo_overview": { "post_promo_inclusive_start": "2013-01-13T05:25:13.813+00:00", "post_promo_exclusive_end": "2013-01-13T05:25:13.813+00:00", "post_promo_impl_interest_rate_percent": 6.2, "post_promo_impl_am_len": 48 }, "product_duration_information": { "promo_len": 6, "promo_purchase_window_len": 5 } }, "external_fields": [ { "key": "Umbrella Corporation", "value": "22445702-a389-431f-927d-07b8d0750787" } ], "min_pay_due_cents": { "min_pay_cents": 160000, "min_pay_due_at": "2019-10-18T23:04:48.321+00:00" }, "additional_min_pay_details": { "min_pay_charges_principal_cents": 100000, "min_pay_interest_cents": 30000, "min_pay_deferred_cents": 10000, "min_pay_fees_cents": 20000, "previous_min_pay_cents": 400000 }, "summary": { "total_balance_cents": 300000, "principal_cents": 200000, "interest_balance_cents": 60000, "deferred_interest_balance_cents": 40000, "total_paid_to_date_cents": 40000, "total_interest_paid_to_date_cents": 10000, "credit_limit_cents": 400000, "max_approved_credit_limit_cents": 400000, "interest_rate_percent": 3, "available_credit_cents": 100000, "open_to_buy_cents": 5000 }, "associated_entities": { "merchant_name": "Acme Corporation", "lender_name": "Globex Lending Corp" }, "customers": [ { "customer_id": 8, "name_prefix": "Dr.", "name_first": "Miriam", "name_middle": "Louise", "name_last": "Trevino", "name_suffix": "Jr", "phone_number": "555-555-5555", "address_line_one": "12 Strawberry Road", "address_line_two": "Suite 101", "address_city": "Atlanta", "address_state": "GA", "address_zip": "99999-1000", "ssn": "888-88-8888", "email": "marissa@protonmail.com", "date_of_birth": "2018-06-20T09:12:30+00:00" } ] }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Line items

Manage individual line items for your customers in Canopy.

Get line items for a specific account.

Line Items for an Account include charges to the account and payments by the account holder. Results are paginated and sorted by line item effective date.

URL parameters
  • account_id Required / integer

    Account ID

  • offset integer

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

  • limit integer

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

Responses
  • 200 array[object]

    Array of Line Items and their corresponding balances at their effective dates and times.

    • account_id Required / integer

      The account associated with the line item

    • line_item_id Required / integer

      The ID associated with the line item

    • effective_at Required / string(date-time)

      The Date-Time that this line item became/becomes active

    • created_at Required / string(date-time)

      The Date-Time which the line item was created.

    • product_id Required / integer

      the Product ID of the account

    • line_item_overview object
      • line_item_overview.line_item_status string

        the corresponding Status for a line item

        Values are VALID, INVALID, OFFSET, SPLIT_VALID, SPLIT_INVALID, PENDING, and REVERSED.

      • line_item_overview.line_item_type Required / string

        The Line Item Type. i.e. CHARGE, PAYMENT.

        Values are CHARGE, DEBIT_OFFSET, INTEREST, DEFERRED_INTEREST, PAYMENT, CREDIT_OFFSET, STATEMENT, MIN_DUE, FEE, PRODUCT_INTEREST, PAYMENT_SPLIT, LATE_FEE, RETURN_CHECK_FEE, PROMO_END, and PURCHASE_WINDOW_END.

      • line_item_overview.description string

        A description of this particular line item if any. More common for adjustments.

    • line_item_summary object
      • line_item_summary.original_amount_cents Required / integer

        The originating amount of money (in cents) relating to this line item.

      • line_item_summary.balance_cents Required / integer

        The current balance of the line item, which accounts for interest accrued per the product's interest policy and the account's interest rate attribute.

      • line_item_summary.principal_cents Required / integer

        The principal balance of the line item.

      • line_item_summary.total_interest_accrued_cents Required / integer

        The sum (in cents) of all interest charges, if any, applied to this line item

    • merchant_data object

      Merchant information if applicable.

      • merchant_data.name string
      • merchant_data.id string
      • merchant_data.mcc_code number
      • merchant_data.phone_number string
    • external_fields array[object]

      An array of static references to fields in a third party system.

      • external_fields.key string

        Key - i.e. Name of the External Party

      • external_fields.value string

        Value - i.e. External Account ID

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Line Items not found.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/line_items
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/4/line_items \ -H "Content-Type: application/json"
Response example (200)
[ { "account_id": 4, "line_item_id": 2, "effective_at": "2018-07-20T09:12:30+00:00", "created_at": "2018-06-20T09:12:30+00:00", "product_id": 1, "line_item_overview": { "line_item_status": "VALID", "line_item_type": "CHARGE", "description": "Refund for invalid purchase" }, "line_item_summary": { "original_amount_cents": 2484, "balance_cents": 2416, "principal_cents": 2400, "total_interest_accrued_cents": 16 }, "merchant_data": { "name": "string", "id": "string", "mcc_code": 42.0, "phone_number": "string" }, "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Get information on a specific line item for a specific account

URL parameters
  • account_id Required / integer

    Account ID

  • line_item_id Required / integer

    Line Item ID

Responses
  • 200 array[object]

    Array of Line Items where the last element is the root line item whose details were requested.

    • account_id Required / integer

      The account associated with the line item

    • line_item_id Required / integer

      The ID associated with the line item

    • effective_at Required / string(date-time)

      The Date-Time that this line item became/becomes active

    • created_at Required / string(date-time)

      The Date-Time which the line item was created.

    • product_id Required / integer

      the Product ID of the account

    • line_item_overview object
      • line_item_overview.line_item_status string

        the corresponding Status for a line item

        Values are VALID, INVALID, OFFSET, SPLIT_VALID, SPLIT_INVALID, PENDING, and REVERSED.

      • line_item_overview.line_item_type Required / string

        The Line Item Type. i.e. CHARGE, PAYMENT.

        Values are CHARGE, DEBIT_OFFSET, INTEREST, DEFERRED_INTEREST, PAYMENT, CREDIT_OFFSET, STATEMENT, MIN_DUE, FEE, PRODUCT_INTEREST, PAYMENT_SPLIT, LATE_FEE, RETURN_CHECK_FEE, PROMO_END, and PURCHASE_WINDOW_END.

      • line_item_overview.description string

        A description of this particular line item if any. More common for adjustments.

    • line_item_summary object
      • line_item_summary.original_amount_cents Required / integer

        The originating amount of money (in cents) relating to this line item.

      • line_item_summary.balance_cents Required / integer

        The current balance of the line item, which accounts for interest accrued per the product's interest policy and the account's interest rate attribute.

      • line_item_summary.principal_cents Required / integer

        The principal balance of the line item.

      • line_item_summary.total_interest_accrued_cents Required / integer

        The sum (in cents) of all interest charges, if any, applied to this line item

    • merchant_data object

      Merchant information if applicable.

      • merchant_data.name string
      • merchant_data.id string
      • merchant_data.mcc_code number
      • merchant_data.phone_number string
    • external_fields array[object]

      An array of static references to fields in a third party system.

      • external_fields.key string

        Key - i.e. Name of the External Party

      • external_fields.value string

        Value - i.e. External Account ID

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Line Items not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/line_items/{line_item_id}
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/4/line_items/8 \ -H "Content-Type: application/json"
Response example (200)
[ { "account_id": 4, "line_item_id": 2, "effective_at": "2018-07-20T09:12:30+00:00", "created_at": "2018-06-20T09:12:30+00:00", "product_id": 1, "line_item_overview": { "line_item_status": "VALID", "line_item_type": "CHARGE", "description": "Refund for invalid purchase" }, "line_item_summary": { "original_amount_cents": 2484, "balance_cents": 2416, "principal_cents": 2400, "total_interest_accrued_cents": 16 }, "merchant_data": { "name": "string", "id": "string", "mcc_code": 42.0, "phone_number": "string" }, "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Create a charge for a specific account

URL parameters
  • account_id Required / integer

    Account ID

Body
  • original_amount_cents Required / integer

    The Integer Amount of the Charge in Cents

  • effective_at string(date-time)

    The Date-Time that the charge should be recorded to the account. Although the charge is being added to Canopy today, it can actually be effective as of 10 days ago.

  • merchant_data Required / object
    • merchant_data.name string
    • merchant_data.id string
    • merchant_data.mcc_code Required / number
    • merchant_data.phone_number string
  • external_fields array[object]

    An array of static references to fields in a third party system.

    • external_fields.key string

      Key - i.e. Name of the External Party

    • external_fields.value string

      Value - i.e. External Account ID

Responses
  • 200 object

    Charge Created

    • account_id Required / integer

      The account associated with the line item

    • line_item_id Required / integer

      The ID associated with the line item

    • effective_at Required / string(date-time)

      The Date-Time that this line item became/becomes active

    • created_at Required / string(date-time)

      The Date-Time which the line item was created.

    • product_id Required / integer

      the Product ID of the account

    • line_item_overview object
      • line_item_overview.line_item_status Required / string

        the corresponding Status for a line item

        Values are VALID, INVALID, OFFSET, SPLIT_VALID, SPLIT_INVALID, PENDING, and REVERSED.

      • line_item_overview.line_item_type Required / string

        The Line Item Type. i.e. CHARGE, PAYMENT.

        Values are CHARGE, DEBIT_OFFSET, INTEREST, DEFERRED_INTEREST, PAYMENT, CREDIT_OFFSET, STATEMENT, MIN_DUE, FEE, PRODUCT_INTEREST, PAYMENT_SPLIT, LATE_FEE, RETURN_CHECK_FEE, PROMO_END, and PURCHASE_WINDOW_END.

      • line_item_overview.description string

        A description of this particular line item if any. More common for adjustments.

    • line_item_summary object
      • line_item_summary.original_amount_cents Required / integer

        The originating amount of money (in cents) relating to this line item.

    • merchant_data object

      Merchant information if applicable.

      • merchant_data.name string
      • merchant_data.id string
      • merchant_data.mcc_code number
      • merchant_data.phone_number string
    • external_fields array[object]

      An array of static references to fields in a third party system.

      • external_fields.key string

        Key - i.e. Name of the External Party

      • external_fields.value string

        Value - i.e. External Account ID

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/accounts/{account_id}/line_items/charges
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/accounts/11/line_items/charges \ -H "Content-Type: application/json" \ -d '{"original_amount_cents":200,"effective_at":"2020-07-20T09:11:28+00:00","merchant_data":{"name":"string","id":"string","mcc_code":42.0,"phone_number":"string"},"external_fields":[{"key":"Globex Card Processing Account ID","value":"22445702-a389-431f-927d-07b8d0750787"}]}'
Request payload example
{ "original_amount_cents": 200, "effective_at": "2020-07-20T09:11:28+00:00", "merchant_data": { "name": "string", "id": "string", "mcc_code": 42.0, "phone_number": "string" }, "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] }
Response example (200)
{ "account_id": 4, "line_item_id": 2, "effective_at": "2018-07-20T09:12:30+00:00", "created_at": "2018-06-20T09:12:30+00:00", "product_id": 158, "line_item_overview": { "line_item_status": "VALID", "line_item_type": "CHARGE", "description": "Refund for invalid purchase" }, "line_item_summary": { "original_amount_cents": 2484 }, "merchant_data": { "name": "string", "id": "string", "mcc_code": 42.0, "phone_number": "string" }, "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Create a payment for a specific account

URL parameters
  • account_id Required / integer

    Account ID

Body
  • original_amount_cents Required / integer

    The Integer Amount of the Payment in Cents

  • effective_at string(date-time)

    The Date-Time that the payment should be recorded to the account. Although the payment is being added to Canopy today, it can actually be effective as of 10 days ago.

  • external_fields array[object]

    An array of static references to fields in a third party system.

    • external_fields.key string

      Key - i.e. Name of the External Party

    • external_fields.value string

      Value - i.e. External Account ID

Responses
  • 200 object

    Payment Created

    • account_id Required / integer

      The account associated with the line item

    • line_item_id Required / integer

      The ID associated with the line item

    • effective_at Required / string(date-time)

      The Date-Time that this line item became/becomes active

    • created_at Required / string(date-time)

      The Date-Time which the line item was created.

    • product_id Required / integer

      the Product ID of the account

    • line_item_overview object
      • line_item_overview.line_item_status Required / string

        the corresponding Status for a line item

        Values are VALID, INVALID, OFFSET, SPLIT_VALID, SPLIT_INVALID, PENDING, and REVERSED.

      • line_item_overview.line_item_type Required / string

        The Line Item Type. i.e. CHARGE, PAYMENT.

        Values are CHARGE, DEBIT_OFFSET, INTEREST, DEFERRED_INTEREST, PAYMENT, CREDIT_OFFSET, STATEMENT, MIN_DUE, FEE, PRODUCT_INTEREST, PAYMENT_SPLIT, LATE_FEE, RETURN_CHECK_FEE, PROMO_END, and PURCHASE_WINDOW_END.

      • line_item_overview.description string

        A description of this particular line item if any. More common for adjustments.

    • line_item_summary object
      • line_item_summary.original_amount_cents Required / integer

        The originating amount of money (in cents) relating to this line item.

    • merchant_data object

      Merchant information if applicable.

      • merchant_data.name string
      • merchant_data.id string
      • merchant_data.mcc_code number
      • merchant_data.phone_number string
    • external_fields array[object]

      An array of static references to fields in a third party system.

      • external_fields.key string

        Key - i.e. Name of the External Party

      • external_fields.value string

        Value - i.e. External Account ID

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/accounts/{account_id}/line_items/payments
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/accounts/4/line_items/payments \ -H "Content-Type: application/json" \ -d '{"original_amount_cents":200,"effective_at":"2020-07-20T09:11:28+00:00","external_fields":[{"key":"Globex Card Processing Account ID","value":"22445702-a389-431f-927d-07b8d0750787"}]}'
Request payload example
{ "original_amount_cents": 200, "effective_at": "2020-07-20T09:11:28+00:00", "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] }
Response example (200)
{ "account_id": 4, "line_item_id": 2, "effective_at": "2018-07-20T09:12:30+00:00", "created_at": "2018-06-20T09:12:30+00:00", "product_id": 158, "line_item_overview": { "line_item_status": "VALID", "line_item_type": "CHARGE", "description": "Refund for invalid purchase" }, "line_item_summary": { "original_amount_cents": 2484 }, "merchant_data": { "name": "string", "id": "string", "mcc_code": 42.0, "phone_number": "string" }, "external_fields": [ { "key": "Globex Card Processing Account ID", "value": "22445702-a389-431f-927d-07b8d0750787" } ] }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Notes

Help your customer service team track its activity across accounts.

Get All Notes for a specific Account

URL parameters
  • account_id Required / integer

    Account ID

Responses
  • 200 array[object]

    Successful query of history of notes for a specific account

    • note_id Required / integer

      A Canopy-generated unique ID for the note

    • account_id Required / integer

      The ID of the account to which the Note is assigned

    • author Required / object

      The API User who authored the note

      • author.api_user_id Required / integer

        The unique ID in Canopy for this API user

      • author.organization_name Required / string

        The organization to which the API user belongs.

      • author.name_first string

        The first name of the API user.

      • author.name_last string

        The last name of the API user.

      • author.email Required / string(email)

        The email address of this API User

      • author.phone string

        Phone number of the API user

      • author.role Required / string

        The role of this user in the API

        Values are SERVICING, OPERATIONS, and ADMIN.

    • message Required / string

      The contents of the note.

    • created_date Required / string(date-time)

      The date and time the note was created.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Note not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/notes
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/6/notes \ -H "Content-Type: application/json"
Response example (200)
[ { "note_id": 1, "account_id": 1, "author": { "api_user_id": 23, "organization_name": "Lever Card 3000", "name_first": "Analise", "name_last": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING" }, "message": "Attempted to call back customer, but no response.", "created_date": "2021-05-04T09:42:00+00:00" } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Create a note for a specific account.

A note to be added to the account.

URL parameters
  • account_id Required / integer

    Account ID

Body
  • message Required / string

    The contents of the note.

Responses
  • 200 object

    New Note Created

    • note_id Required / integer

      A Canopy-generated unique ID for the note

    • account_id Required / integer

      The ID of the account to which the Note is assigned

    • author Required / object

      The API User who authored the note

      • author.api_user_id Required / integer

        The unique ID in Canopy for this API user

      • author.organization_name Required / string

        The organization to which the API user belongs.

      • author.name_first string

        The first name of the API user.

      • author.name_last string

        The last name of the API user.

      • author.email Required / string(email)

        The email address of this API User

      • author.phone string

        Phone number of the API user

      • author.role Required / string

        The role of this user in the API

        Values are SERVICING, OPERATIONS, and ADMIN.

    • message Required / string

      The contents of the note.

    • created_date Required / string(date-time)

      The date and time the note was created.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/accounts/{account_id}/notes
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/accounts/5/notes \ -H "Content-Type: application/json" \ -d '{"message":"Attempted to call back customer, but no response."}'
Request payload example
{ "message": "Attempted to call back customer, but no response." }
Response example (200)
{ "note_id": 1, "account_id": 1, "author": { "api_user_id": 23, "organization_name": "Lever Card 3000", "name_first": "Analise", "name_last": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING" }, "message": "Attempted to call back customer, but no response.", "created_date": "2021-05-04T09:42:00+00:00" }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Statements

Generate per billing cycle statements for your accounts in Canopy.

Get a list of all current and prior statements for a specific account

List of statements for the account. To view line items for a specific statement, use the /accounts/{account_id}/statements route

URL parameters
  • account_id Required / integer

    Account ID

  • offset integer

    The zero-indexed starting point for paginated statements list requests sorted by reverse statement date.

  • limit integer

    The maximum number of accounts to be returned. Defaults to 100.

Responses
  • 200 array[object]
    • account_id Required / integer

      The Canopy-generated ID for the account

    • statement_id Required / integer

      The Canopy-generated ID for the statement

    • effective_as_of_date Required / string(date-time)

      The Date-Time you would like the system to return the data as of. IE tell me what the account information was as if I had asked on 2020-10-20 00:00:00 EST. If empty it defaults to current time.

    • cycle_summary object
      • cycle_summary.cycle_inclusive_start Required / string(date-time)

        The inclusive starting Date-Time that defines which transations are part of this statement.

      • cycle_summary.cycle_exclusive_end Required / string(date-time)

        The inclusive ending Date-Time that defines which transations are part of this statement.

    • min_pay_due_cents object
      • min_pay_due_cents.min_pay_cents Required / integer

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

      • min_pay_due_cents.min_pay_due_at Required / string(date-time)

        The Date-Time the payment for this billing cycle is due.

    • balance_summary object
      • balance_summary.total_balance_cents Required / integer

        The total balance (in cents) associated with the account.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Statements not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/statements/list
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/{account_id}/statements/list \ -H "Content-Type: application/json"
Response example (200)
[ { "account_id": 6, "statement_id": 8, "effective_as_of_date": "2018-07-20T09:10:14+00:00", "cycle_summary": { "cycle_inclusive_start": "2021-05-04T09:42:00+00:00", "cycle_exclusive_end": "2021-05-04T09:42:00+00:00" }, "min_pay_due_cents": { "min_pay_cents": 160000, "min_pay_due_at": "2019-10-18T23:04:48.321+00:00" }, "balance_summary": { "total_balance_cents": 400000 } } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Get a specific statement for a specific account.

This will return a statement that corresponds with the passed Statement ID. Relevant IDs for an account's historical statements can be obtained from the accounts/{account_id}/statements/list route.

URL parameters
  • account_id Required / integer

    Account ID

  • statement_id Required / string(date-time)

    The ID of a specific statement you would like returned.

Responses
  • 200 object
    • account_id Required / integer

      The Canopy-generated ID for the account

    • statement_id Required / integer

      The Canopy-generated ID for the statement

    • effective_as_of_date Required / string(date-time)

      The Date-Time you would like the system to return the data as of. IE tell me what the account information was as if I had asked on 2020-10-20 00:00:00 EST. If empty it defaults to current time.

    • account_overview object
      • account_overview.promo_purchase_window_inclusive_start string(date-time)

        If applicable, the Date-Time the purchase window for the account ends.

      • account_overview.promo_purchase_window_exclusive_end string(date-time)

        If applicable, the Date-Time the purchase window for the account ends.

      • account_overview.promo_inclusive_start string(date-time)

        If applicable, the Date-Time the promo period for the account starts.

      • account_overview.promo_exclusive_end string(date-time)

        If applicable, the Date-Time the promo period for the account ends.

      • account_overview.account_status string

        The Status of the Account. Active upon account creation.

      • account_overview.account_status_subtype string

        The subtype of the Status of the Account. Null upon account creation.

    • open_to_buy object
      • open_to_buy.credit_limit_cents integer

        Total Amount (in cents) that this account can borrow.

      • open_to_buy.total_charges_cents integer

        Sum of all charges that occurred on the account since account origination.

      • open_to_buy.available_credit_cents integer

        The total available credit balance (in cents) for the account.

      • open_to_buy.open_to_buy_cents integer

        If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

    • cycle_summary object
      • cycle_summary.cycle_inclusive_start string(date-time)

        The inclusive starting Date-Time that defines which transations are part of this statement.

      • cycle_summary.cycle_exclusive_end string(date-time)

        The inclusive ending Date-Time that defines which transations are part of this statement.

      • cycle_summary.cycle_charges_cents integer

        Sum of all charges that occurred on the account during the billing cycle.

      • cycle_summary.cycle_loans_cents integer

        Sum of all loans amounts that were initiated on the account during the billing cycle.

      • cycle_summary.cycle_charge_returns_cents integer

        Sum of all returns that occurred on the account during the billing cycle.

      • cycle_summary.cycle_payments_cents integer

        Sum of all payments that occurred on the account during the billing cycle.

      • cycle_summary.cycle_payment_reversals_cents integer

        Sum of all payment reversal amounts that occurred on the account during the billing cycle.

      • cycle_summary.cycle_debit_adjustments_cents integer

        Sum of all debit adjustment amounts that occurred on the account during the billing cycle.

      • cycle_summary.cycle_credit_adjustments_cents integer

        Sum of all credit adjustment amounts that occurred on the account during the billing cycle.

      • cycle_summary.cycle_interest_cents integer

        Total interest accrued during the billing cycle.

      • cycle_summary.cycle_deferred_interest_cents integer

        Total interest accrued during the billing cycle.

      • cycle_summary.cycle_late_fees_cents integer

        Total late fees incurred during the billing cycle.

      • cycle_summary.cycle_payment_reversals_fees_cents integer

        Total payment reversal fees incurred during the billing cycle.

      • cycle_summary.cycle_forgiven_deferred_interest_cents integer

        Total deferred interest that was forgiven on the account during the billing cycle.

    • min_pay_due object
      • min_pay_due.min_pay_cents Required / integer

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

      • min_pay_due.min_pay_due_at Required / string(date-time)

        The Date-Time the payment for this billing cycle is due.

    • additional_min_pay_details object
      • additional_min_pay_details.min_pay_charges_principal_cents Required / integer

        Total principal due for the billing cycle.

      • additional_min_pay_details.min_pay_interest_cents Required / integer

        Total interest due for the billing cycle.

      • additional_min_pay_details.min_pay_deferred_cents Required / integer

        Total deferred interest due for the billing cycle.

      • additional_min_pay_details.min_pay_fees_cents Required / integer

        Total fees due for the billing cycle.

      • additional_min_pay_details.previous_min_pay_cents Required / integer

        Previous amounts due, including fees. This is a subset of min_pay_cents.

    • balance_summary object
      • balance_summary.charges_principal_cents integer

        Total principal balance for the account.

      • balance_summary.loans_principal_cents integer

        Total principal balance for loans for the account.

      • balance_summary.interest_balance_cents integer

        Total interest balance for the account.

      • balance_summary.deferred_interest_balance_cents integer

        Total deferred interest balance for the account.

      • balance_summary.fees_balance_cents integer

        Total fee balance for the account.

      • balance_summary.total_balance_cents integer

        The total balance (in cents) associated with the account.

    • payoff object
      • payoff.total_payoff_cents integer

        The total amount slated to pay off the account over the lifecycle of the loan.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Statement not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/statements/{statement_id}
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/2/statements/{statement_id} \ -H "Content-Type: application/json"
Response example (200)
{ "account_id": 6, "statement_id": 8, "effective_as_of_date": "2018-07-20T09:10:14+00:00", "account_overview": { "promo_purchase_window_inclusive_start": "2015-08-31T10:49:44.461+00:00", "promo_purchase_window_exclusive_end": "2015-08-31T10:49:44.461+00:00", "promo_inclusive_start": "2015-08-31T10:49:44.461+00:00", "promo_exclusive_end": "2015-08-31T10:49:44.461+00:00", "account_status": "suspended", "account_status_subtype": "suspended-bankruptcy" }, "open_to_buy": { "credit_limit_cents": 400000, "total_charges_cents": 800000, "available_credit_cents": 600000, "open_to_buy_cents": 600000 }, "cycle_summary": { "cycle_inclusive_start": "2021-05-04T09:42:00+00:00", "cycle_exclusive_end": "2021-05-04T09:42:00+00:00", "cycle_charges_cents": 700000, "cycle_loans_cents": 700000, "cycle_charge_returns_cents": 100000, "cycle_payments_cents": 200000, "cycle_payment_reversals_cents": 200000, "cycle_debit_adjustments_cents": 40000, "cycle_credit_adjustments_cents": 53000, "cycle_interest_cents": 110000, "cycle_deferred_interest_cents": 300000, "cycle_late_fees_cents": 300000, "cycle_payment_reversals_fees_cents": 300000, "cycle_forgiven_deferred_interest_cents": 40000 }, "min_pay_due": { "min_pay_cents": 160000, "min_pay_due_at": "2019-10-18T23:04:48.321+00:00" }, "additional_min_pay_details": { "min_pay_charges_principal_cents": 100000, "min_pay_interest_cents": 30000, "min_pay_deferred_cents": 10000, "min_pay_fees_cents": 20000, "previous_min_pay_cents": 400000 }, "balance_summary": { "charges_principal_cents": 900000, "loans_principal_cents": 900000, "interest_balance_cents": 100000, "deferred_interest_balance_cents": 700000, "fees_balance_cents": 700000, "total_balance_cents": 400000 }, "payoff": { "total_payoff_cents": 1100000 } }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Amortization schedule

Get Amortization information for installment loans.

Get the amortization schedule for a specific loan

URL parameters
  • account_id Required / integer

    Account ID

  • 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 Required / integer

      The ID of this generated amortization schedule.

    • cycle_exclusive_end Required / string(date-time)

      The date-time the am cycle ends.

    • min_pay_due_at Required / string(date-time)

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

    • am_min_pay_cents Required / number

      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 Required / number

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

    • am_interest_cents Required / number

      The amount in cents allocated to interest from this am payment

    • am_deferred_cents Required / number

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

    • am_principal_cents Required / number

      The amount in cents allocated to principal from this am payment

    • am_start_total_balance_cents Required / number

      The starting balance on the loan before this payment

    • am_end_total_balance_cents Required / number

      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.

Definition
GET https://sandbox.canopyservicing.com/accounts/{account_id}/amortization_schedule
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/accounts/5/amortization_schedule \ -H "Content-Type: application/json"
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_start_total_balance_cents": 136691, "am_end_total_balance_cents": 136691, "paid_on_time": false } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Authentication

Get all API users in your organization

Returns a list of all API users in your organization.

Responses
  • 200 array[object]

    Array of API Users

    • api_user_id Required / integer

      The unique ID in Canopy for this API user

    • organization_name Required / string

      The organization to which the API user belongs.

    • name_first string

      The first name of the API user.

    • name_last string

      The last name of the API user.

    • email Required / string(email)

      The email address of this API User

    • phone string

      Phone number of the API user

    • role Required / string

      The role of this user in the API

      Values are SERVICING, OPERATIONS, and ADMIN.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    No Api Users found

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/api_users
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/api_users \ -H "Content-Type: application/json"
Response example (200)
[ { "api_user_id": 23, "organization_name": "Lever Card 3000", "name_first": "Analise", "name_last": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING" } ]
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Invite a new API user to Canopy

When you create a new API user via this POST request, an email invite will be sent for the new user to join your organization. The email invite includes a link with a unique token that will allow the new user to register to join your team in Canopy.

Body
  • role Required / number

    A role to be made accessible for the user. Contact our team for a full list of options.

  • email Required / string(email)

    The email address of this API User

Responses
  • 200 object

    Successfully invited a new user

    • email Required / string(email)

      The email address of this API User

    • created_at Required / string(date-time)

      The Date-Time which the invitation was created in the API

    • expires_at Required / string(date-time)

      The Date-Time which the invitation expires

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/api_users
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/api_users \ -H "Content-Type: application/json" \ -d '{"role":3,"email":"marissa@globex.com"}'
Request payload example
{ "role": 3, "email": "marissa@globex.com" }
Response example (200)
{ "email": "marissa@globex.com", "created_at": "2018-06-20T09:12:30+00:00", "expires_at": "2018-06-21T09:12:30+00:00" }
Response example (401)
No content
Response example (403)
No content
Response example (422)
No content
Response example (429)
No content
Response example (default)
No content

Log in as an API user

When provided appropriate credentials, this route signs in an API user.

Body
  • email Required / string(email)

    The email address of the API User logging in.

  • password Required / string

    The password of the user logging in.

Responses
  • 200 object

    Successfully logged in as an API user

    • api_user_id Required / string

      The unique ID in Canopy for this API user

    • organization_name Required / string

      The organization to which the API user belongs.

    • first_name string

      The first name of the API user.

    • last_name string

      The last name of the API user.

    • email Required / string(email)

      The email address of this API User

    • phone string

      Phone number of the API user

    • role Required / string

      The role of this user in the API

      Values are SERVICING, OPERATIONS, and ADMIN.

    • token Required / string

      The unique token to be included as an x-api-key header in all subsequent requests as this user.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Not found.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
POST https://sandbox.canopyservicing.com/api_users/login
cURL example
curl \ -X POST https://sandbox.canopyservicing.com/api_users/login \ -H "Content-Type: application/json" \ -d '{"email":"marissa@globex.com","password":"secretPassword123!"}'
Request payload example
{ "email": "marissa@globex.com", "password": "secretPassword123!" }
Response example (200)
{ "api_user_id": "44197ea2-eb78-4511-bcf2-bc28201f9c01", "organization_name": "Lever Card 3000", "first_name": "Analise", "last_name": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING", "token": "string" }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Update the password for an API User

When provided appropriate credentials, this route changes an API User's password.

Body
  • current_password Required / string

    The password of the user changing their password.

  • new_password Required / string

    The new password of the user changing their password.

  • token Required / string

    A unique token included in Canopy's reset password email.

Responses
  • 200 object

    Successfully logged in as an API user

    • api_user_id Required / string

      The unique ID in Canopy for this API user

    • organization_name Required / string

      The organization to which the API user belongs.

    • first_name string

      The first name of the API user.

    • last_name string

      The last name of the API user.

    • email Required / string(email)

      The email address of this API User

    • phone string

      Phone number of the API user

    • role Required / string

      The role of this user in the API

      Values are SERVICING, OPERATIONS, and ADMIN.

    • token Required / string

      The unique token to be included as an x-api-key header in all subsequent requests as this user.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Not found.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
PUT https://sandbox.canopyservicing.com/api_users/password
cURL example
curl \ -X PUT https://sandbox.canopyservicing.com/api_users/password \ -H "Content-Type: application/json" \ -d '{"current_password":"currentSecretPassword123!","new_password":"newSecretPassword123!","token":"string"}'
Request payload example
{ "current_password": "currentSecretPassword123!", "new_password": "newSecretPassword123!", "token": "string" }
Response example (200)
{ "api_user_id": "44197ea2-eb78-4511-bcf2-bc28201f9c01", "organization_name": "Lever Card 3000", "first_name": "Analise", "last_name": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING", "token": "string" }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Complete registration for an invited API user

When provided appropriate credentials, this route updates an API user's information for registration.

Body
  • email_confirm Required / string(email)

    The email address of the user being updated.

  • new_password Required / string

    The new password of the API user.

  • name_first Required / string

    The first name of the API user.

  • name_last Required / string

    The last name of the API user.

  • phone Required / string

    The phone number to add to the API User's information.

  • token Required / string

    A unique token included in Canopy's register user email.

Responses
  • 200 object

    API user successfully registered

    • api_user_id Required / integer

      The unique ID in Canopy for this API user

    • organization_name Required / string

      The organization to which the API user belongs.

    • name_first string

      The first name of the API user.

    • name_last string

      The last name of the API user.

    • email Required / string(email)

      The email address of this API User

    • phone string

      Phone number of the API user

    • role Required / string

      The role of this user in the API

      Values are SERVICING, OPERATIONS, and ADMIN.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Not found.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
PUT https://sandbox.canopyservicing.com/api_users/register
cURL example
curl \ -X PUT https://sandbox.canopyservicing.com/api_users/register \ -H "Content-Type: application/json" \ -d '{"email_confirm":"harriet@acmecorporation.com","new_password":"newSecretPassword123!","name_first":"Karl","name_last":"Martins","phone":"1-222-222-2222","token":"string"}'
Request payload example
{ "email_confirm": "harriet@acmecorporation.com", "new_password": "newSecretPassword123!", "name_first": "Karl", "name_last": "Martins", "phone": "1-222-222-2222", "token": "string" }
Response example (200)
{ "api_user_id": 23, "organization_name": "Lever Card 3000", "name_first": "Analise", "name_last": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING" }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content

Get summary info for an API user

Get all summarized information pertaining to the API user making the request.

Responses
  • 200 object

    API User

    • api_user_id Required / integer

      The unique ID in Canopy for this API user

    • organization_name Required / string

      The organization to which the API user belongs.

    • name_first string

      The first name of the API user.

    • name_last string

      The last name of the API user.

    • email Required / string(email)

      The email address of this API User

    • phone string

      Phone number of the API user

    • role Required / string

      The role of this user in the API

      Values are SERVICING, OPERATIONS, and ADMIN.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    No API user found.

  • 429

    Too many requests.

  • default

    Unexpected Error.

Definition
GET https://sandbox.canopyservicing.com/api_users/summary
cURL example
curl \ -X GET https://sandbox.canopyservicing.com/api_users/summary \ -H "Content-Type: application/json"
Response example (200)
{ "api_user_id": 23, "organization_name": "Lever Card 3000", "name_first": "Analise", "name_last": "Goldberg", "email": "marissa@globex.com", "phone": "1-123-456-7890", "role": "SERVICING" }
Response example (401)
No content
Response example (403)
No content
Response example (404)
No content
Response example (429)
No content
Response example (default)
No content