Skip to main content

LendingRate

iduuid

internal ID of the lending rate

lendingRateTypeLendingRateTyperequired

The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning

Possible values: [BALANCE_TRANSFER, BUNDLE_DISCOUNT_FIXED, BUNDLE_DISCOUNT_VARIABLE, CASH_ADVANCE, DISCOUNT, FIXED, FLOATING, INTRODUCTORY, MARKET_LINKED, PENALTY, PURCHASE, VARIABLE]

ratestringrequired

The rate to be applied

tiers object[]

Rate tiers applicable for this rate

  • Array [
  • iduuid

    internal ID of the tier

    namestringrequired

    A display name for the tier

    unitOfMeasureTierUnitOfMeasureTyperequired

    The unit of measure that applies to the minimumValue and maximumValue 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)

    Possible values: [DAY, DOLLAR, MONTH, PERCENT]

    minimumValuenumberrequired

    The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value

    maximumValuenumber

    The number of unitOfMeasure 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 minimumValue. Where this is the same as the minimumValue 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.

  • ]
  • additionalValuestring
    LendingRate
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lendingRateType": "BALANCE_TRANSFER",
    "rate": "string",
    "tiers": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "unitOfMeasure": "DAY",
    "minimumValue": 0,
    "maximumValue": 0
    }
    ],
    "additionalValue": "string"
    }