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.
Unique identifier for the product. Must be unique across your organisation. Cannot be changed after creation. Validation: ASCII string, max 100 characters
The display name of the product shown to customers. Validation: Max 200 characters
A description of the product suitable for display to customers. Validation: Max 2000 characters
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
A label of the brand for the product. Validation: Max 200 characters
An optional display name for the brand. Validation: Max 200 characters
Indicates whether the product is specifically tailored to a circumstance. Default: false
Effective dates
Control when the product is available.
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)
The date and time at which this product will be retired and no longer available for new applications. Format: ISO 8601 datetime
The last date and time this product was updated. Automatically set by the system. Format: ISO 8601 datetime
Links to supporting documentation.
additionalInformation.overviewUri
Link to a general overview of the product. Validation: Valid HTTPS URI
additionalInformation.termsUri
Link to terms and conditions for the product. Validation: Valid HTTPS URI
additionalInformation.eligibilityUri
Link to eligibility criteria for the product. Validation: Valid HTTPS URI
additionalInformation.feesAndPricingUri
Link to fees and pricing information. Validation: Valid HTTPS URI
additionalInformation.bundleUri
Link to bundle information if the product is part of a bundle. Validation: Valid HTTPS URI
Features
Product features describe capabilities of the product.
An array of feature objects describing product capabilities. The type of feature. See CDR standard for full list. Common values:
CARD_ACCESS
DIGITAL_BANKING
NPP_ENABLED
OFFSET
REDRAW
UNLIMITED_TXNS
Additional value for the feature, if required by the feature type.
Additional information about the feature.
Link to more information about the feature. Validation: Valid HTTPS URI
Eligibility
Eligibility criteria define who can apply for the product.
An array of eligibility criteria objects. Show Eligibility properties
The type of eligibility criteria. Allowed values:
BUSINESS
EMPLOYMENT_STATUS
MAX_AGE
MIN_AGE
MIN_INCOME
MIN_TURNOVER
NATURAL_PERSON
OTHER
PENSION_RECIPIENT
RESIDENCY_STATUS
STAFF
STUDENT
Additional value for the criteria, if required by the eligibility type.
Additional information about the eligibility criteria.
Link to more information about eligibility. Validation: Valid HTTPS URI
Fees
Fees associated with the product.
An array of fee objects. The type of fee. Common values:
DEPOSIT
EVENT
EXIT
PAYMENT
PERIODIC
PURCHASE
TRANSACTION
UPFRONT
VARIABLE
WITHDRAWAL
The amount of the fee. Required unless balanceRate, transactionRate, or accruedRate is present. Format: Decimal string (e.g., "10.00")
A fee rate calculated based on account balance. Format: Decimal rate (e.g., "0.01" for 1%)
A fee rate calculated based on transaction amount. Format: Decimal rate
The currency of the fee. Default: AUD
Additional value for the fee, if required by fee type.
Additional information about the fee.
Link to more information about the fee. Validation: Valid HTTPS URI
Discounts that may apply to this fee.
Deposit rates
Interest rates for deposit products.
An array of deposit rate objects. Show Deposit rate properties
The type of deposit rate. Allowed values:
BONUS
BUNDLE_BONUS
FIXED
FLOATING
INTRODUCTORY
MARKET_LINKED
VARIABLE
The interest rate. Format: Decimal rate (e.g., "0.045" for 4.5%)
How frequently interest is calculated. Format: ISO 8601 duration (e.g., P1D for daily)
How frequently interest is applied. Format: ISO 8601 duration (e.g., P1M for monthly)
Rate tiers for tiered interest rates.
Additional value for the rate, if required by rate type.
Additional information about the rate.
Link to more information about the rate. Validation: Valid HTTPS URI
Lending rates
Interest rates for lending products.
An array of lending rate objects. Show Lending rate properties
The type of lending rate. Allowed values:
BUNDLE_DISCOUNT_FIXED
BUNDLE_DISCOUNT_VARIABLE
CASH_ADVANCE
DISCOUNT
FIXED
FLOATING
INTRODUCTORY
MARKET_LINKED
PENALTY
PURCHASE
VARIABLE
The interest rate. Format: Decimal rate (e.g., "0.065" for 6.5%)
The comparison rate for the lending product. Format: Decimal rate
How frequently interest is calculated. Format: ISO 8601 duration
How frequently interest is applied. Format: ISO 8601 duration
When interest is payable. Allowed values: The repayment type. Allowed values:
INTEREST_ONLY
PRINCIPAL_AND_INTEREST
The purpose of the loan. Allowed values:
INVESTMENT
OWNER_OCCUPIED
Rate tiers for tiered interest rates.
Additional value for the rate, if required by rate type.
Additional information about the rate.
Link to more information about the rate. Validation: Valid HTTPS URI
Bundles
Product bundles group related products together.
An array of bundle objects. Description of the bundle.
Additional information about the bundle.
Link to more information about the bundle. Validation: Valid HTTPS URI
Array of product IDs included in the bundle.
Constraints
Constraints on the product.
An array of constraint objects. Show Constraint properties
The type of constraint. Allowed values:
MAX_BALANCE
MAX_LIMIT
MIN_BALANCE
MIN_LIMIT
OPENING_BALANCE
The value of the constraint. Format: Decimal string for amounts
Additional information about the constraint.
Link to more information about the constraint. Validation: Valid HTTPS URI