Create a new product
Create a new banking product with the provided details
Create a new banking product with the provided details
Authorization
bearerAuth OAuth 2.0 access token from the token endpoint. See Platform API authentication.
In: header
Request Body
application/json
Product request body
Show 10 child attributes
Additional links to bundle information if the product is part of a bundle.
Show array item attributes
URI of the additional information.
Description of the additional information URI.
Additional links to eligibility criteria for the product.
Show array item attributes
Additional links to fees and pricing information.
Show array item attributes
Additional links to a general overview of the product.
Show array item attributes
Additional links to terms and conditions for the product.
Show array item attributes
Link to bundle information if the product is part of a bundle.
Link to eligibility criteria for the product.
Link to fees and pricing information.
Link to a general overview of the product.
Link to terms and conditions for the product.
A link to an application web page where this product can be applied for
Institution brand managing the product.
An optional display name for the brand.
Array of bundles that this product is included in
Show array item attributes
Display text providing more information on the bundle
Link to a web page with more information on the bundle criteria and benefits
Description of the bundle.
Name of the bundle.
List of product IDS for the other products that are included in the bundle and are available via the product API Note that any products not available in the product API should not be included.
Array of card art images
Show array item attributes
"AMEX" | "EFTPOS" | "MASTERCARD" | "VISA" | "OTHER""CHARGE" | "CREDIT" | "DEBIT"URI reference to a PNG, JPG, or GIF image. May be a link or a URL encoded data URI
Display label for the specific image
An array of constraint objects.
Show array item attributes
Additional information about the constraint.
Link to more information about the constraint.
The value of the constraint.
The type of constraint.
"MAX_BALANCE" | "MAX_LIMIT" | "MIN_BALANCE" | "MIN_LIMIT" | "MIN_LVR" | "MAX_LVR" | "OPENING_BALANCE" | "OTHER"An array of deposit rates, e.g. interest rates for deposit products.
Show array item attributes
Additional information about the rate.
Link to more information about the rate.
Additional value for the rate, if required by rate type.
Applicability conditions for the rate.
Show array item attributes
Display text providing more information on the condition.
Link to a web page with more information on this condition.
Generic field containing additional information relevant to the rateApplicabilityType specified.
Category of applicability condition associated with the rate.
"MIN_DEPOSITS" | "MIN_DEPOSIT_AMOUNT" | "DEPOSIT_BALANCE_INCREASED" | "EXISTING_CUST" | "NEW_ACCOUNTS" | "NEW_CUSTOMER" | "NEW_CUSTOMER_TO_GROUP" | "ONLINE_ONLY" | "OTHER" | "MIN_PURCHASES" | "MAX_WITHDRAWALS" | "MAX_WITHDRAWAL_AMOUNT"How frequently interest is applied.
The type of approach used to apply the rate to the account.
"MATURITY" | "PERIODIC" | "UPFRONT"How frequently interest is calculated.
The type of deposit rate.
"BONUS" | "BUNDLE_BONUS" | "FIXED" | "FLOATING" | "INTRODUCTORY" | "MARKET_LINKED" | "VARIABLE"The interest rate.
Rate tiers for tiered interest rates.
Show array item attributes
Display text providing more information on the rate tier.
Link to a web page with more information on this rate tier.
Applicability conditions for the rate tier.
Show array item attributes
The number of unitOfMeasure units that form the upper bound of the tier or band.
The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value.
A display name for the tier.
The method used to calculate the amount to be applied using one or more tiers.
"PER_TIER" | "WHOLE_BALANCE"The unit of measure that applies to the minimumValue and maximumValue values.
"DAY" | "DOLLAR" | "MONTH" | "PERCENT"A description of the product suitable for display to customers.
The date and time from which this product is effective. If not present, the product is available immediately.
The date and time at which this product will be retired and no longer available for new applications.
An array of eligibility criteria objects.
Show array item attributes
Additional information about the eligibility criteria.
Link to more information about eligibility.
Additional value for the criteria, if required by the eligibility type.
The type of eligibility criteria.
"BUSINESS" | "EMPLOYMENT_STATUS" | "MAX_AGE" | "MIN_AGE" | "MIN_INCOME" | "MIN_TURNOVER" | "NATURAL_PERSON" | "OTHER" | "PENSION_RECIPIENT" | "RESIDENCY_STATUS" | "STAFF" | "STUDENT"An array of feature objects describing product capabilities.
Show array item attributes
Additional information about the feature.
Link to more information about the feature.
Additional value for the feature, if required by the feature type.
The type of feature. See CDR standard for full list.
"ADDITIONAL_CARDS" | "BALANCE_TRANSFERS" | "BILL_PAYMENT" | "BONUS_REWARDS" | "CARD_ACCESS" | "CASHBACK_OFFER" | "COMPLEMENTARY_PRODUCT_DISCOUNTS" | "DIGITAL_BANKING" | "DIGITAL_WALLET" | "DONATE_INTEREST" | "EXTRA_DOWN_PAYMENT" | "EXTRA_REPAYMENTS" | "FRAUD_PROTECTION" | "FUNDS_AVAILABLE_AFTER" | "FREE_TXNS" | "FREE_TXNS_ALLOWANCE" | "FUNDS_AVAILABLE_AFTER" | "GUARANTOR" | "INSURANCE" | "INSTALMENT_PLAN" | "INTEREST_FREE" | "INTEREST_FREE_TRANSFERS" | "LOYALTY_PROGRAM" | "NOTIFICATIONS" | "NPP_ENABLED" | "NPP_PAYID" | "OFFSET" | "OTHER" | "OVERDRAFT" | "REDRAW" | "RELATIONSHIP_MANAGEMENT" | "UNLIMITED_TXNS"An array of fees associated with the product.
Show array item attributes
Show array item attributes
Must be amountstring if discount type is BALANCE, DEPOSIT, or PAYMENTS. If discount type is FEE_CAP must be an iso8601 duration
"fixedAmount" | "rateBased""BALANCE" | "DEPOSITS" | "ELIGIBILITY_ONLY" | "FEE_CAP" | "PAYMENTS"Show array item attributes
"BUSINESS" | "EMPLOYMENT_STATUS" | "INTRODUCTORY" | "MAX_AGE" | "MIN_AGE" | "MIN_INCOME" | "MIN_TURNOVER" | "NATURAL_PERSON" | "OTHER" | "PENSION_RECIPIENT" | "RESIDENCY_STATUS" | "STAFF" | "STUDENT"Show 1 child attribute
The specific amount discounted from the fee each time it is incurred
Show 3 child attributes
Show 2 child attributes
The maximum fee discount that will be applied per occurrence
The minimum fee discount that will be applied per occurrence
The rate used to calculate the discount
The property that the fee is based on
- BALANCE means the fee will be determined based on the current account balance
- FEE means the discount is based on the fee amount
- INTEREST ACCRUED means the discount is based on the total interest accrued
- TRANSACTION means the discount is based on a transaction
"BALANCE" | "FEE" | "INTEREST_ACCRUED" | "TRANSACTION"The cap amount if multiple occurrences of the fee are capped to a limit
The duration over which multiple occurrences of the fee will be capped, formatted as an ISO8601 duration
The method for defining the fee amount
"fixedAmount" | "rateBased" | "variable""CASH_ADVANCE" | "DEPOSIT" | "DISHONOUR" | "ENQUIRY" | "EVENT" | "EXIT" | "LATE_PAYMENT" | "OTHER" | "PAYMENT" | "PERIODIC" | "PURCHASE" | "REPLACEMENT" | "TRANSACTION" | "UPFRONT" | "UPFRONT_PER_PLAN" | "VARIATION" | "WITHDRAWAL"A specific amount fee. Required if fee_method_u_type is fixedAmount
Show 1 child attribute
The fee amount is a rate dependent on something else. Required if fee_method_u_type is rateBased
Show 4 child attributes
The indicative frequency with which the fee is calculated on the account, if applicable
Show 2 child attributes
The maximum fee charged per occurrence
The minimum fee charged per occurrence
The fee rate
Value that the rate will be applied to.
- BALANCE means the fee will be determined as a rate of the current account balance
- INTEREST_ACCRUED means the fee will be determined as a rate of the total interest accrued
- TRANSACTION means the fee will be determined as a rate of a transaction
"BALANCE" | "INTEREST_ACCRUED" | "TRANSACTION"The fee amount or rate is unknown until the fee is incurred. Required if fee_method_u_type is variable
Show 2 child attributes
Details of instalment plan features on the account
Show 6 child attributes
Maximum combined limit of all instalment plans that may be created on the account.
Maximum number of concurrent, active instalment plans that may be created on the account. If unset, there is no predetermined maximum number
0 <= valueMaximum value that can be opened as an instalment plan. If unset, instalments_limit is assumed to be the maximum individual plan value
Maximum number of instalment payments a plan can be created with
1 <= valueMinimum value that can be opened as an instalment plan
Minimum number of instalment payments a plan can be created with
1 <= valueIndicates whether the product is specifically tailored to a circumstance.
An array of lending rates, e.g. interest rates for lending products.
Show array item attributes
Additional information about the rate.
Link to more information about the rate.
Additional value for the rate, if required by rate type.
Applicability conditions for the rate.
Show array item attributes
How frequently interest is applied.
The type of approach used to apply the rate to the account.
"MATURITY" | "PERIODIC" | "UPFRONT"How frequently interest is calculated.
The comparison rate for the lending product.
When interest is payable.
"IN_ADVANCE" | "IN_ARREARS"The type of lending rate.
"BALANCE_TRANSFER" | "BUNDLE_DISCOUNT_FIXED" | "BUNDLE_DISCOUNT_VARIABLE" | "CASH_ADVANCE" | "DISCOUNT" | "FIXED" | "FLOATING" | "INTRODUCTORY" | "MARKET_LINKED" | "PENALTY" | "PURCHASE" | "VARIABLE"The purpose of the loan.
"INVESTMENT" | "OWNER_OCCUPIED" | "OTHER" | "UNCONSTRAINED"The interest rate.
The repayment type.
"INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST" | "OTHER" | "UNCONSTRAINED"Rate tiers for tiered interest rates.
Show array item attributes
The display name of the product shown to customers.
The category of the product as defined by the CDR standard.
"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"Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/products" \ -H "Content-Type: application/json" \ -d '{ "brand": "string", "description": "string", "is_tailored": true, "name": "string", "product_category": "BUSINESS_LOANS" }'{ "product_id": "string"}{ "property1": "string", "property2": "string"}{ "property1": "string", "property2": "string"}