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) |
productName | No | String | Filter 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 |
$offset | No | Integer | Page offset (number of records to skip) |
$limit | No | Integer | Page 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%. |
type | string | Used to differentiate between different rate types. |
termInDays | Integer | Product'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. |
termInMonths | Integer | Product'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. |
minimumBalance | Decimal |
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. |
planDescription | String | Description 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
|
Security
This API is non-authenticated
-
API URL : https://api.asb.co.nz
-
-
-