Skip to main content

Product fields reference

This reference documents all fields available when creating or editing products in Product Portal. Fields are organised by section as they appear in the Fiskil Console.

Core product fields

These fields are required for all products.
productId
string
required
Unique identifier for the product. Must be unique across your organisation. Cannot be changed after creation.Validation: ASCII string, max 100 characters
name
string
required
The display name of the product shown to customers.Validation: Max 200 characters
description
string
required
A description of the product suitable for display to customers.Validation: Max 2000 characters
productCategory
enum
required
The category of the product as defined by the CDR standard.Allowed values:
  • BUSINESS_LOANS
  • 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
brand
string
required
A label of the brand for the product.Validation: Max 200 characters
brandName
string
An optional display name for the brand.Validation: Max 200 characters
isTailored
boolean
required
Indicates whether the product is specifically tailored to a circumstance.Default: false

Effective dates

Control when the product is available.
effectiveFrom
datetime
The date and time from which this product is effective. If not present, the product is available immediately.Format: ISO 8601 datetime (e.g., 2024-01-15T00:00:00Z)
effectiveTo
datetime
The date and time at which this product will be retired and no longer available for new applications.Format: ISO 8601 datetime
lastUpdated
datetime
The last date and time this product was updated. Automatically set by the system.Format: ISO 8601 datetime

Additional information

Links to supporting documentation.
additionalInformation.overviewUri
string
Link to a general overview of the product.Validation: Valid HTTPS URI
additionalInformation.termsUri
string
Link to terms and conditions for the product.Validation: Valid HTTPS URI
additionalInformation.eligibilityUri
string
Link to eligibility criteria for the product.Validation: Valid HTTPS URI
additionalInformation.feesAndPricingUri
string
Link to fees and pricing information.Validation: Valid HTTPS URI
additionalInformation.bundleUri
string
Link to bundle information if the product is part of a bundle.Validation: Valid HTTPS URI

Features

Product features describe capabilities of the product.
features
array
An array of feature objects describing product capabilities.

Eligibility

Eligibility criteria define who can apply for the product.
eligibility
array
An array of eligibility criteria objects.

Fees

Fees associated with the product.
fees
array
An array of fee objects.

Deposit rates

Interest rates for deposit products.
depositRates
array
An array of deposit rate objects.

Lending rates

Interest rates for lending products.
lendingRates
array
An array of lending rate objects.

Bundles

Product bundles group related products together.
bundles
array
An array of bundle objects.

Constraints

Constraints on the product.
constraints
array
An array of constraint objects.