Responses

• 200 application/json

  Product

  Hide response attributes Show response attributes object

  • product_id string Required

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

  • created_at string(date-time)

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

  • effective_at string(date-time)

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

  • product_overview object Required

    A series of static fields about the product.

    Hide product_overview attributes Show product_overview attributes object

    • product_name string Required

      Name of Product, i.e. Express Card.

    • product_type string Required

      The Type of Product

    • product_short_description string | null

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

    • product_long_description string | null Required

      Description of the Product ranging from 0 - 1000.

    • product_color string

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

      Default value is #4867FF.

    • external_fields array[object] | null

      Not more than 1000 elements.

      Hide external_fields attributes Show external_fields attributes object

      • key string
      • value string
  • product_lifecycle_policies object Required
    Hide product_lifecycle_policies attributes Show product_lifecycle_policies attributes object

    • payment_due_policies object

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

      Hide payment_due_policies attributes Show payment_due_policies attributes object

      • delinquent_on_n_consecutive_late_fees integer

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

        Default value is 1.

      • charge_off_on_n_consecutive_late_fees integer

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

        Default value is 2.

    • payment_pouring_policies object

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

      Hide payment_pouring_policies attribute Show payment_pouring_policies attribute object

      • pending_pmt_affects_avail_credit boolean

        Indicates whether pending payments affect available credit.

        Default value is false.

    • fee_policies object

      The set of policies governing fees for the product.

      Hide fee_policies attributes Show fee_policies attributes object

      • late_fee_grace string

        Amount of time between when a payment is due and when a late fee is assessed if no payments have been made.

        Default value is 5 days.

      • surcharge_fee_interval string | null

        The interval at which a surcharge fee is assessed.

      • default_surcharge_fee_structure array[object] | null

        The transaction volume structure that dictates a transaction fee.

        Hide default_surcharge_fee_structure attributes Show default_surcharge_fee_structure attributes object

        • surcharge_start_inclusive_cents integer Required

          Indicates the starting transaction volume at which this fee will apply.

        • surcharge_end_exclusive_cents integer

          Indicates the ending transaction volume at which this fee will apply. If not provided, the surcharge will apply to any transaction volume above the defined start.

          Default value is 100000000000000000000.

        • percent_surcharge number Required

          Indicates the surcharge fee as a percent of total transaction volume that will be applied to the account if the total transaction volume during the surcharge interval falls within the provided start and end range.

    • billing_cycle_policies object

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

      Hide billing_cycle_policies attributes Show billing_cycle_policies attributes object

      • cycle_interval string Required

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

      • cycle_due_interval string

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

        Default value is -5 days.

      • first_cycle_interval string

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

      • close_of_business_time string(time)

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

        Default value is 23:59:59-05:00.

      • product_time_zone string

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

        Default value is America/New_York.

    • interest_policies object

      The Interest Policy Object

      Additional properties are NOT allowed.

      Hide interest_policies attributes Show interest_policies attributes object

      • interest_calc_time string(time)

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

        Default value is 01:00:00-05:00.

      • interest_accrual_interval string

        Defaults to cycle interval. Interest for this policy is calculated every interval specified.

        Default value is 1 month.

    • default_attributes object
      Hide default_attributes attributes Show default_attributes attributes object

      • default_credit_limit_cents integer Required

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

        Default value is 0.

      • default_late_fee_cents integer

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

        Default value is 0.

      • default_payment_reversal_fee_cents integer

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

        Default value is 0.

  • promotional_policies object Required

    If applicable, a promotional configuration for the product.

    Hide promotional_policies attributes Show promotional_policies attributes object

    • promo_len integer

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

      Default value is 0.

    • promo_min_pay_type string

      Current due calculation method for the promotional period.

      Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, PERCENT_PRINCIPAL_INTEREST, or NONE. Default value is NONE.

    • promo_purchase_window_len integer

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

      Default value is 0.

    • promo_min_pay_percent number

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

      Default value is 100.

    • promo_interest_deferred boolean

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

      Default value is false.

    • promo_reset_on_first_charge boolean

      If set to true, the promo end date will be reset to end of current cycle + promo_len when the account draws its first charge during the promo period. If no charges occur during the promo period, the promo period will still end on the date set at account creation.

      Default value is false.

    • promo_default_interest_rate_percent number

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

      Default value is 0.

    • promo_apr_range_inclusive_lower number

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

      Default value is 0.

    • promo_apr_range_inclusive_upper number

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

      Default value is 0.

  • post_promotional_policies object
    Hide post_promotional_policies attributes Show post_promotional_policies attributes object

    • post_promo_len integer | null

      Default duration for the amortization period during post-promotion

    • post_promo_am_len_range_inclusive_lower integer | null

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

    • post_promo_am_len_range_inclusive_upper integer | null

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

    • post_promo_min_pay_type string

      Current due calculation method for the post-promotional period.

      Values are AM, PERCENT_INTEREST, PERCENT_PRINCIPAL, or NONE. Default value is AM.

    • post_promo_default_interest_rate_percent number | null

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

    • post_promo_apr_range_inclusive_lower number | null

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

    • post_promo_apr_range_inclusive_upper number | null

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

  • product_summary object

    Summary of product information

    Hide product_summary attribute Show product_summary attribute object

    • accounts_overview object
      Hide accounts_overview attribute Show accounts_overview attribute object

      • account_count_total integer Required

        Total number of accounts under the product.

  • admin object
    Hide admin attribute Show admin attribute object

    • migration_mode boolean

      If migration mode is on, Canopy will stop auto-generating statements for this account.

      Default value is false.

• 401

  Unauthorized.

• 403

  Forbidden.

• 422

  Invalid input

• 429

  Too many requests.

• default

  Unexpected Error.