EndpointsProducts

Create a product

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
product_namestringRequired
organisation_idintegerOptional
min_rangeintegerOptional
max_rangeintegerOptional
min_amountdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
max_amountdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
min_abn_ageintegerOptional
max_abn_ageintegerOptional
min_asset_ageintegerOptional
max_asset_ageintegerOptional
min_gst_ageintegerOptional
max_gst_ageintegerOptional
min_asset_age_plus_termintegerOptional
max_asset_age_plus_termintegerOptional
min_credit_scoreintegerOptional
max_credit_scoreintegerOptional
monthly_feedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
documentation_feedoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
brokerage_capdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
maximum_brokerage_limitdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
compounding_frequencyenumOptional

Compounding frequency:

  • w - Weekly
  • m - Monthly
  • q - Quarterly
  • y - Yearly
brokerage_loading_treatmentdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
max_origination_fee_limitdoubleOptional2.2250738585072014e-308-1.7976931348623157e+308Defaults to 0
doc_fee_financedenumOptional

Tri-state choice for product/rate bracket feature flags

private_saleenumOptional

Tri-state choice for product/rate bracket feature flags

sale_hire_backenumOptional

Tri-state choice for product/rate bracket feature flags

home_ownerenumOptional

Tri-state choice for product/rate bracket feature flags

Response

Product created
idintegerOptional
product_namestringOptional
messagestringOptional

Errors

400
Create Product Request Bad Request Error