Canopy Servicing Core API - Latest
1.8.11

Base URL

https://sandbox-api.canopyservicing.com

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 version 1.8.11 of this API documentation. Last update on Feb 3, 2022.

Getting Started

Get started in three easy steps.

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

2) Create your own credentials in our public sandbox.

3) Follow the onboarding steps once you've logged into the public sandbox.

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, register for our public sandbox. You can find a full guide to authenticating in Canopy in our developer onboarding tutorial.

Troubleshooting

See a detailed overview of error codes supported by Canopy and their meanings.

Test it out

To get going quickly, we recommend using an API collaboration tool called Postman. You can use the buttons below to import our public collections, which point to our public test environment and already has our API endpoints configured. Be sure to define the required environment variables before sending requests.

If you'd just like to get set up with Canopy and send some requests with pre-populated sample data, we recommend using our Quickstart collection.

Our Use Cases collection contains some workflows that help demonstrate how our API serves business needs today.

When you'd like to start applying some business logic and try formulating what your actual implementation looks like, our Canopy API collection contains examples of all our API calls.

Once you've explored our public sandbox and formulated your business model, contact us to start the conversation on integrating Canopy with your business.

Quickstart:

Use Cases:

Canopy API:

Pagination

Canopy uses a two-factor basis to drive the order of responses in GET requests with an array of results. They are first ordered by effective_at by when the entity is effective in the system, and second by an internal index to make sure the order is always universal. From the caller's perspective, you can let Canopy know where to start its pagination response by providing a starting_after or ending_before string value. If neither a starting_after nor ending_before value is provided, we'll assume you're requesting the very first page of responses. In subsequent requests, you can simply grab these values from the paging key in the response body from your previous request. If you're aiming to provide your users with a link to the previous page, use the ending_before query parameter in your next request. If going to the next page, use the starting_after value instead.

Document Versioning

Canopy currently supports two methods of identifying resources in our API endpoints. Please see your organization's features for which document describes your implementation. If strict_entity_client_id = true, then see our latest documentation here. Otherwise, please see our legacy documentation here

Get all API users in your organization

GET /api_users

O auth2

Returns a list of all API users in your organization.

Responses

200 application/json

Array of API Users
Hide response attributes Show response attributes object
- api_user_id string Required
  
  The unique ID in Canopy for this API user
- organization_name string Required
  
  The organization to which the API user belongs.
- name_first string Required
  
  The first name of the API user.
- name_last string Required
  
  The last name of the API user.
- email string(email) Required
  
  The email address of this API User
- phone string | null
  
  Phone number of the API user
- role integer Required
  
  The role of this user in the API
401

Unauthorized.
403

Forbidden.
404

No Api Users found
429

Too many requests.
default

Unexpected Error.

GET /api_users

curl \
 --request GET 'https://sandbox-api.canopyservicing.com/api_users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
    "organization_name": "Lever Card 3000",
    "name_first": "Analise",
    "name_last": "Goldberg",
    "email": "marissa@globex.com",
    "phone": "1-123-456-7890",
    "role": 1
  }
]

Invite a new API user to Canopy

POST /api_users

O auth2

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.

application/json

Body Required

Body of request to invite new API user. Checks permissions of invite-creator.

role number Required

Assign a role to users to dictate permissions and API access level . Contact our team for a full list of options.

Default value is 1.
email string(email) Required

The email address of this API User.
name_first string Required

The first name of the API User.
name_last string Required

The last name of the API User.
phone string

Phone number of API user

Responses

200 application/json

Successfully invited a new user
Hide response attribute Show response attribute object
- status string Required
  
  Result of API user creation request
401

Unauthorized.
403

Forbidden.
422

Invalid input.
429

Too many requests.
default

Unexpected Error.

POST /api_users

curl \
 --request POST 'https://sandbox-api.canopyservicing.com/api_users' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"role":3,"email":"marissa@globex.com","name_first":"John","name_last":"Doe","phone":"1-234-567-8900"}'

Request examples

{
  "role": 3,
  "email": "marissa@globex.com",
  "name_first": "John",
  "name_last": "Doe",
  "phone": "1-234-567-8900"
}

Response examples (200)

{
  "status": "success"
}

Register a new organization and user

POST /register

O auth2

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

application/json

Body Required

Provide valid credentials, this route updates an API User's password.

name_first string Required

The first name of the API user.
name_last string Required

The last name of the API user.
password string

The new password of the API user.
email string(email) Required

The email address of the API user
organization_name string Required

The organization name

Responses

200 application/json

API user successfully registered
Hide response attributes Show response attributes object
- api_user_id string Required
  
  The unique ID in Canopy for this API user
- organization_name string Required
  
  The organization to which the API user belongs.
- name_first string Required
  
  The first name of the API user.
- name_last string Required
  
  The last name of the API user.
- email string(email) Required
  
  The email address of this API User
- phone string | null
  
  Phone number of the API user
- role integer Required
  
  The role of this user in the API
401

Unauthorized.
403

Forbidden.
404

Not found.
429

Too many requests.
default

Unexpected Error.

POST /register

curl \
 --request POST 'https://sandbox-api.canopyservicing.com/register' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name_first":"Harriet","name_last":"Martins","password":"newSecretPassword123!","email":"harriet@acmecorporation.com","organization_name":"Acme Corporation"}'

Request examples

{
  "name_first": "Harriet",
  "name_last": "Martins",
  "password": "newSecretPassword123!",
  "email": "harriet@acmecorporation.com",
  "organization_name": "Acme Corporation"
}

Response examples (200)

{
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "marissa@globex.com",
  "phone": "1-123-456-7890",
  "role": 1
}

Get summary info for an API user

GET /api_users/summary

O auth2

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

Responses

200 application/json

API User
Hide response attributes Show response attributes object
- api_user_id string Required
  
  The unique ID in Canopy for this API user
- organization_name string Required
  
  The organization to which the API user belongs.
- name_first string Required
  
  The first name of the API user.
- name_last string Required
  
  The last name of the API user.
- email string(email) Required
  
  The email address of this API User
- phone string | null
  
  Phone number of the API user
- role integer Required
  
  The role of this user in the API
401

Unauthorized.
403

Forbidden.
404

No API user found.
429

Too many requests.
default

Unexpected Error.

GET /api_users/summary

curl \
 --request GET 'https://sandbox-api.canopyservicing.com/api_users/summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "marissa@globex.com",
  "phone": "1-123-456-7890",
  "role": 1
}

Get all available products

GET /products

O auth2

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

Query parameters

limit integer

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

Minimum value is 0, maximum value is 100.
starting_after string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.
ending_before string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

Responses

200 application/json

Array of Products
Hide response attribute Show response attribute object
- results array[object] | null Required
  
  An array of information for all products within the requested range.
  
  Not more than 100 elements.
  
  Hide results attributes Show results attributes object
  
  product_id string Required
  
  A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
  
  created_at 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.
  
  product_overview object Required
  
  A series of static fields about the product.
  
  Hide product_overview attributes Show product_overview attributes object
  
  product_name string Required
  
  Name of Product, i.e. Express Card.
  
  product_type string Required
  
  The Type of Product
  
  product_short_description string | null
  
  A short description of the product ranging from 0 - 60 characters.
  
  product_long_description string | null Required
  
  Description of the Product ranging from 0 - 1000.
  
  product_color string
  
  A color to be associated with the product for UI purposes.
  
  Default value is #4867FF.
  
  external_fields array[object] | null
  
  Not more than 1000 elements.
  
  Hide external_fields attributes Show external_fields attributes object
  
  key string
  
  value string
  
  product_lifecycle_policies object Required
  
  Hide product_lifecycle_policies attributes Show product_lifecycle_policies attributes object
  
  payment_due_policies object
  
  The set of policies governing payment due information for the product.
  
  Hide payment_due_policies attributes Show payment_due_policies attributes object
  
  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
  
  Default value is 1.
  
  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
  
  Default value is 2.
  
  payment_pouring_policies object
  
  The set of policies governing payment pouring information for the product.
  
  Hide payment_pouring_policies attribute Show payment_pouring_policies attribute object
  
  pending_pmt_affects_avail_credit boolean
  
  Indicates whether pending payments affect available credit.
  
  Default value is false.
  
  fee_policies object
  
  The set of policies governing fees for the product.
  
  Hide fee_policies attributes Show fee_policies attributes object
  
  late_fee_grace string
  
  Amount of time between when a payment is due and when a late fee is assessed if no payments have been made.
  
  Default value is 5 days.
  
  surcharge_fee_interval string | null
  
  The interval at which a surcharge fee is assessed.
  
  default_surcharge_fee_structure array[object] | null
  
  The transaction volume structure that dictates a transaction fee.
  
  Hide default_surcharge_fee_structure attributes Show default_surcharge_fee_structure attributes object
  
  surcharge_start_inclusive_cents integer Required
  
  Indicates the starting transaction volume at which this fee will apply.
  
  surcharge_end_exclusive_cents integer
  
  Indicates the ending transaction volume at which this fee will apply. If not provided, the surcharge will apply to any transaction volume above the defined start.
  
  Default value is 100000000000000000000.
  
  percent_surcharge number Required
  
  Indicates the surcharge fee as a percent of total transaction volume that will be applied to the account if the total transaction volume during the surcharge interval falls within the provided start and end range.
  
  billing_cycle_policies object
  
  The set of policies governing the billing cycle for the product.
  
  Hide billing_cycle_policies attributes Show billing_cycle_policies attributes object
  
  cycle_interval string Required
  
  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)
  
  cycle_due_interval string
  
  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.
  
  Default value is -5 days.
  
  first_cycle_interval string
  
  Defaults to value of cycle_interval. 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 cycle_interval
  
  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
  
  Default value is 23:59:59-05:00.
  
  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. Defaults to America/New_York if not provided.
  
  Default value is America/New_York.
  
  interest_policies object
  
  The Interest Policy Object
  
  Additional properties are NOT allowed.
  
  Hide interest_policies attributes Show interest_policies attributes object
  
  interest_calc_time string(time)
  
  Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.
  
  Default value is 01:00:00-05:00.
  
  interest_accrual_interval string
  
  Defaults to cycle interval. Interest for this policy is calculated every interval specified.
  
  Default value is 1 month.
  
  default_attributes object
  
  Hide default_attributes attributes Show default_attributes attributes object
  
  default_credit_limit_cents integer Required
  
  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.
  
  Default value is 0.
  
  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.
  
  Default value is 0.
  
  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.
  
  Default value is 0.
  
  promotional_policies object Required
  
  If applicable, a promotional configuration for the product.
  
  Hide promotional_policies attributes Show promotional_policies attributes object
  
  promo_len integer
  
  The number of billing cycles from account origination during which accounts on this product are on a promotional period.
  
  Default value is 0.
  
  promo_min_pay_type string
  
  Current due calculation method for the promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, or NONE. Default value is NONE.
  
  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.
  
  Default value is 0.
  
  promo_min_pay_percent number
  
  Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
  
  Default value is 100.
  
  promo_interest_deferred boolean
  
  Indicates whether interest accrued during the promotional period is deferred interest.
  
  Default value is false.
  
  promo_reset_on_first_charge boolean
  
  If set to true, the promo end date will be reset to end of current cycle + promo_len when the account draws its first charge during the promo period. If no charges occur during the promo period, the promo period will still end on the date set at account creation.
  
  Default value is false.
  
  promo_default_interest_rate_percent number
  
  The rate that serves as the active interest rate for accounts during the promotional period.
  
  Default value is 0.
  
  promo_apr_range_inclusive_lower number
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  Default value is 0.
  
  promo_apr_range_inclusive_upper number
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  Default value is 0.
  
  post_promotional_policies object
  
  Hide post_promotional_policies attributes Show post_promotional_policies attributes object
  
  post_promo_len integer | null
  
  Default duration for the amortization period during post-promotion
  
  post_promo_am_len_range_inclusive_lower integer | null
  
  Optional lower bound for amortization length in billing cycles for the product.
  
  post_promo_am_len_range_inclusive_upper integer | null
  
  Optional upper bound for amortization length in billing cycles for the product.
  
  post_promo_min_pay_type string
  
  Current due calculation method for the post-promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
  
  post_promo_default_interest_rate_percent number | null
  
  The rate that serves as the active interest rate for accounts during the post-promotional period.
  
  post_promo_apr_range_inclusive_lower number | null
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  post_promo_apr_range_inclusive_upper number | null
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  product_summary object
  
  Summary of product information
  
  Hide product_summary attribute Show product_summary attribute object
  
  accounts_overview object
  
  Hide accounts_overview attribute Show accounts_overview attribute object
  
  account_count_total integer Required
  
  Total number of accounts under the product.
  
  admin object
  
  Hide admin attribute Show admin attribute object
  
  migration_mode boolean
  
  If migration mode is on, Canopy will stop auto-generating statements for this account.
  
  Default value is false.
401

Unauthorized.
403

Forbidden.
404

Unable to get products
429

Too many requests.
default

Unexpected Error.

GET /products

curl \
 --request GET 'https://sandbox-api.canopyservicing.com/products' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "results": [
    {
      "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
      "created_at": "2019-03-20T09:12:28+00:00",
      "effective_at": "2016-11-27T13:19:56+00:00",
      "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": 2,
          "charge_off_on_n_consecutive_late_fees": 5
        },
        "payment_pouring_policies": {
          "pending_pmt_affects_avail_credit": true
        },
        "fee_policies": {
          "late_fee_grace": "5 days",
          "surcharge_fee_interval": "1 month",
          "default_surcharge_fee_structure": [
            {
              "surcharge_start_inclusive_cents": 0,
              "surcharge_end_exclusive_cents": 0,
              "percent_surcharge": 0
            }
          ]
        },
        "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",
          "interest_accrual_interval": "1 day"
        },
        "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_reset_on_first_charge": true,
        "promo_default_interest_rate_percent": 3,
        "promo_apr_range_inclusive_lower": 2,
        "promo_apr_range_inclusive_upper": 5
      },
      "post_promotional_policies": {
        "post_promo_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
        }
      },
      "admin": {
        "migration_mode": true
      }
    }
  ]
}

Create a new product

POST /products

O auth2

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.

application/json

Body Required

effective_at string(date-time)

The Date-Time as of which this product is effective on the server. Your product should be older than all accounts enrolled in it.

Default value is 1900-01-01T12:00:00+00:00.
product_id string

A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.

Format should match the following pattern: ^(?!can_).*$.
product_overview object Required

A series of static fields about the product.

Additional properties are NOT allowed.
Hide product_overview attributes Show product_overview attributes object
- product_name string Required
  
  Name of Product, i.e. BNPL 24 Month Standard.
- product_type string Required
  
  The Type of Product
  
  Values are REVOLVING, INSTALLMENT, MIXED_RATE_INSTALLMENT, DEFERRED_INSTALLMENT, or FIXED_RATE_INSTALLMENT. Default value is REVOLVING.
- product_short_description string Required
  
  A short description of the product ranging from 0 - 60 characters.
- product_long_description string Required
  
  Description of the Product ranging from 0 - 1000.
- product_color string
  
  A color to be associated with the product for UI purposes.
  
  Default value is #000000.
product_lifecycle_policies object Required
Hide product_lifecycle_policies attributes Show product_lifecycle_policies attributes object
- payment_due_policies object
  
  The set of policies governing payment due information for the product.
  Hide payment_due_policies attributes Show payment_due_policies attributes object
  
  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
  
  Default value is 1.
  
  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
  
  Default value is 2.
- payment_pouring_policies object
  
  The set of policies governing payment pouring information for the product.
  Hide payment_pouring_policies attribute Show payment_pouring_policies attribute object
  
  pending_pmt_affects_avail_credit boolean
  
  Indicates whether pending payments affect available credit.
  
  Default value is false.
- fee_policies object
  
  The set of policies governing fees for the product.
  Hide fee_policies attributes Show fee_policies attributes object
  
  late_fee_grace string
  
  Amount of time between when a payment is due and when a late fee is assessed if no payments have been made.
  
  Default value is 5 days.
  
  surcharge_fee_interval string | null
  
  The interval at which a surcharge fee is assessed.
  
  default_surcharge_fee_structure array[object] | null
  
  The transaction volume structure that dictates a transaction fee.
  
  Hide default_surcharge_fee_structure attributes Show default_surcharge_fee_structure attributes object
  
  surcharge_start_inclusive_cents integer Required
  
  Indicates the starting transaction volume at which this fee will apply.
  
  surcharge_end_exclusive_cents integer
  
  Indicates the ending transaction volume at which this fee will apply. If not provided, the surcharge will apply to any transaction volume above the defined start.
  
  Default value is 100000000000000000000.
  
  percent_surcharge number Required
  
  Indicates the surcharge fee as a percent of total transaction volume that will be applied to the account if the total transaction volume during the surcharge interval falls within the provided start and end range.
- billing_cycle_policies object
  
  The set of policies governing the billing cycle for the product.
  Hide billing_cycle_policies attributes Show billing_cycle_policies attributes object
  
  cycle_interval string Required
  
  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)
  
  cycle_due_interval string
  
  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.
  
  Default value is -5 days.
  
  first_cycle_interval string
  
  Defaults to value of cycle_interval. 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 cycle_interval
  
  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
  
  Default value is 23:59:59-05:00.
  
  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. Defaults to America/New_York if not provided.
  
  Default value is America/New_York.
- interest_policies object
  
  The Interest Policy Object
  
  Additional properties are NOT allowed.
  Hide interest_policies attributes Show interest_policies attributes object
  
  interest_calc_time string(time)
  
  Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.
  
  Default value is 01:00:00-05:00.
  
  interest_accrual_interval string
  
  Defaults to cycle interval. Interest for this policy is calculated every interval specified.
  
  Default value is 1 month.
- default_attributes object
  Hide default_attributes attributes Show default_attributes attributes object
  
  default_credit_limit_cents integer Required
  
  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.
  
  Default value is 0.
  
  default_late_fee_cents integer
  
  The default late fee for accounts enrolled in this product. This will be used if no late fee is provided at account creation.
  
  Default value is 0.
  
  default_payment_reversal_fee_cents integer
  
  The default payment reversa fee for accounts enrolled in this product. This will be used if no late fee is provided at account creation.
  
  Default value is 0.
promotional_policies object Required

If applicable, a promotional configuration for the product.
Hide promotional_policies attributes Show promotional_policies attributes object
- 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.
  
  Default value is 0.
- promo_min_pay_type string
  
  Current due calculation method for the promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, or NONE. Default value is NONE.
- 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.
  
  Default value is 0.
- promo_interest_deferred boolean
  
  Indicates whether interest accrued during the promotional period is deferred interest.
  
  Default value is false.
- promo_reset_on_first_charge boolean
  
  If set to true, the promo end date will be reset to end of current cycle + promo_len when the account draws its first charge during the promo period. If no charges occur during the promo period, the promo period will still end on the date set at account creation.
  
  Default value is false.
- promo_default_interest_rate_percent number
  
  The rate that serves as the active interest rate for accounts during the promotional period.
  
  Default value is 0.
- promo_min_pay_percent number
  
  Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
  
  Default value is 100.
- promo_apr_range_inclusive_lower number
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  Default value is 0.
- promo_apr_range_inclusive_upper number
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  Default value is 0.
post_promotional_policies object
Hide post_promotional_policies attributes Show post_promotional_policies attributes object
- post_promo_len integer
  
  Default duration for any amortization period during post-promotion
- post_promo_am_len_range_inclusive_lower integer
  
  Optional lower bound for amortization length in billing cycles for the product.
- post_promo_am_len_range_inclusive_upper integer
  
  Optional upper bound for amortization length in billing cycles for the product.
- post_promo_min_pay_type string
  
  Current due calculation method for the post-promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
- post_promo_default_interest_rate_percent number
  
  The rate that serves as the active interest rate for accounts during the post-promotional period.
- post_promo_apr_range_inclusive_lower number
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
- post_promo_apr_range_inclusive_upper number
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
admin object
Hide admin attribute Show admin attribute object
- migration_mode boolean
  
  If migration mode is on, Canopy will stop auto-generating statements for this account.
  
  Default value is false.

Responses

200 application/json

Product
Hide response attributes Show response attributes object
- product_id string Required
  
  A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
- created_at 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.
- product_overview object Required
  
  A series of static fields about the product.
  
  Hide product_overview attributes Show product_overview attributes object
  
  product_name string Required
  
  Name of Product, i.e. Express Card.
  
  product_type string Required
  
  The Type of Product
  
  product_short_description string | null
  
  A short description of the product ranging from 0 - 60 characters.
  
  product_long_description string | null Required
  
  Description of the Product ranging from 0 - 1000.
  
  product_color string
  
  A color to be associated with the product for UI purposes.
  
  Default value is #4867FF.
  
  external_fields array[object] | null
  
  Not more than 1000 elements.
  
  Hide external_fields attributes Show external_fields attributes object
  
  key string
  
  value string
- product_lifecycle_policies object Required
  
  Hide product_lifecycle_policies attributes Show product_lifecycle_policies attributes object
  
  payment_due_policies object
  
  The set of policies governing payment due information for the product.
  
  Hide payment_due_policies attributes Show payment_due_policies attributes object
  
  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
  
  Default value is 1.
  
  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
  
  Default value is 2.
  
  payment_pouring_policies object
  
  The set of policies governing payment pouring information for the product.
  
  Hide payment_pouring_policies attribute Show payment_pouring_policies attribute object
  
  pending_pmt_affects_avail_credit boolean
  
  Indicates whether pending payments affect available credit.
  
  Default value is false.
  
  fee_policies object
  
  The set of policies governing fees for the product.
  
  Hide fee_policies attributes Show fee_policies attributes object
  
  late_fee_grace string
  
  Amount of time between when a payment is due and when a late fee is assessed if no payments have been made.
  
  Default value is 5 days.
  
  surcharge_fee_interval string | null
  
  The interval at which a surcharge fee is assessed.
  
  default_surcharge_fee_structure array[object] | null
  
  The transaction volume structure that dictates a transaction fee.
  
  Hide default_surcharge_fee_structure attributes Show default_surcharge_fee_structure attributes object
  
  surcharge_start_inclusive_cents integer Required
  
  Indicates the starting transaction volume at which this fee will apply.
  
  surcharge_end_exclusive_cents integer
  
  Indicates the ending transaction volume at which this fee will apply. If not provided, the surcharge will apply to any transaction volume above the defined start.
  
  Default value is 100000000000000000000.
  
  percent_surcharge number Required
  
  Indicates the surcharge fee as a percent of total transaction volume that will be applied to the account if the total transaction volume during the surcharge interval falls within the provided start and end range.
  
  billing_cycle_policies object
  
  The set of policies governing the billing cycle for the product.
  
  Hide billing_cycle_policies attributes Show billing_cycle_policies attributes object
  
  cycle_interval string Required
  
  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)
  
  cycle_due_interval string
  
  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.
  
  Default value is -5 days.
  
  first_cycle_interval string
  
  Defaults to value of cycle_interval. 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 cycle_interval
  
  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
  
  Default value is 23:59:59-05:00.
  
  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. Defaults to America/New_York if not provided.
  
  Default value is America/New_York.
  
  interest_policies object
  
  The Interest Policy Object
  
  Additional properties are NOT allowed.
  
  Hide interest_policies attributes Show interest_policies attributes object
  
  interest_calc_time string(time)
  
  Defaults to EST 1AM. Interest for this policy is calculated at this time every X interval.
  
  Default value is 01:00:00-05:00.
  
  interest_accrual_interval string
  
  Defaults to cycle interval. Interest for this policy is calculated every interval specified.
  
  Default value is 1 month.
  
  default_attributes object
  
  Hide default_attributes attributes Show default_attributes attributes object
  
  default_credit_limit_cents integer Required
  
  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.
  
  Default value is 0.
  
  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.
  
  Default value is 0.
  
  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.
  
  Default value is 0.
- promotional_policies object Required
  
  If applicable, a promotional configuration for the product.
  
  Hide promotional_policies attributes Show promotional_policies attributes object
  
  promo_len integer
  
  The number of billing cycles from account origination during which accounts on this product are on a promotional period.
  
  Default value is 0.
  
  promo_min_pay_type string
  
  Current due calculation method for the promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, or NONE. Default value is NONE.
  
  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.
  
  Default value is 0.
  
  promo_min_pay_percent number
  
  Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
  
  Default value is 100.
  
  promo_interest_deferred boolean
  
  Indicates whether interest accrued during the promotional period is deferred interest.
  
  Default value is false.
  
  promo_reset_on_first_charge boolean
  
  If set to true, the promo end date will be reset to end of current cycle + promo_len when the account draws its first charge during the promo period. If no charges occur during the promo period, the promo period will still end on the date set at account creation.
  
  Default value is false.
  
  promo_default_interest_rate_percent number
  
  The rate that serves as the active interest rate for accounts during the promotional period.
  
  Default value is 0.
  
  promo_apr_range_inclusive_lower number
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  Default value is 0.
  
  promo_apr_range_inclusive_upper number
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
  
  Default value is 0.
- post_promotional_policies object
  
  Hide post_promotional_policies attributes Show post_promotional_policies attributes object
  
  post_promo_len integer | null
  
  Default duration for the amortization period during post-promotion
  
  post_promo_am_len_range_inclusive_lower integer | null
  
  Optional lower bound for amortization length in billing cycles for the product.
  
  post_promo_am_len_range_inclusive_upper integer | null
  
  Optional upper bound for amortization length in billing cycles for the product.
  
  post_promo_min_pay_type string
  
  Current due calculation method for the post-promotional period.
  
  Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
  
  post_promo_default_interest_rate_percent number | null
  
  The rate that serves as the active interest rate for accounts during the post-promotional period.
  
  post_promo_apr_range_inclusive_lower number | null
  
  Optional lower bound for APR Range for the product (i.e. 2 = 2%).
  
  post_promo_apr_range_inclusive_upper number | null
  
  Optional upper bound for APR Range for the product (i.e. 5 = 5%).
- product_summary object
  
  Summary of product information
  
  Hide product_summary attribute Show product_summary attribute object
  
  accounts_overview object
  
  Hide accounts_overview attribute Show accounts_overview attribute object
  
  account_count_total integer Required
  
  Total number of accounts under the product.
- admin object
  
  Hide admin attribute Show admin attribute object
  
  migration_mode boolean
  
  If migration mode is on, Canopy will stop auto-generating statements for this account.
  
  Default value is false.
401

Unauthorized.
403

Forbidden.
422

Invalid input
429

Too many requests.
default

Unexpected Error.

POST /products

curl \
 --request POST 'https://sandbox-api.canopyservicing.com/products' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"effective_at":"2016-11-27T13:19:56+00:00","product_id":"95fea111-d121-40f8-9e8e-a6c335e48a45","product_overview":{"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":2,"charge_off_on_n_consecutive_late_fees":5},"payment_pouring_policies":{"pending_pmt_affects_avail_credit":true},"fee_policies":{"late_fee_grace":"5 days","surcharge_fee_interval":"1 month","default_surcharge_fee_structure":[{"surcharge_start_inclusive_cents":0,"surcharge_end_exclusive_cents":0,"percent_surcharge":0}]},"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","interest_accrual_interval":"1 day"},"default_attributes":{"default_credit_limit_cents":600000,"default_late_fee_cents":3000,"default_payment_reversal_fee_cents":3000}},"promotional_policies":{"promo_len":6,"promo_min_pay_type":"PERCENT_INTEREST","promo_purchase_window_len":5,"promo_interest_deferred":true,"promo_reset_on_first_charge":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_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},"admin":{"migration_mode":true}}'

Request examples

{
  "effective_at": "2016-11-27T13:19:56+00:00",
  "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
  "product_overview": {
    "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": 2,
      "charge_off_on_n_consecutive_late_fees": 5
    },
    "payment_pouring_policies": {
      "pending_pmt_affects_avail_credit": true
    },
    "fee_policies": {
      "late_fee_grace": "5 days",
      "surcharge_fee_interval": "1 month",
      "default_surcharge_fee_structure": [
        {
          "surcharge_start_inclusive_cents": 0,
          "surcharge_end_exclusive_cents": 0,
          "percent_surcharge": 0
        }
      ]
    },
    "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",
      "interest_accrual_interval": "1 day"
    },
    "default_attributes": {
      "default_credit_limit_cents": 600000,
      "default_late_fee_cents": 3000,
      "default_payment_reversal_fee_cents": 3000
    }
  },
  "promotional_policies": {
    "promo_len": 6,
    "promo_min_pay_type": "PERCENT_INTEREST",
    "promo_purchase_window_len": 5,
    "promo_interest_deferred": true,
    "promo_reset_on_first_charge": 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_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
  },
  "admin": {
    "migration_mode": true
  }
}

Response examples (200)

{
  "product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
  "created_at": "2019-03-20T09:12:28+00:00",
  "effective_at": "2016-11-27T13:19:56+00:00",
  "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": 2,
      "charge_off_on_n_consecutive_late_fees": 5
    },
    "payment_pouring_policies": {
      "pending_pmt_affects_avail_credit": true
    },
    "fee_policies": {
      "late_fee_grace": "5 days",
      "surcharge_fee_interval": "1 month",
      "default_surcharge_fee_structure": [
        {
          "surcharge_start_inclusive_cents": 0,
          "surcharge_end_exclusive_cents": 0,
          "percent_surcharge": 0
        }
      ]
    },
    "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",
      "interest_accrual_interval": "1 day"
    },
    "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_reset_on_first_charge": true,
    "promo_default_interest_rate_percent": 3,
    "promo_apr_range_inclusive_lower": 2,
    "promo_apr_range_inclusive_upper": 5
  },
  "post_promotional_policies": {
    "post_promo_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
    }
  },
  "admin": {
    "migration_mode": true
  }
}

Canopy Servicing Core API - Latest 1.8.11

Getting Started

Authentication

Troubleshooting

Test it out

Pagination

Document Versioning

api_users

Get all API users in your organization

Responses

Invite a new API user to Canopy

Body Required

Responses

Register a new organization and user

Body Required

Responses

Get summary info for an API user

Responses

products

Get all available products

Query parameters

Responses

Create a new product

Body Required

Responses

customers

Canopy Servicing Core API - Latest
1.8.11