Skip to main content
POST
/
products
Create a new product
curl --request POST \
  --url https://api.fiskil.com/v1/data-provider/cdr/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "<string>",
  "description": "<string>",
  "is_tailored": true,
  "name": "<string>",
  "product_category": "BUSINESS_LOANS",
  "additional_information": {
    "additional_bundle_uris": [
      {
        "additional_info_uri": "<string>",
        "description": "<string>"
      }
    ],
    "additional_eligibility_uris": [
      {
        "additional_info_uri": "<string>",
        "description": "<string>"
      }
    ],
    "additional_fees_and_pricing_uris": [
      {
        "additional_info_uri": "<string>",
        "description": "<string>"
      }
    ],
    "additional_overview_uris": [
      {
        "additional_info_uri": "<string>",
        "description": "<string>"
      }
    ],
    "additional_terms_uris": [
      {
        "additional_info_uri": "<string>",
        "description": "<string>"
      }
    ],
    "bundle_uri": "<string>",
    "eligibility_uri": "<string>",
    "fees_and_pricing_uri": "<string>",
    "overview_uri": "<string>",
    "terms_uri": "<string>"
  },
  "application_uri": "<string>",
  "brand_name": "<string>",
  "bundles": [
    {
      "name": "<string>",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "description": "<string>",
      "product_ids": [
        "<string>"
      ]
    }
  ],
  "card_art": [
    {
      "card_scheme": "AMEX",
      "card_type": "CHARGE",
      "image_uri": "<string>",
      "title": "<string>"
    }
  ],
  "constraints": [
    {
      "additional_value": "<string>",
      "constraint_type": "MAX_BALANCE",
      "additional_info": "<string>",
      "additional_info_uri": "<string>"
    }
  ],
  "deposit_rates": [
    {
      "application_type": "MATURITY",
      "deposit_rate_type": "BONUS",
      "rate": "<string>",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "additional_value": "<string>",
      "applicability_conditions": [
        {
          "rate_applicability_type": "MIN_DEPOSITS",
          "additional_info": "<string>",
          "additional_info_uri": "<string>",
          "additional_value": "<string>"
        }
      ],
      "application_frequency": "<string>",
      "calculation_frequency": "<string>",
      "tiers": [
        {
          "name": "<string>",
          "unit_of_measure": "DAY",
          "additional_info": "<string>",
          "additional_info_uri": "<string>",
          "applicability_conditions": [
            {
              "rate_applicability_type": "MIN_DEPOSITS",
              "additional_info": "<string>",
              "additional_info_uri": "<string>",
              "additional_value": "<string>"
            }
          ],
          "maximum_value": "<string>",
          "minimum_value": "<string>",
          "rate_application_method": "PER_TIER"
        }
      ]
    }
  ],
  "effective_from": "<string>",
  "effective_to": "<string>",
  "eligibility": [
    {
      "eligibility_type": "BUSINESS",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "additional_value": "<string>"
    }
  ],
  "features": [
    {
      "feature_type": "ADDITIONAL_CARDS",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "additional_value": "<string>"
    }
  ],
  "fees": [
    {
      "fee_method_u_type": "fixedAmount",
      "fee_type": "CASH_ADVANCE",
      "name": "<string>",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "additional_value": "<string>",
      "currency": "<string>",
      "discounts": [
        {
          "description": "<string>",
          "discount_method_u_type": "fixedAmount",
          "discount_type": "BALANCE",
          "additional_info": "<string>",
          "additional_info_uri": "<string>",
          "additional_value": "<string>",
          "eligibility": [
            {
              "discount_eligibility_type": "BUSINESS",
              "additional_info": "<string>",
              "additional_info_uri": "<string>",
              "additional_value": "<string>"
            }
          ],
          "fixed_amount": {
            "amount": "<string>"
          },
          "rate_based": {
            "rate": "<string>",
            "rate_type": "BALANCE",
            "amount_range": {
              "discount_maximum": "<string>",
              "discount_minimum": "<string>"
            }
          }
        }
      ],
      "fee_cap": "<string>",
      "fee_cap_period": "<string>",
      "fixed_amount": {
        "amount": "<string>"
      },
      "rate_based": {
        "rate": "<string>",
        "rate_type": "BALANCE",
        "accrual_frequency": "<string>",
        "amount_range": {
          "fee_maximum": "<string>",
          "fee_minimum": "<string>"
        }
      },
      "variable": {
        "fee_maximum": "<string>",
        "fee_minimum": "<string>"
      }
    }
  ],
  "instalments": {
    "maximum_split": 2,
    "minimum_split": 2,
    "instalments_limit": "<string>",
    "maximum_concurrent_plans": 1,
    "maximum_plan_value": "<string>",
    "minimum_plan_value": "<string>"
  },
  "lending_rates": [
    {
      "lending_rate_type": "BALANCE_TRANSFER",
      "loan_purpose": "INVESTMENT",
      "rate": "<string>",
      "repayment_type": "INTEREST_ONLY",
      "additional_info": "<string>",
      "additional_info_uri": "<string>",
      "additional_value": "<string>",
      "applicability_conditions": [
        {
          "rate_applicability_type": "MIN_DEPOSITS",
          "additional_info": "<string>",
          "additional_info_uri": "<string>",
          "additional_value": "<string>"
        }
      ],
      "application_frequency": "<string>",
      "calculation_frequency": "<string>",
      "comparison_rate": "<string>",
      "interest_payment_due": "IN_ADVANCE",
      "tiers": [
        {
          "name": "<string>",
          "unit_of_measure": "DAY",
          "additional_info": "<string>",
          "additional_info_uri": "<string>",
          "applicability_conditions": [
            {
              "rate_applicability_type": "MIN_DEPOSITS",
              "additional_info": "<string>",
              "additional_info_uri": "<string>",
              "additional_value": "<string>"
            }
          ],
          "maximum_value": "<string>",
          "minimum_value": "<string>",
          "rate_application_method": "PER_TIER"
        }
      ]
    }
  ]
}
'
{
  "product_id": "<string>"
}

Body

application/json

Product request body

​
brand
string
required

Institution brand managing the product.

​
description
string
required

A description of the product suitable for display to customers.

​
is_tailored
boolean
required

Indicates whether the product is specifically tailored to a circumstance.

​
name
string
required

The display name of the product shown to customers.

​
product_category
enum<string>
required

The category of the product as defined by the CDR standard.

Available options:
BUSINESS_LOANS,
BUY_NOW_PAY_LATER,
CRED_AND_CHRG_CARDS,
LEASES,
MARGIN_LOANS,
OVERDRAFTS,
PERS_LOANS,
REGULATED_TRUST_ACCOUNTS,
RESIDENTIAL_MORTGAGES,
TERM_DEPOSITS,
TRADE_FINANCE,
TRANS_AND_SAVINGS_ACCOUNTS,
TRAVEL_CARDS
​
additional_information
object
​
application_uri
string

A link to an application web page where this product can be applied for

​
brand_name
string

An optional display name for the brand.

​
bundles
object[]

Array of bundles that this product is included in

​
card_art
object[]

Array of card art images

​
constraints
object[]

An array of constraint objects.

​
deposit_rates
object[]

An array of deposit rates, e.g. interest rates for deposit products.

​
effective_from
string

The date and time from which this product is effective. If not present, the product is available immediately.

​
effective_to
string

The date and time at which this product will be retired and no longer available for new applications.

​
eligibility
object[]

An array of eligibility criteria objects.

​
features
object[]

An array of feature objects describing product capabilities.

​
fees
object[]

An array of fees associated with the product.

​
instalments
object

Details of instalment plan features on the account

​
lending_rates
object[]

An array of lending rates, e.g. interest rates for lending products.

Response

Product created successfully

​
product_id
string