Interest rate API

This API is:Public
Business purpose:To provide any user with the ability to retrieve ASB product interest rates 
HTTP Methods:GET 
Request URL:https://api.asb.co.nz/public/v1/interest-rates 

Requests

The following parameters are supported in JSON format

Parameter             
Mandatory
Type         Description   

productGroup

No

String

Filter by product group (Transaction/Investment/Lending/Credit Card)

productNameNoStringFilter by product name

$fields

No

String

Specify the properties to include in the result set. E.g. $fields=productName,interestRate

$orderby

No

String

Specify the sort order, if not specified, by default the result is sorted firstly by productGroup, and then by productName

$offsetNoIntegerPage offset (number of records to skip)
$limitNoIntegerPage size (number of records to retrieve)

On top filtering by product group and product name, filtering can be done on any applicable field, such as termInMonths, planDescription, etc.

Sample Request/s:

https://api.asb.co.nz/public/v1/interest-rates

https://api.asb.co.nz/public/v1/interest-rates?productGroup=Lending

https://api.asb.co.nz/public/v1/interest-rates?productName=Term Deposit

Responses

Responses are in JSON format

Parameter             Type           Description   

productGroup

String

Product group of interest bearing product (Transaction/Investment/Lending/Credit Card).

productName

String

Name of the ASB product, e.g. "Housing Variable".

interestRate

Decimal

Interest rate expressed in percentage value, e.g. 5.75 means 5.75%.
typestringUsed to differentiate between different rate types.
termInDaysIntegerProduct's term in number of days. This is only available for products with a term that's counted in days. For example, 60 day term deposit.
termInMonthsIntegerProduct's term in number of months. This is only available for products with a fixed term that's counted in months. For example, 4 month Term Deposit, Fixed term Loan.
minimumBalanceDecimal

Minimum balance condition for the interest rate. This is only available for term deposits and certain saving accounts.

Note: when there are multiple interest rates for the same product (and term) with different minimum balance, the higher minimum balance takes precedence.

planDescriptionStringDescription of this particular interest plan. For example: "Purchase", "Cash Advance" for credit cards.

Return Codes:

The specific return codes for this API are: 

Code           Description   

200

Success

400

Bad Request

500

Internal Server Error

503

Service Unavailable – API service is currently unavailable

Sample Response/s:

GET https://api.asb.co.nz/public/v1/interest-rates

{
    "value": [
    { "productGroup": "Transaction", "productName": "Headstart", "interestRate": 2.25 },
    { "productGroup": "Transaction", "productName": "Job starter's", "interestRate": 0.00 },
    { "productGroup": "Transaction", "productName": "Tertiary", "interestRate": 0.00 },
    { "productGroup": "Transaction", "productName": "Graduate", "interestRate": 0.00 },
    { "productGroup": "Transaction", "productName": "Unlimited", "interestRate": 1.00, "minimumBalance": 0 },
    { "productGroup": "Transaction", "productName": "Unlimited", "interestRate": 2.50, "minimumBalance": 100000 },
    { "productGroup": "Transaction", "productName": "Savings Plus", "interestRate": 1.00 },
    { "productGroup": "Transaction", "productName": "Savings Plus", "interestRate": 3.00, "planDescription": "Reward Interest for no withdrawals during a calendar quarter" },
    { "productGroup": "Transaction", "productName": "Savings Plus", "interestRate": 1.50, "planDescription": "Reward Interest for one withdrawals during a calendar quarter" },
    { "productGroup": "Transaction", "productName": "Savings On Call", "interestRate": 2.50, "minimumBalance": 0 },
    { "productGroup": "Transaction", "productName": "Savings On Call", "interestRate": 2.90, "minimumBalance": 10000 },
    { "productGroup": "Transaction", "productName": "Savings On Call", "interestRate": 3.00, "minimumBalance": 25000 },
    { "productGroup": "Transaction", "productName": "Savings On Call", "interestRate": 3.10, "minimumBalance": 50000 },
    { "productGroup": "Transaction", "productName": "Savings On Call", "interestRate": 3.20, "minimumBalance": 100000 },
    { "productGroup": "Transaction", "productName": "FastSaver", "interestRate": 2.50 },
    { "productGroup": "Transaction", "productName": "ORBIT Home Loan", "interestRate": 5.75 },
    { "productGroup": "Transaction", "productName": "Flexible Finance Facility", "interestRate": 6.25 },
    { "productGroup": "Transaction", "productName": "Overdraft", "interestRate": 15.00, "planDescription": "Secured" },
    { "productGroup": "Transaction", "productName": "Overdraft", "interestRate": 19.00, "planDescription": "Unsecured" },
    { "productGroup": "Transaction", "productName": "Overdraft", "interestRate": 22.50, "planDescription": "Unarranged" },
    { "productGroup": "Transaction", "productName": "Personal Loan", "interestRate": 14.95, "planDescription": "Secured" },
    { "productGroup": "Transaction", "productName": "Personal Loan", "interestRate": 17.95, "planDescription": "Unsecured" },
    { "productGroup": "Transaction", "productName": "Personal Loan", "interestRate": 15.50, "planDescription": "Unarranged" },
    { "productGroup": "Lending", "productName": "Housing Variable", "interestRate": 5.75 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 5.35, "termInMonths": 6 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 5.49, "termInMonths": 12 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 5.85, "termInMonths": 18 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 6.29, "termInMonths": 24 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 6.60, "termInMonths": 36 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 6.99, "termInMonths": 48 },
    { "productGroup": "Lending", "productName": "Prime Housing Lending", "interestRate": 7.20, "termInMonths": 60 },
    { "productGroup": "Lending", "productName": "Societies Clubs and Churches", "interestRate": 6.75 },
    { "productGroup": "Lending", "productName": "Second Mortgage", "interestRate": 5.85 },
    { "productGroup": "Credit Card", "productName": "Visa", "interestRate": 19.95, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "Visa", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "Visa Gold", "interestRate": 19.95, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "Visa Gold", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "Visa Platinum", "interestRate": 18.95, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "Visa Platinum", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "Low interest MasterCard (With True Rewards)", "interestRate": 15.15, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "Low interest MasterCard (With True Rewards)", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "Low interest MasterCard (Without True Rewards)", "interestRate": 13.6, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "Low interest MasterCard (Without True Rewards)", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "MasterCard", "interestRate": 19.95, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "MasterCard", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Credit Card", "productName": "MasterCard Gold", "interestRate": 19.95, "planDescription": "Purchase" },
    { "productGroup": "Credit Card", "productName": "MasterCard Gold", "interestRate": 21.95, "planDescription": "Cash Advance" },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 2.00, "termInDays": 30, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 2.60, "termInDays": 30, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 2.25, "termInDays": 60, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 2.75, "termInDays": 60, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInDays": 90, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInDays": 90, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 4, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.25, "termInMonths": 4, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 5, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.25, "termInMonths": 5, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 6, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.75, "termInMonths": 6, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 9, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.80, "termInMonths": 9, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 12, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 4.00, "termInMonths": 12, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 18, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 4.30, "termInMonths": 18, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 24, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 4.60, "termInMonths": 24, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 36, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 5.00, "termInMonths": 36, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 48, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 5.25, "termInMonths": 48, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 3.00, "termInMonths": 60, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Deposit", "interestRate": 5.50, "termInMonths": 60, "minimumBalance": 10000 },
     
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 2.00, "termInDays": 30, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 2.60, "termInDays": 30, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 2.25, "termInDays": 60, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 2.75, "termInDays": 60, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInDays": 90, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInDays": 90, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 4, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.25, "termInMonths": 4, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 5, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.25, "termInMonths": 5, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 6, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.75, "termInMonths": 6, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 9, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.80, "termInMonths": 9, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 12, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 4.00, "termInMonths": 12, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 18, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 4.30, "termInMonths": 18, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 24, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 4.60, "termInMonths": 24, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 36, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 5.00, "termInMonths": 36, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 48, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 5.25, "termInMonths": 48, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 3.00, "termInMonths": 60, "minimumBalance": 5000 },
    { "productGroup": "Investment", "productName": "Term Fund", "interestRate": 5.50, "termInMonths": 60, "minimumBalance": 10000 },
     
    { "productGroup": "Investment", "productName": "Cash Fund", "interestRate": 2.50, "minimumBalance": 0 },
    { "productGroup": "Investment", "productName": "Cash Fund", "interestRate": 2.90, "minimumBalance": 10000 },
    { "productGroup": "Investment", "productName": "Cash Fund", "interestRate": 3.00, "minimumBalance": 25000 },
    { "productGroup": "Investment", "productName": "Cash Fund", "interestRate": 3.10, "minimumBalance": 50000 },
    { "productGroup": "Investment", "productName": "Cash Fund", "interestRate": 3.20, "minimumBalance": 100000 }
    ]
}


Security

This API is non-authenticated

 

  • API URL : https://api.asb.co.nz