Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-v
header
string
optional
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable
URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]
Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
An array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.
An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of product IDs of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also
Link to a web page with more information on the bundle criteria and benefits
productIds
[string]
optional
Array of product IDs for products included in the bundle that are available via the product end points. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points
Generic field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
additionalInfo
string
conditional
Display text providing more information on the feature. Mandatory if the feature type is set to OTHER
The type of constraint described. See the next section for an overview of valid values and their meaning
additionalValue
string
conditional
Generic field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
additionalInfo
string
optional
Display text providing more information the constraint
The type of eligibility criteria described. See the next section for an overview of valid values and their meaning
additionalValue
string
conditional
Generic field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
additionalInfo
string
conditional
Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied.
A fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
The indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory
A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee
additionalValue
string
conditional
Generic field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
additionalInfo
string
optional
Display text providing more information on the discount
The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
additionalInfo
string
optional
Display text providing more information on the rate
The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax)
The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
interestPaymentDue
string
optional
When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
repaymentType
string
optional
Options in place for repayments. If absent, the lending rate is applicable to all repayment types
loanPurpose
string
optional
The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
Generic field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
additionalInfo
string
optional
Display text providing more information on the rate.
Defines the criteria and conditions for which a rate applies
Properties
Name
Type
Required
Description
name
string
mandatory
A display name for the tier
unitOfMeasure
string
mandatory
The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a DOLLAR amount. PERCENT (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of MONTH's or DAY's (in the case of term deposit tiers)
The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound.
rateApplicationMethod
string
optional
The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps')
Fully qualified link that generated the current response document
Meta
{}
Properties
None
MetaError
{"urn":"string"}
Additional data for customised error codes
Properties
Name
Type
Required
Description
urn
string
conditional
The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.
The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» title
string
mandatory
A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detail
string
mandatory
A human-readable explanation specific to this occurrence of the problem.
The category to which a product or account belongs. See here for more details
Properties
Name
Type
Required
Description
anonymous
string
mandatory
The category to which a product or account belongs. See here for more details
Enumerated Values
Property
Value
anonymous
BUSINESS_LOANS
anonymous
CRED_AND_CHRG_CARDS
anonymous
LEASES
anonymous
MARGIN_LOANS
anonymous
OVERDRAFTS
anonymous
PERS_LOANS
anonymous
REGULATED_TRUST_ACCOUNTS
anonymous
RESIDENTIAL_MORTGAGES
anonymous
TERM_DEPOSITS
anonymous
TRADE_FINANCE
anonymous
TRANS_AND_SAVINGS_ACCOUNTS
anonymous
TRAVEL_CARDS
Product & Account Components
Product Feature Types
Description of the usage of the featureType field as it applies to products.
Value
Description
Use of additionalValue Field
ADDITIONAL_CARDS
Additional cards can be requested
The maximum number of additional cards. If no maximum then should be set to null
BALANCE_TRANSFERS
Balance transfers can be made to the account (eg. for credit cards)
NA
BILL_PAYMENT
The product can be attached to an automatic budgeting and bill payment service
Optional name of the service
BONUS_REWARDS
Bonus loyalty rewards points are available
Number of points available
CARD_ACCESS
A card is available for the product to access funds
Text describing list of card types that this product can be linked to
CASHBACK_OFFER
Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer.
The amount of the cashback offer (in AUD)
COMPLEMENTARY_PRODUCT_DISCOUNTS
Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available
Description of the complementary offering
DIGITAL_BANKING
Access is available to online banking features for the product
NA
DIGITAL_WALLET
A Digital wallet can be attached to the product
The name or brand of the wallet
DONATE_INTEREST
Indicates that interest generated from the product can be automatically donated to a charity or community group
NA
EXTRA_REPAYMENTS
Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis).
NA
FRAUD_PROTECTION
The product includes fraud protection features.
NA
FREE_TXNS
A set number of free transactions available per month
The number of free transactions
FREE_TXNS_ALLOWANCE
A set amount of transaction fee value that is discounted per month
The amount of transaction fee discounted (in AUD)
GUARANTOR
Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process.
NA
INSURANCE
Insurance is provided as an additional feature of the product
Text description of the type of insurance (e.g. Travel Insurance)
INSTALMENT_PLAN
The product has the option to pay for eligible purchases over time with a set number of payments.
A fee associated with making a purchase at a merchant
NA
TRANSACTION
A fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE)
NA
UPFRONT
A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee
NA
VARIABLE
An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer
NA
WITHDRAWAL
A fee associated with making a withdrawal
NA
Product Discount Types
Description of the usage of the discountType field as it applies to products.
Value
Description
Use of additionalValue Field
BALANCE
Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee
The minimum balance in AmountString format
DEPOSITS
Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee
The minimum deposit amount in AmountString format
ELIGIBILITY_ONLY
Discount applies based on customer eligibility (eligibility array must be populated)
N/A
FEE_CAP
The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period
The time period for which the fee cap applies. Formatted according to ISO 8601 Durations
PAYMENTS
Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee
The payment threshold amount in AmountString format
Product Discount Eligibility Types
Description of the usage of the discountEligibilityType field as it applies to products.
Value
Description
Use of additionalValue Field
BUSINESS
A business or other non-person legal entity
NA
EMPLOYMENT_STATUS
An eligibility constraint based on employment status applies
A description of the status required
INTRODUCTORY
The discount is only available during an introductory period
The period of time for the introductory discount. Formatted according to ISO 8601 Durations
MAX_AGE
Only customers younger than a maximum age receive the discount
The maximum age in years
MIN_AGE
Only customers older than a minimum age receive the discount
The minimum age in years
MIN_INCOME
The customer must have an income greater than a specified threshold to obtain the discount
Minimum income in AmountString format
MIN_TURNOVER
Only a business with greater than a minimum turnover is eligible
Minimum turnover in AmountString format
NATURAL_PERSON
The customer must be a natural person rather than another legal entity
NA
OTHER
Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory)
NA
PENSION_RECIPIENT
Only a recipient of a government pension may receive the discount
Optional. Should contain a description of which pensions qualify
RESIDENCY_STATUS
An eligibility constraint based on residency status applies
A description of the status required
STAFF
Only a staff member of the provider may receive the discount
NA
STUDENT
Only students may receive the discount
Optional. Should contain a description of who qualifies as a student, e.g. do apprentices qualify?
Product Deposit Rate Types
Description of the usage of the depositRateType field as it applies to products.
Deposit Base Rate Types
A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
A floating rate is relatively fixed but still adjusts under specific circumstances
Details of the float parameters
MARKET_LINKED
A rate that is linked to a specific market, commodity or asset class
Details of the market linkage
VARIABLE
A variable base rate for the product
NA
Deposit Adjustment Rate Types
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
Value
Description
Use of additionalValue Field
BONUS
A bonus rate available by meeting a specific criteria
A description of the criteria to obtain the bonus
BUNDLE_BONUS
A bonus rate obtained by originating a bundle instead of a standalone product
The name of the bundle
INTRODUCTORY
An introductory bonus that will expire after a set period
The period of time for the introductory rate. Formatted according to ISO 8601 Durations
Product Lending Rate Types
Description of the usage of the lendingRateType field as it applies to products.
Lending Base Rate Types
A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.
Value
Description
Use of additionalValue Field
CASH_ADVANCE
Specific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only
A floating rate is relatively fixed but still adjusts under specific circumstances
Details of the float parameters
MARKET_LINKED
A rate that is linked to a specific market, commodity or asset class
Details of the market linkage
PURCHASE
Specific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only
NA
VARIABLE
A variable base rate for the product
NA
Lending Adjustment Rate Types
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
Value
Description
Use of additionalValue Field
BUNDLE_DISCOUNT_FIXED
A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product
The name of the bundle
BUNDLE_DISCOUNT_VARIABLE
A discount rate off the variable rate obtained by originating a bundle instead of a standalone product
The name of the bundle
DISCOUNT
A specific discount rate that may be applied. A discount rate reduces the interest payable
Description of the discount rate that is applicable
INTRODUCTORY
An introductory discount that will expire after a set period
The period of time for the introductory rate. Formatted according to ISO 8601 Durations
PENALTY
A specific penalty rate that may be applied. A penalty rate increases the interest payable
Description of the penalty rate that is applicable
Banking Term Deposit Account Types
Description of the usage of the maturityInstructions field as it applies to accounts.
Value
Description
Use of additionalValue Field
HOLD_ON_MATURITY
Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer
