Products API
This API is: | Public |
Business purpose: | Return a list of ASB products |
HTTP Methods: | GET |
Request URL: | https://api.asb.co.nz/public/v1/products |
Version: | 5 |
Requests
The following input URL query parameters are supported:
Parameter |
Mandatory | Type | Description |
---|---|---|---|
$fields | No | String |
Specify the properties to include in the result set. E.g. $fields=productID,name,group. Selecting fields of a complex type is not currently supported.
|
$orderby | No | String |
Specify the sort order, if not specified, by default the result is sorted by date. Ordering by complex type is not currently supported. |
$limit | No | Integer | Page limit (number of records to return) |
$offset | No | Integer | Page offset (number of records to skip) |
Filter:
It is possible to filter on any of the response fields, for example standalone=true.
To filter by values within complex fields qualify with the complex type. For example productCriteria.minimumCreditLimit=2000
Sample Request/s
https://api.asb.co.nz/public/v1/products
$fields:
https://api.asb.co.nz/public/v1/products?$fields=productID,name,group
$orderby:
https://api.asb.co.nz/public/v1/products?$orderby=name
$limit:
https://api.asb.co.nz/public/v1/products?$limit=20
$offset:
https://api.asb.co.nz/public/v1/products?$offset=10
Responses
Parameter | Type | Description |
---|---|---|
productID | String | Identifier for the product. |
name |
String |
ASB product name (e.g. Streamline, FastSaver, Visa Gold, Business Master, etc.). |
group |
String |
ASB product group (e.g. Transaction/Investment/Lending/Credit Card/Foreign Currency). |
description | String | Description of the product. |
interestRates | Array of complex type | Interest rates for the product. |
fees | Array of complex type | Array of fees for account. |
foreignExchangeFees | Array of complex type | Array of foreign exchange fees for account. |
onlineStatements | Boolean | Indicates whether online statements can be offered for this product. |
rewardRate | Decimal | Rate at which rewards are accumulated. |
daysInterestFree | Integer | Number of days for which the product is interest free. |
travelInsuranceDays | Integer | Number of days of complimentary travel insurance. |
productCriteria | Complex Type | Criteria that must be met to be eligible for this product. |
isDigitalOnboardingEnabled | Boolean | Indicates whether this product is enabled for on-boarding through digital channel. |
tagLine | String | Tagline for the product. |
url | String | Product URL. |
disclaimer | String | Disclaimer for product. |
relatedproducts | Array | Array of product IDs that can be offered with this product (such as insurance or True Rewards). |
standalone | Boolean | Indicates whether this product is standalone or must be sold as part of another product. |
parentProducts | Array | If this product is not standalone then this is the list of product IDs that can contain this product. |
ratesToUse | String | Rate used for converting to a foreign exchange product e.g. "SellsNotes". |
minimumValue | Decimal | (Optional) Smallest value in NZD (or converted equivalent) for this product e.g. $20. |
maximumValue | Decimal | (Optional) Largest value in NZD (or converted equivalent) for this product e.g. $10,000. |
The fields below are relevant to the following Complex types:
productCritera
Parameter | Type | Description |
---|---|---|
minimumCreditLimit |
Decimal |
Minimum credit limit available for this product. |
maximumCreditLimit | Decimal | Maximum credit limit available for this product. |
interestRates
Parameter | Type | Description |
---|---|---|
type |
String |
Interest rate type. |
interestRate
| Decimal
|
Interest rate. |
planDescription | String | Description of interest rate. |
fees
Parameter | Type | Description |
---|---|---|
type |
String |
Type of account fee. |
amount | Decimal |
Fee amount. |
paymentCycle | Integer | Cycle at which payments are made. |
paymentCycleType | String | Type of payment cycle, e.g. Weekly, Monthly, Yearly, etc. |
foreignExchangeFees
Parameter | Type | Description |
---|---|---|
online | String | Fee channel. Valid values:
Y for FNC, N for Teller |
currencyCode | String | (Optional) Currency code for the fee. If present this fee is only used for the matching currency. The specific use for this is differential pricing for AUD IMTs. |
description | String | Fee tier. e.g. per FXFEESSET-DESC e.g. NOTES SALES <=NZ 100. |
tierCondition | String |
Number to split on. E.g. <=100, >100. |
type |
String |
Type of foreign exchange fee. |
amountOrPercent | Decimal |
Fee amount. If 'type' is Fixed, this is the fee monetary value, otherwise if 'type' is Percent, then this is the fee as a percent. |
tiered | Boolean | true if fee is Tiered, else false. |
tierNumber | Integer | (Optional) Tier number, if tiered == true |
Return Codes:
The specific return codes for this API are:
Code | Description |
---|---|
200 |
Success or partial success |
400 |
Bad Request – could be either invalid input or business rule exception. |
401 |
Not Authorized - no authentication information received, or authentication validation failed |
500 |
Internal Server Error |
503 |
Service Unavailable – API service is currently unavailable |
Security
This API is authenticated
Multi-factor authentication is not required.
Call Samples
Description:
Sample:
|
-
API URL : https://api.asb.co.nz
-
-
-