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.13.03
of the API. Last update on Mar 10, 2023.
https://sandbox-api.canopyservicing.comGet 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.
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.
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:
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.
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
Authenticate to use the appropriate environment (sandbox or production) within Canopy
Returns a list of all API users in your organization.
Array of API Users
The unique ID in Canopy for this API user
The organization to which the API user belongs.
The first name of the API user.
The last name of the API user.
The email address of this API User
Phone number of the API user
The role of this user in the API
Unauthorized.
Forbidden.
No Api Users found
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/api_users \
-H "Authorization: Bearer $ACCESS_TOKEN"[
{
"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
}
]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 of request to invite new API user. Checks permissions of invite-creator.
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.
The email address of this API User.
The first name of the API User.
The last name of the API User.
Phone number of API user
curl \
-X POST https://sandbox-api.canopyservicing.com/api_users \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"role":3,"email":"marissa@globex.com","name_first":"John","name_last":"Doe","phone":"1-234-567-8900"}'{
"role": 3,
"email": "marissa@globex.com",
"name_first": "John",
"name_last": "Doe",
"phone": "1-234-567-8900"
}{
"status": "success"
}When provided appropriate credentials, this route updates an API user's information for registration.
Provide valid credentials, this route updates an API User's password.
The first name of the API user.
The last name of the API user.
The new password of the API user.
The email address of the API user
The organization name
API user successfully registered
The unique ID in Canopy for this API user
The organization to which the API user belongs.
The first name of the API user.
The last name of the API user.
The email address of this API User
Phone number of the API user
The role of this user in the API
Unauthorized.
Forbidden.
Not found.
Too many requests.
Unexpected Error.
curl \
-X POST https://sandbox-api.canopyservicing.com/register \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name_first":"Harriet","name_last":"Martins","password":"newSecretPassword123!","email":"harriet@acmecorporation.com","organization_name":"Acme Corporation"}'{
"name_first": "Harriet",
"name_last": "Martins",
"password": "newSecretPassword123!",
"email": "harriet@acmecorporation.com",
"organization_name": "Acme Corporation"
}{
"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 summarized information pertaining to the API user making the request.
API User
The unique ID in Canopy for this API user
The organization to which the API user belongs.
The first name of the API user.
The last name of the API user.
The email address of this API User
Phone number of the API user
The role of this user in the API
Unauthorized.
Forbidden.
No API user found.
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/api_users/summary \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"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
}Create and launch credit products within the Canopy system.
If you have configured and launched multiple products within Canopy, retrieve information related to all of your configured products at once.
The maximum number of products to be returned. Defaults to 10.
Minimum value is 0, maximum value is 10000.
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.
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.
Retireve only products that are a template
Comma-separated list of statuses of the products to filter by (no whitespaces).
Allowed values: ACTIVE, DEACTIVATED
Comma-separated list of the product types to filter by (no whitespaces)
Searches by product_name and product_id. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.
Array of Products
An array of information for all products within the requested range.
Not more than 100 elements.
A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
The Date-Time that this product was created on the server.
The Date-Time that this product was updated on the server.
The Date-Time as of which this product is effective on the server.
Indicates whether the product is active or inactive
A series of static fields about the product.
Name of Product, i.e. Express Card.
The Type of Product
A short description of the product ranging from 0 - 60 characters.
Description of the Product ranging from 0 - 1000.
A color to be associated with the product for UI purposes.
Default value is #4867FF.
Not more than 1000 elements.
The set of policies governing payment due information for the product.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
Default value is 1.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
Default value is 2.
If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
Default value is false.
The set of policies governing payment pouring information for the product.
Indicates whether pending payments affect available credit.
Default value is false.
The set of policies governing fees for the product.
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.
The interval at which a surcharge fee is assessed.
The transaction volume structure that dictates a transaction fee.
Indicates the starting transaction volume at which this fee will apply.
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.
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.
The set of policies governing the billing cycle for the product.
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)
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.
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
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.
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.
The Interest Policy Object
Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
Default value is 01:00:00-05:00.
Speaks to how interest is calculated for accounts under this product.
monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
When should the interest of an installment be accrued.
BEGINNING: At the beginning of a cycle
END: At the end of a cycle
Values are BEGINNING or END. Default value is END.
The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
Default value is false.
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.
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.
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.
If applicable, a promotional configuration for the product.
The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default value is 0.
Current due calculation method for the promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type.
Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
Default value is 100.
Indicates whether interest accrued during the promotional period is deferred interest.
Default value is false.
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.
The rate that serves as the active interest rate for accounts during the promotional period.
Default value is 0.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Default value is 0.
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Default value is 0.
Default duration for the amortization period during post-promotion
Optional lower bound for amortization length in billing cycles for the product.
Optional upper bound for amortization length in billing cycles for the product.
Current due calculation method for the post-promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
The rate that serves as the active interest rate for accounts during the post-promotional period.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Summary of product information
Total number of accounts under the product.
Status associated with this product
Values are ACTIVE or DEACTIVATED.
If migration mode is on, Canopy will stop auto-generating statements for this account.
Default value is false.
Metro2 credit reporting configs
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
Unauthorized.
Forbidden.
Unable to get products
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/products \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
"created_at": "2019-03-20T09:12:28+00:00",
"updated_at": "2020-01-20T09:12:28+00:00",
"effective_at": "2016-11-27T13:19:56+00:00",
"is_active": true,
"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,
"pre_statement_payments_reduce_min_pay": false
},
"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_calc_method": "avg_daily_12",
"interest_grace_method": "NONE",
"installment_interest_accrual_moment": "BEGINNING",
"revolving_interest_applicable_balance": "PRINCIPAL",
"installment_interest_applicable_balance": "EXPECTED",
"is_limited_to_loan_duration": true
},
"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_min_pay_floor_cents": 500,
"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
},
"product_status": "ACTIVE"
},
"admin": {
"migration_mode": true
},
"metro2_config": {
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}
}
]
}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.
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.
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_).*$.
A series of static fields about the product.
Name of Product, i.e. BNPL 24 Month Standard.
A user-defined enum of the Type of Product
Default value is REVOLVING.
A short description of the product ranging from 0 - 60 characters.
Description of the Product ranging from 0 - 1000.
A color to be associated with the product for UI purposes.
Default value is #000000.
The set of policies governing payment due information for the product.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
Default value is 1.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
Default value is 2.
If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
Default value is false.
The set of policies governing payment pouring information for the product.
Indicates whether pending payments affect available credit.
Default value is false.
The set of policies governing fees for the product.
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.
The interval at which a surcharge fee is assessed.
The transaction volume structure that dictates a transaction fee.
Indicates the starting transaction volume at which this fee will apply.
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.
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.
The set of policies governing the billing cycle for the product.
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)
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.
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
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.
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.
The Interest Policy Object
Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
Default value is 01:00:00-05:00.
Speaks to how interest is calculated for accounts under this product.
monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
When should the interest of an installment be accrued.
BEGINNING: At the beginning of a cycle
END: At the end of a cycle
Values are BEGINNING or END. Default value is END.
The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
Default value is false.
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.
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.
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.
If applicable, a promotional configuration for the product.
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.
Current due calculation method for the promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type.
Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
Indicates whether interest accrued during the promotional period is deferred interest.
Default value is false.
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.
The rate that serves as the active interest rate for accounts during the promotional period.
Default value is 0.
Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
Default value is 100.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Default value is 0.
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Default value is 0.
Default duration for any amortization period during post-promotion
Optional lower bound for amortization length in billing cycles for the product.
Optional upper bound for amortization length in billing cycles for the product.
Current due calculation method for the post-promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
The rate that serves as the active interest rate for accounts during the post-promotional period.
Default value is 0.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
If migration mode is on, Canopy will stop auto-generating statements for this account.
Default value is false.
Metro2 credit reporting configs
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
Product
A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
The Date-Time that this product was created on the server.
The Date-Time that this product was updated on the server.
The Date-Time as of which this product is effective on the server.
Indicates whether the product is active or inactive
A series of static fields about the product.
Name of Product, i.e. Express Card.
The Type of Product
A short description of the product ranging from 0 - 60 characters.
Description of the Product ranging from 0 - 1000.
A color to be associated with the product for UI purposes.
Default value is #4867FF.
Not more than 1000 elements.
The set of policies governing payment due information for the product.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
Default value is 1.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
Default value is 2.
If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
Default value is false.
The set of policies governing payment pouring information for the product.
Indicates whether pending payments affect available credit.
Default value is false.
The set of policies governing fees for the product.
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.
The interval at which a surcharge fee is assessed.
The transaction volume structure that dictates a transaction fee.
Indicates the starting transaction volume at which this fee will apply.
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.
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.
The set of policies governing the billing cycle for the product.
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)
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.
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
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.
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.
The Interest Policy Object
Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
Default value is 01:00:00-05:00.
Speaks to how interest is calculated for accounts under this product.
monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
When should the interest of an installment be accrued.
BEGINNING: At the beginning of a cycle
END: At the end of a cycle
Values are BEGINNING or END. Default value is END.
The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
Default value is false.
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.
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.
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.
If applicable, a promotional configuration for the product.
The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default value is 0.
Current due calculation method for the promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type.
Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
Default value is 100.
Indicates whether interest accrued during the promotional period is deferred interest.
Default value is false.
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.
The rate that serves as the active interest rate for accounts during the promotional period.
Default value is 0.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Default value is 0.
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Default value is 0.
Default duration for the amortization period during post-promotion
Optional lower bound for amortization length in billing cycles for the product.
Optional upper bound for amortization length in billing cycles for the product.
Current due calculation method for the post-promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
The rate that serves as the active interest rate for accounts during the post-promotional period.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Summary of product information
Total number of accounts under the product.
Status associated with this product
Values are ACTIVE or DEACTIVATED.
If migration mode is on, Canopy will stop auto-generating statements for this account.
Default value is false.
Metro2 credit reporting configs
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
Unauthorized.
Forbidden.
Invalid input
Too many requests.
Unexpected Error.
curl \
-X POST https://sandbox-api.canopyservicing.com/products \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"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,"pre_statement_payments_reduce_min_pay":false},"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_calc_method":"avg_daily_12","interest_grace_method":"NONE","installment_interest_accrual_moment":"BEGINNING","revolving_interest_applicable_balance":"PRINCIPAL","installment_interest_applicable_balance":"EXPECTED","is_limited_to_loan_duration":true},"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_min_pay_floor_cents":500,"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},"metro2_config":{"bloom_metadata":{"industry":"CREDIT_CARD_ISSUER","portfolio_type":"REVOLVING","account_type":"CREDIT_CARD","interest_type":"VARIABLE","terms_frequency":"MONTHLY"}}}'{
"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,
"pre_statement_payments_reduce_min_pay": false
},
"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_calc_method": "avg_daily_12",
"interest_grace_method": "NONE",
"installment_interest_accrual_moment": "BEGINNING",
"revolving_interest_applicable_balance": "PRINCIPAL",
"installment_interest_applicable_balance": "EXPECTED",
"is_limited_to_loan_duration": true
},
"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_min_pay_floor_cents": 500,
"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
},
"metro2_config": {
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}
}{
"product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
"created_at": "2019-03-20T09:12:28+00:00",
"updated_at": "2020-01-20T09:12:28+00:00",
"effective_at": "2016-11-27T13:19:56+00:00",
"is_active": true,
"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,
"pre_statement_payments_reduce_min_pay": false
},
"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_calc_method": "avg_daily_12",
"interest_grace_method": "NONE",
"installment_interest_accrual_moment": "BEGINNING",
"revolving_interest_applicable_balance": "PRINCIPAL",
"installment_interest_applicable_balance": "EXPECTED",
"is_limited_to_loan_duration": true
},
"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_min_pay_floor_cents": 500,
"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
},
"product_status": "ACTIVE"
},
"admin": {
"migration_mode": true
},
"metro2_config": {
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}
}Add Metro2 Configuration to an existing product, or Modify the Metro2 Configuration for an existing product, to enable Credit Reporting on that product.
Update Metro2 Configuration for a product
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
Product Metro2 Configuration updated successfully
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
Unauthorized.
Forbidden.
Invalid input
Too many requests.
Unexpected Error.
curl \
-X PUT https://sandbox-api.canopyservicing.com/products/{product_id}/metro2_config \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bloom_metadata":{"industry":"CREDIT_CARD_ISSUER","portfolio_type":"REVOLVING","account_type":"CREDIT_CARD","interest_type":"VARIABLE","terms_frequency":"MONTHLY"}}'{
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}{
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}Get all filter values for all endpoints that allow filtering
Flag to include all possible customer id-value pairs in the response
Flag to include all possible product types in the response
Flag to include all possible partner entities' id-value pairs in the response
Flag to only include customers of customer_type = business
Reponse object encapsulating all possible filter entities' values
An array of customer summary tuples
Customer's ID
Customer's name, business legal name or doing_business_as
An array of customer summary tuples
The Type of Product
An array of customer summary tuples
Partner Entity's ID
Partner Entity's actual name
Unauthorized.
Forbidden.
Invalid input
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/filters \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"customers": [
{
"customer_id": "can_1234",
"value": "John Smith"
}
],
"products": [
{
"product_type": "REVOLVING"
}
],
"partner_entities": [
{
"partner_entity_id": "can_1234",
"value": "Nuts'n Bolts LTD"
}
]
}Get all the products offered to a customer
ID of the customer
Array of Products
An array of information for all products within the requested range.
Not more than 100 elements.
A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
The Date-Time that this product was created on the server.
The Date-Time that this product was updated on the server.
The Date-Time as of which this product is effective on the server.
Indicates whether the product is active or inactive
A series of static fields about the product.
Name of Product, i.e. Express Card.
The Type of Product
A short description of the product ranging from 0 - 60 characters.
Description of the Product ranging from 0 - 1000.
A color to be associated with the product for UI purposes.
Default value is #4867FF.
Not more than 1000 elements.
The set of policies governing payment due information for the product.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
Default value is 1.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
Default value is 2.
If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
Default value is false.
The set of policies governing payment pouring information for the product.
Indicates whether pending payments affect available credit.
Default value is false.
The set of policies governing fees for the product.
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.
The interval at which a surcharge fee is assessed.
The transaction volume structure that dictates a transaction fee.
Indicates the starting transaction volume at which this fee will apply.
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.
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.
The set of policies governing the billing cycle for the product.
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)
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.
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
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.
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.
The Interest Policy Object
Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
Default value is 01:00:00-05:00.
Speaks to how interest is calculated for accounts under this product.
monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
When should the interest of an installment be accrued.
BEGINNING: At the beginning of a cycle
END: At the end of a cycle
Values are BEGINNING or END. Default value is END.
The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
Default value is false.
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.
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.
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.
If applicable, a promotional configuration for the product.
The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default value is 0.
Current due calculation method for the promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type.
Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
Default value is 100.
Indicates whether interest accrued during the promotional period is deferred interest.
Default value is false.
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.
The rate that serves as the active interest rate for accounts during the promotional period.
Default value is 0.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Default value is 0.
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Default value is 0.
Default duration for the amortization period during post-promotion
Optional lower bound for amortization length in billing cycles for the product.
Optional upper bound for amortization length in billing cycles for the product.
Current due calculation method for the post-promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
The rate that serves as the active interest rate for accounts during the post-promotional period.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Summary of product information
Total number of accounts under the product.
Status associated with this product
Values are ACTIVE or DEACTIVATED.
If migration mode is on, Canopy will stop auto-generating statements for this account.
Default value is false.
Metro2 credit reporting configs
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
curl \
-X GET https://sandbox-api.canopyservicing.com/customers/e163fcb6-f8fd-46a2-9f29-36b2261e37ea/product_offerings \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
"created_at": "2019-03-20T09:12:28+00:00",
"updated_at": "2020-01-20T09:12:28+00:00",
"effective_at": "2016-11-27T13:19:56+00:00",
"is_active": true,
"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,
"pre_statement_payments_reduce_min_pay": false
},
"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_calc_method": "avg_daily_12",
"interest_grace_method": "NONE",
"installment_interest_accrual_moment": "BEGINNING",
"revolving_interest_applicable_balance": "PRINCIPAL",
"installment_interest_applicable_balance": "EXPECTED",
"is_limited_to_loan_duration": true
},
"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_min_pay_floor_cents": 500,
"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
},
"product_status": "ACTIVE"
},
"admin": {
"migration_mode": true
},
"metro2_config": {
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}
}
]
}Offer a product to a customer that is visible only to them.
ID of the customer
Product ID used to clone a product, override its fields (if given), then offer to a customer
See the products reference for the details of each override
User-defined enum of the product type
User-defined product name
Product
A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.
The Date-Time that this product was created on the server.
The Date-Time that this product was updated on the server.
The Date-Time as of which this product is effective on the server.
Indicates whether the product is active or inactive
A series of static fields about the product.
Name of Product, i.e. Express Card.
The Type of Product
A short description of the product ranging from 0 - 60 characters.
Description of the Product ranging from 0 - 1000.
A color to be associated with the product for UI purposes.
Default value is #4867FF.
Not more than 1000 elements.
The set of policies governing payment due information for the product.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of delinquent
Default value is 1.
After this number of consecutive late events, the account status shifts to suspended with a status subtype of charged_off
Default value is 2.
If false, the default, payments mid-cycle (after the previous cycle's due date, but before the active cycle's statement date) on an installment product will not reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. the full minimum payment for the cycle is still due after a statement.
If true, not the default, payments mid-cycle on an installment product will reduce the minimum payment as assessed on the accounts' upcoming statements, i.e. making the full upcoming payment mid-cycle will output a minimum payment of $0 on the upcoming statement.
Note that this only affects behavior of installment items, as payments towards revolving balances will always reduce the minimum payment due.
Default value is false.
The set of policies governing payment pouring information for the product.
Indicates whether pending payments affect available credit.
Default value is false.
The set of policies governing fees for the product.
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.
The interval at which a surcharge fee is assessed.
The transaction volume structure that dictates a transaction fee.
Indicates the starting transaction volume at which this fee will apply.
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.
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.
The set of policies governing the billing cycle for the product.
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)
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.
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
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.
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.
The Interest Policy Object
Being deprecated under our backwards compatibility policy in favor of close_of_business time and timezone variables. Defaults to statement cut time Interest for this policy is calculated at this time every X interval.
Default value is 01:00:00-05:00.
Speaks to how interest is calculated for accounts under this product.
monthly_ending_bal_360: interest amount = [principal] * (r / (360 / 30)) :: calculated once at the end of each one month cycle
cycle_end_12 : DEPRECATED. Use monthly_ending_bal_360 instead.
monthly_ending_bal_365: interest amount = [principal] * (r / (365 / 30)) :: calculated once at the end of each one month cycle
daily_ending_bal_365: interest amount = [principal] * (r / 365) :: calculated at the end of each day
daily_end_365: DEPRECATED. Use daily_ending_bal_365 instead.
daily_ending_bal_360: interest amount = [principal] * (r / 360) :: interest accrues at the end of each day
daily_end_360: DEPRECATED. Use daily_ending_bal_360 instead.
monthly_avg_bal_365: interest amount = [avg_daily_principal] * (r / 12) :: interest accrues once at the end of each one month cycle.
avg_daily_12: DEPRECATED. Use monthly_avg_bal_365 instead.
cycle_start_360 : interest amount = [principal] * (r / (360 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
cycle_start_365 : interest amount = [principal] * (r / (365 / 30)) :: calculated once at the beginning of each one month cycle. Applicable to installment balances.
Values are cycle_end_12, avg_daily_12, daily_end_365, daily_end_360, monthly_avg_bal_365, monthly_ending_bal_360, monthly_ending_bal_365, daily_ending_bal_360, daily_ending_bal_365, cycle_start_360, or cycle_start_365. Default value is monthly_ending_bal_360.
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
When should the interest of an installment be accrued.
BEGINNING: At the beginning of a cycle
END: At the end of a cycle
Values are BEGINNING or END. Default value is END.
The policy which defines which revolving balance under an account will accrue interest during the interest accrual calculation. PRINCIPAL accrues interest on principal balances of revolving transactions (i.e. non-installment charges), TOTAL_ACCOUNT_BALANCE accrues interest on the account's total revolving balance (inclusive of interest, fees).
Values are PRINCIPAL or TOTAL_ACCOUNT_BALANCE. Default value is PRINCIPAL.
The policy which defines which principal balance to accrue interest on during the installment interest accrual calculation. ACTUAL accrues interest on the actual outstanding principal balance of loans (e.g. after a missed payment, interest would be higher than originally anticipated in the amortization schedule), EXPECTED accrues interest on the loan's expected balance (e.g. interest would be accrued at the same rate as quoted in the original amortization schedule). ORIGINAL accrues interest based on the original principal balance of the loan (i.e. a fixed amount of interest each cycle). AVERAGE accrues interest using the calculated average daily ending balance of the loan during the given cycle.
Values are EXPECTED, ACTUAL, ORIGINAL, or AVERAGE. Default value is EXPECTED.
Applies only to loans. If true, loan interest will only accrue for the expected duration of the loan. Otherwise, interest will accrue as long as there is an outstanding balance. This serves as the default, including loans rolled over at the end of the promotional period, but can be overridden on a per-loan basis in the loan creation payload.
Default value is false.
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.
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.
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.
If applicable, a promotional configuration for the product.
The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default value is 0.
Current due calculation method for the promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, INTEREST_AND_PERCENT_PRINCIPAL, or NONE. Default value is NONE.
If provided, the min_pay in the promo period will be set to this value whenever this value exceeds the calculated min_pay using promo_min_pay_type.
Note: if the account's total balance is less than promo_min_pay_floor, only the total balance will be due.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
Defaults to 100. The percent of new interest in the cycle used to determine the minimum payment.
Default value is 100.
Indicates whether interest accrued during the promotional period is deferred interest.
Default value is false.
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.
The rate that serves as the active interest rate for accounts during the promotional period.
Default value is 0.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Default value is 0.
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Default value is 0.
Default duration for the amortization period during post-promotion
Optional lower bound for amortization length in billing cycles for the product.
Optional upper bound for amortization length in billing cycles for the product.
Current due calculation method for the post-promotional period.
Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.
The rate that serves as the active interest rate for accounts during the post-promotional period.
Optional lower bound for APR Range for the product (i.e. 2 = 2%).
Optional upper bound for APR Range for the product (i.e. 5 = 5%).
Summary of product information
Total number of accounts under the product.
Status associated with this product
Values are ACTIVE or DEACTIVATED.
If migration mode is on, Canopy will stop auto-generating statements for this account.
Default value is false.
Metro2 credit reporting configs
Bloom API fields for products: https://docs.bloom.dev/docs/furnishment-api/b3A6MTMyOTc3NDQ-create-a-credit-product
Bloom Industry field
Values are CREDIT_CARD_ISSUER or LOAN_FINANCE.
Metro2 'Portfolio Type' segment
Values are INSTALLMENT, MORTGAGE, OPEN, or REVOLVING.
Metro2 'Account Type' segment
Values are UNSECURED or CREDIT_CARD.
Metro2 'Interest Type' segment
Values are FIXED or VARIABLE.
Bloom API supports only monthly terms frequencies for now.
Value is MONTHLY.
curl \
-X POST https://sandbox-api.canopyservicing.com/customers/e163fcb6-f8fd-46a2-9f29-36b2261e37ea/product_offerings \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"product_id":"e163fcb6-f8fd-46a2-9f29-36b2261e37ea","product_overrides":{"product_type":"EXTT_30","product_name":"EXTT_30","promo_len":3,"post_promo_len":4,"first_cycle_interval":"3 days","cycle_interval":"1 month","promo_default_interest_rate_percent":"3.451","post_promo_default_interest_rate_percent":"3.267"}}'{
"product_id": "e163fcb6-f8fd-46a2-9f29-36b2261e37ea",
"product_overrides": {
"product_type": "EXTT_30",
"product_name": "EXTT_30",
"promo_len": 3,
"post_promo_len": 4,
"first_cycle_interval": "3 days",
"cycle_interval": "1 month",
"promo_default_interest_rate_percent": "3.451",
"post_promo_default_interest_rate_percent": "3.267"
}
}{
"product_id": "95fea111-d121-40f8-9e8e-a6c335e48a45",
"created_at": "2019-03-20T09:12:28+00:00",
"updated_at": "2020-01-20T09:12:28+00:00",
"effective_at": "2016-11-27T13:19:56+00:00",
"is_active": true,
"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,
"pre_statement_payments_reduce_min_pay": false
},
"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_calc_method": "avg_daily_12",
"interest_grace_method": "NONE",
"installment_interest_accrual_moment": "BEGINNING",
"revolving_interest_applicable_balance": "PRINCIPAL",
"installment_interest_applicable_balance": "EXPECTED",
"is_limited_to_loan_duration": true
},
"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_min_pay_floor_cents": 500,
"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
},
"product_status": "ACTIVE"
},
"admin": {
"migration_mode": true
},
"metro2_config": {
"bloom_metadata": {
"industry": "CREDIT_CARD_ISSUER",
"portfolio_type": "REVOLVING",
"account_type": "CREDIT_CARD",
"interest_type": "VARIABLE",
"terms_frequency": "MONTHLY"
}
}
}Remove a product offering from a customer
ID of the customer
ID of the product
Product no longer offered to customer
curl \
-X DELETE https://sandbox-api.canopyservicing.com/customers/e163fcb6-f8fd-46a2-9f29-36b2261e37ea/product_offerings/2f85b8c0-2671-4694-9a30-c358c64af411 \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"product_id": "d1a844a1-7f5d-438e-828d-c58018c5585a",
"customer_id": "string",
"message": "Deleted customer's product offering"
}Onboard customers into your system, so they can begin using your credit products
Add Metro2 Configuration to an existing customer, or Modify the Metro2 Configuration for an existing customer, to enable Credit Reporting on for that customer.
Update Metro2/Bloom Configuration for a Customer
Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
Status of the reported address.
Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
Optional, if not available or unknown, do not report.
Values are OWNS or RENTS.
Customer Metro2 Configuration updated successfully
Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
Status of the reported address.
Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
Optional, if not available or unknown, do not report.
Values are OWNS or RENTS.
Unauthorized.
Forbidden.
Invalid input
Too many requests.
Unexpected Error.
curl \
-X PUT https://sandbox-api.canopyservicing.com/customers/{customer_id}/metro2_config \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bloom_metadata":{"address_type":"CONFIRMED","residence_type":"OWNS"}}'{
"bloom_metadata": {
"address_type": "CONFIRMED",
"residence_type": "OWNS"
}
}{
"bloom_metadata": {
"address_type": "CONFIRMED",
"residence_type": "OWNS"
}
}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.
The maximum number of customer accounts to be returned. Defaults to 30.
Minimum value is 0, maximum value is 10000.
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.
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.
Comma-separated list of statuses of the accounts to filter by (no whitespaces).
Allowed values: ACTIVE, CLOSED, SUSPENDED
Comma-separated list of sub-statuses of the accounts to filter by (no whitespaces).
Allowed values: '', INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, RISK, HARDSHIP/EXEMPTIONS, SETTLEMENT
Comma-separated list of the product types of the accounts to filter by (no whitespaces).
Allowed values: INSTALLMENT, INVENTORY_FINANCING, REVOLVING, LOGISTICS_FINANCING, etc.
This API supports searching by name_first, name_last, doing_business_as, account_id and product_name. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.
Returns customer accounts with an 'effective_at' date more recent than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter
Array of Customers and their corresponding Accounts
Passport information. required if country is not US
Not more than 1000 elements.
Address line one.
Address line two.
Address city.
Address state.
Five digit zipcode or nine digit 'ZIP+4'.
ISO 3166-1 alpha-2 country code for the customer.
Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.
Prefix to the customer's name.
Customer's first name.
Customer's middle name.
Customer's last name.
Suffix to the customer's name.
An ID for the customer.
The Date-Time which the customer was created in the API.
The Date-Time which the customer was updated in the API.
Indicates whether the customer has a borrower portal login or not
The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.
Values are person or business.
Value manually maintained - defaults to true."False" generally indicates no additional credit should be granted to this customer
The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result.
Values are unverified, verified, retry, or document.
Title of the customer if a person OR title of the admin if a business
Customer's phone number in E.164 format
Social security number of the customer.
Any country-specific unique identifier for the customer.
The email address of this Customer
Customer's date of birth in ISO 8601 format
The number of active accounts for this customer.
The total outstanding balance (in cents) associated with all active accounts for this customer. This balance is comprised of the sum of the following six balance items.
The total principal balance (in cents) associated with all active accounts for this customer.
The total interest balance (in cents) associated with all active accounts for this customer.
The total AM interest balance (in cents) associated with all active accounts for this customer.
Default value is 0.
The total deferred interest balance (in cents) associated with all active accounts for this customer.
Default value is 0.
The total AM deferred interest balance (in cents) associated with all active accounts for this customer.
Default value is 0.
The total fees balance (in cents) associated with all active accounts for this customer.
Default value is 0.
The legal name of the Business
The DBA name of the Business
EIN of the business, expected format in NN-NNNNNNN.
Type of business is used in determining the appropriate validation.
Values are sole_proprietorship, llc, unincorporated_association, trust, corporation, corporation_public, non_profile, or partnership.
UUID that references the business classification. This will eventually be supported by a reference api, however, for now refer to dwolla's specific UUID.
URL for the buesiness's website. This should be publicly resolvable
Passport information. required if country is not US
Address line one.
Address line two.
Address city.
Address state.
Five digit zipcode or nine digit 'ZIP+4'.
ISO 3166-1 alpha-2 country code for the customer.
Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.
Prefix to the customer's name.
Customer's first name.
Customer's middle name.
Customer's last name.
Suffix to the customer's name.
Title of the customer if a person OR title of the admin if a business
Customer's phone number in E.164 format.
Social security number of the customer.
Metro2 credit reporting configs
Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
Status of the reported address.
Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
Optional, if not available or unknown, do not report.
Values are OWNS or RENTS.
The role of the customer for the account.
Default value is PRIMARY.
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.
This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.
The Date-Time which the account was created in the API.
The Date-Time which the account was updated in the API.
The Date-Time that this account became/becomes active.
The Status of the Account. Active upon account creation.
Values are ACTIVE, SUSPENDED, or CLOSED. Default value is ACTIVE.
The subtype of the Status of the Account. Null upon account creation.
Values are , ADMINISTRATIVE, INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, SURPLUS_BALANCE, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, RISK, HARDSHIP/EXEMPTIONS, or SETTLEMENT. Default value is empty.
Denotes whether an account has active SCRA benefits
The product associated with the account.
The Canopy-generated ID for the product.
Name of Product, i.e. Express Card.
A color to be associated with the product for UI purposes.
Default value is #4867FF.
Short description of the Product - max of 30 characters.
Description of the Product.
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.
Default value is America/New_York.
The Type of Product. If not included, defaults to REVOLVING
The fee charged for late payments on the account.
Default value is 0.
Default late fee described by the account's product. This value will be overridden by 'late_fee_impl_cents` for determining fee amounts
The fee charged for payment reversals on the account.
Default value is 0.
Default payment reversal fee described by the account's product. This value will be overridden by payment_reversal_fee_impl_cents for determining fee amounts.
The fee charged at the time of account origination.
Default value is 0.
The fee as a percent of initial_principal_cents charged at the time of account origination.
Default value is 0.
If TRUE, the origination fee will be asessed as the lesser value of origination_fee_cents and origination_fee_percent, otherwise will default to greater of two.
Default value is false.
Indicates whether the origination fee is amortized.
Default value is false.
DEPRECATED - use recurring_fees instead.
An annual fee to be charged yearly on December 31.
Default value is 0.
DEPRECATED - use recurring_fees instead.
A monthly fee to be charged monthly from the date of account creation. It will reflect on the subsequent statement once incurred.
Default value is 0.
Configuration for a fee to be charged recurrently from the date of account effective_at
Not more than 1000 elements.
Frequency at which this fee will be charged to the account
Amount that will be charged from the account as a fee on a frequency defined by cycle_fee_interval (in cents)
Default value is 0.
Interval that defines the delay until the first recurring fee cycle starts from the moment the account was created
Flag that when true, configures the scheduling of the fee line item at the end of the previous nearest interval unit.
If recurring_fee_interval is 1 month, the first fee will be scheduled at the end of the current month. If recurring_fee_interval is 1 year, the fee line item will be scheduled at the end of this current year.
Otherwise, no flooring will be applied to the interval and fees will be scheduled at the end of the day prior to account_creation_time + recurring_fee_interval + initial_delay_offset.
Defaults to TRUE.
Default value is true.
Customer-configurable label to be displayed for this fee configuration
If applicable, the account's loan repayment date.
If applicable, the start date for a purchase window for the account
If applicable, the end date for a purchase window for the account
If applicable, the start date for a promotional period for the account.
If applicable, the start date for a promotional period for the account.
The percentage interest applied to the account during the promotional period (i.e. 6.2%)
Default value is 0.
Default interest rate described by the account's product (i.e. 6.2%). This value will be overridden by promo_impl_interest_rate_percent for determining interest rate.
Defaults to 0. The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default promotional length described by the account's product. This will be overridden by promo_len for determining length of the promotional period.
If applicable, the start date for a promotional period for the account.
If applicable, the start date for a promotional period for the account.
The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)
Default value is 0.
Default interest rate described by the account's product (i.e. 6.2%). This value will be overridden by post_promo_impl_interest_rate_percent for determining interest rate for the account.
Default value is 0.
If applicable, post-promotional amortization length in cycles.
Default value is 0.
Default post promotional amortization length in cycles described by this account's product. This value will be overridden by post_promo_len to determine the post promotional length for this account.
The number of billing cycles from account origination during which accounts on this product are on a promotional period.
Default value is 0.
If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.
Default value is 0.
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.
Not more than 1000 elements.
Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.
Default value is 0.
Real time total amount due including payments made since the start of the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.
Default value is 0.
The Date-Time the payment for this billing cycle is due.
Total fees due for the billing cycle accounting for payments since the billing cycle start.
Default value is 0.
Portion of the real-time minimum payment that comes from current cycle balances.
Portion of the real-time minimum payment that comes from unpaid balances.
Default value is 0.
Total principal due for the billing cycle.
Default value is 0.
Total interest due for the billing cycle.
Default value is 0.
The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.
Default value is 0.
Total deferred interest due for the billing cycle.
Default value is 0.
The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.
Default value is 0.
Total fees due for the billing cycle.
Default value is 0.
Total payments made during this billing cycle
Default value is 0.
Previous amounts due, including fees. This is a subset of statement_min_pay_cents.
Default value is 0.
Portion of the statement minimum payment that comes from current cycle balances.
Portion of the statement's minimum payment that comes from unpaid balances.
Default value is 0.
ACH processing configuration.
Indicates the active payment processor whose configuration will be used for ACH/Debit card payments made from the account.
Values are NONE, REPAY, DWOLLA, MODERN_TREASURY, CANOPY_NACHA, STRIPE, or GALILEO. Default value is NONE.
Canopy will create a NACHA file for each borrower ACH payment to be sent to your bank for ACH execution.
Routing number is a nine-digit code based on the U.S. Bank location where your account was opened.
Account number is an eight to ten digit number that identifies a specific account.
The type of bank account being used by the borrower.
Values are CHECKING, SAVINGS, or GL.
Stripe payment configuration. Use customer ID and source ID to enable payments.
Stripe generated customer ID associated with the customer making the payment. https://stripe.com/docs/api/customers
Payment Source ID. The Stripe generated source ID, https://stripe.com/docs/api/sources
This is a raw json blob that is copied verbatim into stripe's metadata.
Obtained from Plaid for Galileo ACH integration
Debit processing configuration.
Indicates the active payment processor whose configuration will be used for Debit card payments made from the account.
Values are NONE, REPAY, or AUTHORIZE_NET. Default value is NONE.
The tokenized card details.
The last four digits of the card number
Sensitive credit or debit card information will be stored as a secured token for payments in place of the raw account details. Note: This leverages credit card payment gateways, and Canopy cannot differentiate between credit or debit cards used in this payment integration. See authorize.net payment profiles for further details.
Customer profile ID created in Authorize.net
Customer payment profile ID created in Authorize.net
Credit processing configuration.
Indicates the active payment processor whose configuration will be used for Credit card payments made from the account.
Values are NONE or CHECKOUT. Default value is NONE.
A Checkout.com payment source id or customer id.
The tokenized card number.
The last 4 digits of the card number.
Expiration time for the card token.
Indicates whether autopay is enabled for this account. Currently, autopay is triggered 1 day prior to a payment due date. If default_payment_processor is set to NONE, autopay will not be triggered for account regardless of this field's value.
Default value is false.
Governs the autopay policies to be applied
Defines the calculation method for autopay.
Values are MIN_PAY, TOTAL_BALANCE, FIXED_AMOUNT, or REMAINING_STATEMENT_BALANCE. Default value is MIN_PAY.
If using FIXED_AMOUNT autopay method, autopay_fixed_amount_cents defines the fixed amount of each autopayment.
Configures the payment processor to be used for manual or autopay payments. This cannot be set to a value different from NONE if no valid ACH or Debit Card configs are provided.
Values are ACH, DEBIT_CARD, CREDIT_CARD, or NONE. Default value is NONE.
The payout_entity_id for this payout entity (typically a lender).
Provide a disbursement breakdown if draw downs from a borrower are meant to be distributed across multiple payout entities (lenders, merchants). Borrower payout breakdown. These numbers must add up to 100%. Borrower payout breakdowns will get reflected in daily reconciliation reports.
The payout_entity_id for this payout entity.
The percentage of borrower payouts towards principal to be allocated to this payout entity. Sum of splits for a borrower must = 100%.
The payout_entity_id of the payout_entity.
The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.
The payout_entity_id of the payout_entity.
The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.
The payout_entity_id of the payout_entity.
The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.
The external unique identifier of the Lithic account against which charges are made.
External unique identifier (PRN) used to reconcile events related to this account from Galileo
Interval for a first cycle for this account.
The amount of time after a payment is late after which you would like for a late fee to be incurred. If not provided, defaults to product's fee policy's late fee grace value
Loan discount amount in cents.
The Date-Time that this discount is valid.
The total balance (in cents) associated with the account. This balance is comprised of the sum of the following six balance items.
The total principal balance (in cents) associated with the account.
The total interest balance (in cents) associated with the account.
The total AM interest balance (in cents) associated with the account.
Default value is 0.
The total deferred interest balance (in cents) associated with the account.
Default value is 0.
The total AM deferred interest balance (in cents) associated with the account.
Default value is 0.
The total fees balance (in cents) associated with the account.
Default value is 0.
The initial principal balance (in cents) associated with the account.
The total sum of payments made to date (in cents) associated with the account.
The total sum of interest allocations for payments made to date (in cents) associated with the account.
Total Amount (in cents) that this account can borrow.
Total Amount (in cents) that this account can borrow.
Default value is 0.
The percentage interest applied to the account (i.e. 6.2 means 6.2%)
The interval at which interest accrues on the account. Ex: '1 day', '1 week', '2 weeks', '1 month' .Defaults to the product interest_accrual_interval if not specified
The policy that defines how grace periods are mathematically applied to borrower accounts based on borrower repayment behavior.
Values are NONE or PREVIOUS_STATEMENT_TOTAL_BALANCE_WITH_PENDING_PAYMENTS. Default value is NONE.
The total available credit balance (in cents) for the account.
Default value is 0.
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.
Default value is 0.
The total amount needed to pay off the loan at this exact moment.
Default value is 0.
If applicable, the pending AM interest balance (in cents) which will accrue on this account at the end of the cycle, otherwise 0. Only applicable when this account's product has an interest policy for installment_interest_applicable_balance configured as AVERAGE.
Default value is 0.
Any number as a percentage (e.g. 5=> 5%). This is the maximum late fee that can be charged in this account: as determined by late_fee_cap_percent * minimum payment.
Any number as a percentage (e.g. 5=> 5%). This is the maximum reversal fee that can be charged in this account, as determined by payment_reversal_fee_cap_percent * account principal as if the payment never occurred (as opposed to after the payment but before it's reversed)
(to be depricated) -- use payout_entities instead to provide more granular detail.
A merchant name associated with the account
A lender name associated with the account
Plaid configurations.
Indicates whether Canopy has a valid Plaid access token.
Indicates whether Canopy has a valid Plaid account ID.
Indicates whether the balance check functionality is enabled with along side the payment processing. If set to true, the payment processing is enabled and the plaid access token and plaid account ID are valid, actions such as notifications etc. will be triggered.
Default value is false.
An array of payout entities who have been assigned to the account
Not more than 1000 elements.
The ID to be associated with the payout entity for future requests. If not provided on payout entity creation, Canopy will generate this field.
Type of associated entity
Values are merchant, lender, sponsor, organization, or clearing.
Entity's name.
An Array of External Fields. These should be used to connect entities created in Canopy to data in your system and any connected external systems.
Not more than 1000 elements.
A Canopy-generated ID for the parent of this associated entity to establish a parent-child relationship.
Account number of the bank account for payment distributions.
Routing number of the bank account for payment distributions.
The type of bank account being stored for the payout entity.
Values are CHECKING, SAVINGS, or GL.
The Depository Financial Institution (DFI) ID of the entity.
The IRS tax identification number of the entity.
Card data. Field names match the ones in Lithic's card schema
Spending limit of card (in cents). If not provided, spending is still subject to the spend limit set at the issuer processor account (if any).
Minimum value is 1.
Unique external identifier for the card
Token belonging to the card program under which to create the card.
Last four digits of the card
The type of card being returned
Values are UNLOCKED, MERCHANT_LOCKED, or SINGLE_USE.
The current state of the card
Values are OPEN, PAUSED, or CLOSED.
Friendly name to identify the card
Pagination Information.
Use this to drive your next request if you want the next page of results
Use this to drive your next request if you want the previous page of results
Indicates whether there are additional values beyond the ending index of the paginated results.
Unauthorized.
Forbidden.
Unable to get customers
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/customers/accounts \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"results": [
{
"address_line_one": "12 Strawberry Road",
"address_line_two": "Suite 101",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "99999-1000",
"address_country_code": "US",
"name_prefix": "Dr.",
"name_first": "Miriam",
"name_middle": "Louise",
"name_last": "Trevino",
"name_suffix": "Jr",
"passport": {
"number": "string",
"country": "JP"
},
"customer_id": "31mNprzLd2bKl6koVna68ARM",
"created_at": "2017-06-20T09:12:14+00:00",
"updated_at": "2019-02-20T09:12:14+00:00",
"is_borrower_portal_user": true,
"customer_type": "person",
"is_active": true,
"verification_status": "verified",
"title": "CFO",
"phone_number": "+14105556789",
"ssn": "888888888",
"international_customer_id": "9999999999",
"email": "marissa@protonmail.com",
"date_of_birth": "1985-06-20",
"customer_balances": {
"num_active_accounts": 2,
"total_balance_cents": 300000,
"principal_cents": 200000,
"interest_balance_cents": 60000,
"am_interest_balance_cents": 0,
"deferred_interest_balance_cents": 40000,
"am_deferred_interest_balance_cents": 0,
"fees_balance_cents": 0
},
"business_details": {
"business_legal_name": "Umbrella Corporation",
"doing_business_as": "Umbrella",
"business_ein": "888-888888",
"business_type": "llc",
"business_classification_id": "794D9D5E-B547-4B3B-8289-76484C1AFC5F",
"website": "https://example.com",
"controller": {
"address_line_one": "12 Strawberry Road",
"address_line_two": "Suite 101",
"address_city": "Atlanta",
"address_state": "GA",
"address_zip": "99999-1000",
"address_country_code": "US",
"name_prefix": "Dr.",
"name_first": "Miriam",
"name_middle": "Louise",
"name_last": "Trevino",
"name_suffix": "Jr",
"passport": {
"number": "string",
"country": "JP"
},
"title": "CFO",
"phone_number": "+14105556789",
"ssn": "888888888"
}
},
"metro2_config": {
"bloom_metadata": {
"address_type": "CONFIRMED",
"residence_type": "OWNS"
}
},
"customer_account_role": "PRIMARY",
"customer_account_external_id": "4465220133024156",
"account": {
"account_id": "31mNprzLd2bKl6koVna68ARM",
"created_at": "2017-06-20T09:12:14+00:00",
"updated_at": "2019-02-20T09:12:14+00:00",
"effective_at": "2018-03-20T09:12:28+00:00",
"account_overview": {
"account_status": "SUSPENDED",
"account_status_subtype": "BANKRUPTCY",
"is_active_scra": "false"
},
"account_product": {
"product_id": "prod_4p1sc",
"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,
"default_product_late_fee_cents": 2900,
"payment_reversal_fee_impl_cents": 2900,
"default_product_payment_reversal_fee_cents": 2900,
"origination_fee_impl_cents": 2000,
"origination_fee_percent": 12.34,
"is_origination_fee_lesser_value": false,
"is_origination_fee_amortized": false,
"annual_fee_impl_cents": 1000,
"monthly_fee_impl_cents": 500,
"recurring_fees": [
{
"recurring_fee_interval": "1 month",
"recurring_fee_amount_cents": 10000,
"initial_delay_offset": "12 days",
"is_fee_interval_floored": false,
"recurring_fee_label": "Quarterly Fee"
}
],
"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,
"default_product_promo_interest_rate": 6.2,
"promo_len": 6,
"default_product_promo_len": 6
},
"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,
"default_product_post_promo_interest_rate": 6.2,
"post_promo_len": 48,
"default_product_post_promo_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": {
"statement_min_pay_cents": 160000,
"min_pay_cents": 160000,
"min_pay_due_at": "2019-10-18T23:04:48.321+00:00"
},
"additional_min_pay_details": {
"min_pay_fees_cents": 20000,
"current_min_pay_cents": 400000,
"unpaid_min_pay_cents": 400000
},
"additional_statement_min_pay_details": {
"statement_min_pay_charges_principal_cents": 100000,
"statement_min_pay_interest_cents": 30000,
"statement_min_pay_am_interest_cents": 200,
"statement_min_pay_deferred_cents": 10000,
"statement_min_pay_am_deferred_interest_cents": 200,
"statement_min_pay_fees_cents": 20000,
"statement_payments_cents": 20000,
"previous_statement_min_pay_cents": 400000,
"statement_current_min_pay_cents": 400000,
"statement_unpaid_min_pay_cents": 400000
},
"payment_processor_config": {
"ach": {
"payment_processor_name": "REPAY",
"repay_config": {
"ach_token": "string",
"last_four": "string"
},
"dwolla_config": {
"ach_token": "string",
"last_four": "string"
},
"modern_treasury_config": {
"ach_token": "string",
"last_four": "string"
},
"canopy_nacha_config": {
"bank_routing_number": "999999992",
"bank_account_number": "987654321",
"bank_account_type": "CHECKING"
},
"stripe_config": {
"customer_id": "cus_4QE4bx4C5BVSrC",
"source_id": "string",
"external_fields": {}
},
"galileo_config": {
"plaid_processor_token": "processor-production-35cd43b-adfc-d8aa-b331-c9ba0fdha881"
}
},
"debit_card": {
"payment_processor_name": "REPAY",
"repay_config": {
"card_token": "string",
"last_four": "string"
},
"authorize_net_config": {
"customer_profile_id": "527262",
"customer_payment_profile_ids": [
"86"
]
}
},
"credit_card": {
"payment_processor_name": "CHECKOUT",
"checkout_config": {
"source_id": "cus_6artgoevd77u7ojah2wled32s",
"card_token": "string",
"last_four": "string",
"expires_on": "string"
}
},
"autopay_enabled": true,
"autopay_configs": {
"autopay_method": "TOTAL_BALANCE",
"autopay_fixed_amount_cents": 2500
},
"default_payment_processor_method": "ACH"
},
"disbursements_config": {
"disbursement_source_payout_entity_id": 1009,
"disbursement_split_percentages": {
"principal": [
{
"payout_entity_id": 1009,
"split_percent": 25
}
]
}
},
"payouts_config": {
"payout_split_percentages": {
"principal": [
{
"payout_entity_id": 1009,
"split_percent": 25
}
],
"interest": [
{
"payout_entity_id": 1009,
"split_percent": 25
}
],
"fee": [
{
"payout_entity_id": 1009,
"split_percent": 25
}
]
}
},
"issuer_processor_details": {
"lithic": {
"account_token": "349e2031-20de-40c6-87a3-214895077522"
},
"galileo": {
"account_token": "406101000684"
}
},
"cycle_type": {
"first_cycle_interval": "11 days",
"late_fee_grace": "2 days"
},
"discounts": {
"prepayment_discount_config": {
"loan_discount_cents": 800000,
"loan_discount_at": "2018-03-20T09:12:28+00:00"
}
},
"summary": {
"total_balance_cents": 300000,
"principal_cents": 200000,
"interest_balance_cents": 60000,
"am_interest_balance_cents": 0,
"deferred_interest_balance_cents": 40000,
"am_deferred_interest_balance_cents": 0,
"fees_balance_cents": 0,
"initial_principal_cents": 200000,
"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,
"interest_accrual_interval": "1 day",
"interest_grace_method": "NONE",
"available_credit_cents": 100000,
"open_to_buy_cents": 5000,
"total_payoff_cents": 900000,
"pending_am_interest_balance_cents": 900000,
"late_fee_cap_percent": 12.5,
"payment_reversal_fee_cap_percent": 6.2
},
"associated_entities": {
"merchant_name": "Acme Corporation",
"lender_name": "Globex Lending Corp"
},
"plaid_config": {
"plaid_access_token": {
"valid_config": true
},
"plaid_account_id": {
"valid_config": true
},
"check_balance_enabled": true
},
"payout_entities": [
{
"payout_entity_id": "0x1234",
"payout_entity_type": "lender",
"payout_entity_name": "Wonka Industries",
"external_fields": [
{
"key": "Umbrella Corporation",
"value": "22445702-a389-431f-927d-07b8d0750787"
}
],
"parent_payout_entity_id": "31mNprzLd2bKl6koVna68ARM",
"bank_account_number": "1001001234",
"bank_routing_number": "012345678",
"bank_account_type": "CHECKING",
"company_identification": "X000100393",
"irs_tin": "203456789"
}
],
"cards": [
{
"spend_limit": 8000000,
"lithic": {
"token": "adccd28d-532e-480b-a063-a46a77a15570",
"card_program_token": "a5e38341-cc95-4a9b-a21c-751aeca67e9c",
"last_four": "0339",
"type": "UNLOCKED",
"state": "OPEN",
"memo": "Conference Event Card"
}
}
]
}
}
],
"paging": {
"starting_after": "31mNprzLd2bKl6koVna68ARM",
"ending_before": "31mNprzLd2bKl6koVna68ARM",
"has_more": false
}
}The maximum number of customer accounts to be returned. Defaults to 12.
Minimum value is 0, maximum value is 10000.
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.
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.
Comma-separated list of active statuses of the customer to filter by (no whitespaces).
Allowed values: true, false
Comma-separated list of the product types of the accounts to filter by (no whitespaces).
Allowed values: INSTALLMENT, INVENTORY_FINANCING, REVOLVING, LOGISTICS_FINANCING, etc.
Searches by name_first, name_last, doing_business_as or business_legal_name. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.
Array of Customers and their corresponding Accounts
An array of information for all customers within the requested range.
Pagination Information.
Use this to drive your next request if you want the next page of results
Use this to drive your next request if you want the previous page of results
Indicates whether there are additional values beyond the ending index of the paginated results.
Unauthorized.
Forbidden.
Too many requests.
Unexpected Error.
curl \
-X GET https://sandbox-api.canopyservicing.com/customers \
-H "Authorization: Bearer $ACCESS_TOKEN"{
"": [
[
{}
]
],
"paging": {
"starting_after": "31mNprzLd2bKl6koVna68ARM",
"ending_before": "31mNprzLd2bKl6koVna68ARM",
"has_more": false
}
}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.
Create a new customer
Address line one.
Address line two.
Address city.
Address state.
Five digit zipcode or nine digit 'ZIP+4'.
ISO 3166-1 alpha-2 country code for the customer.
Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.
Prefix to the customer's name.
Customer's first name.
Customer's middle name.
Customer's last name.
Suffix to the customer's name.
The ID associated to be with the customer for future requests. If not provided on customer creation, Canopy will generate this field.
Format should match the following pattern: ^(?!can_).*$.
The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.
Values are person or business.
The customer can be a child customer to another parent customer. This is used most commonly to show a PERSON customer that is a child of a BUSINESS customer.
The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result.
Values are unverified, verified, retry, or document.
Title of the customer if a person OR title of the admin if a business
Customer's phone number in E.164 format.
Social security number of the customer.
Any country-specific unique identifier for the customer.
The Customer's email address.
Customer's date of birth in ISO 8601 format.
The legal name of the Business.
The DBA name of the Business.