Create a new product

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

effective_at

date-time

Defaults to 1900-01-01T12:00:00+00:00

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

product_id

string

^(?!can_).*$

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

product_overview

object

required

A series of static fields about the product.

product_lifecycle_policies

object

required

promotional_policies

object

required

If applicable, a promotional configuration for the product.

post_promotional_policies

object

interest_management_policies

object

admin

object

metro2_config

object

Metro2 credit reporting configs

HTTP Status Codes

200      Product

401 Unauthorized.

403 Forbidden.

409 Conflict.

422 Invalid input

429 Too many requests.

default Unexpected Error.

cURL Example

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/products \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "effective_at": "1900-01-01T12:00:00+00:00",\n  "product_overview": {\n    "product_type": "REVOLVING",\n    "product_color": "#000000"\n  },\n  "product_lifecycle_policies": {\n    "payment_due_policies": {\n      "delinquent_on_n_consecutive_late_fees": 1,\n      "charge_off_on_n_consecutive_late_fees": 2,\n      "pre_statement_payments_reduce_min_pay": false\n    },\n    "payment_pouring_policies": {\n      "pending_pmt_affects_avail_credit": false\n    },\n    "fee_policies": {\n      "late_fee_grace": "5 days"\n    },\n    "billing_cycle_policies": {\n      "cycle_due_interval": "-5 days",\n      "close_of_business_time": "23:59:59-05:00",\n      "product_time_zone": "America/New_York"\n    },\n    "interest_policies": {\n      "interest_calc_time": "01:00:00-05:00",\n      "interest_calc_method": "30_day_end_bal_365",\n      "interest_calc_balance_type": "ENDING",\n      "interest_year_length": 365,\n      "interest_grace_method": "NONE",\n      "revolving_interest_applicable_balance": "PRINCIPAL",\n      "installment_interest_applicable_balance": "EXPECTED",\n      "is_limited_to_loan_duration": false\n    },\n    "default_attributes": {\n      "default_late_fee_cents": 0,\n      "default_payment_reversal_fee_cents": 0\n    }\n  },\n  "promotional_policies": {\n    "promo_len": 0,\n    "promo_min_pay_type": "NONE",\n    "promo_purchase_window_len": 0,\n    "promo_interest_deferred": false,\n    "promo_reset_on_first_charge": false,\n    "promo_default_interest_rate_percent": 0,\n    "promo_min_pay_percent": 100,\n    "promo_apr_range_inclusive_lower": 0,\n    "promo_apr_range_inclusive_upper": 0\n  },\n  "post_promotional_policies": {\n    "post_promo_min_pay_type": "AM",\n    "post_promo_default_interest_rate_percent": 0\n  },\n  "interest_management_policies": {\n    "missed_and_under_payment": "NONE",\n    "over_and_early_payment": "NONE"\n  },\n  "admin": {\n    "migration_mode": false\n  }\n}\n'

Conclusion

Did this page help you?

Yes

No