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. Valid values Fixed amount = 1, Percentage = 0
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:

{
    "value":
    [
      {
      "productID": "OAAzADQANQA",
      "name": "Accelerater Statement",
      "group": "Savings",
      "description": "Accelerater Statement",
      "interestRates": [      {
         "interestRate": 0.25,
         "planDescription": "Credit interest rate",
         "type": "Flat"
      }],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 500
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 500
         }
      ],
      "onlineStatements": true,
      "isDigitalOnboardingEnabled": false,
      "standalone": true
   },
      {
      "productID": "NQAxADgAMAA2AA",
      "name": "Savings On Call",
      "group": "Savings",
      "description": "Savings On Call",
      "interestRates":       [
                  {
            "interestRate": 2.5,
            "planDescription": "$0 - $9999.99",
            "type": "Tier1Rate"
         },
                  {
            "interestRate": 3,
            "minimumBalance": 10000,
            "planDescription": "$10000 - $24999.99",
            "type": "Tier2Rate"
         },
                  {
            "interestRate": 3.05,
            "minimumBalance": 25000,
            "planDescription": "$25000 - $49999.99",
            "type": "Tier3Rate"
         },
                  {
            "interestRate": 3.1,
            "minimumBalance": 50000,
            "planDescription": "$50000 - $99999.99",
            "type": "Tier4Rate"
         },
                  {
            "interestRate": 3.15,
            "minimumBalance": 100000,
            "planDescription": "$100000+",
            "type": "Tier5Rate"
         }
      ],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 0
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 0
         }
      ],
      "onlineStatements": true,
      "isDigitalOnboardingEnabled": true,
      "tagLine": "The more you have saved, the higher the interest rate.",
      "url": "https://www.asb.co.nz/savingsoncall",
      "standalone": true
   },
      {
      "productID": "NQAxADAAOQAyAA",
      "name": "Savings Plus",
      "group": "Savings",
      "description": "Savings Plus",
      "interestRates": [      {
         "interestRate": 0.5,
         "planDescription": "Credit interest rate",
         "type": "Flat"
      }],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 0
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 0
         }
      ],
      "onlineStatements": true,
      "isDigitalOnboardingEnabled": false,
      "tagLine": "Get rewarded for not dipping into your savings.",
      "url": "https://www.asb.co.nz/savingsplus",
      "standalone": true
   },
      {
      "productID": "NAAxADkAMgAxAA",
      "name": "Business Saver",
      "group": "Savings",
      "description": "Business Saver",
      "interestRates": [      {
         "interestRate": 3.15,
         "planDescription": "Credit interest rate",
         "type": "Flat"
      }],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 0
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 0
         }
      ],
      "onlineStatements": true,
      "isDigitalOnboardingEnabled": false,
      "standalone": true
   },
      {
      "productID": "MwAwADAANwA5AA",
      "name": "FastSaver",
      "group": "Savings",
      "description": "FastSaver",
      "interestRates":       [
                  {
            "interestRate": 2.74,
            "planDescription": "$0 - $999.99",
            "type": "Tier1Rate"
         },
                  {
            "interestRate": 2.75,
            "minimumBalance": 1000,
            "planDescription": "$1000+",
            "type": "Tier2Rate"
         }
      ],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 0
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 0
         }
      ],
      "onlineStatements": true,
      "isDigitalOnboardingEnabled": true,
      "tagLine": "The same rate of interest on every dollar.",
      "url": "https://www.asb.co.nz/fastsaver",
      "standalone": true
   },
      {
      "productID": "OAA0ADAAMQA",
      "name": "Accelerater Passbook",
      "group": "Savings",
      "description": "Accelerater Passbook",
      "interestRates": [],
      "fees":       [
                  {
            "type": "BaseAccountFee",
            "amount": 0,
            "paymentCycle": 1,
            "paymentCycleType": "months"
         },
                  {
            "type": "ElectronicTransactionFee",
            "amount": 500
         },
                  {
            "type": "ManualTransactionFee",
            "amount": 500
         }
      ],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true
   },
      {
      "productID": "NwAxADAAMgA",
      "name": "Sell Notes",
      "group": "Foreign Exchange",
      "description": "Sell Notes",
      "interestRates": [],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true,
      "foreignExchangeFees":       [
                  {
            "online": "Y",
            "tiered": true,
            "tierNumber": 1,
            "description": "FN NOTE SALES <= 500",
            "tierCondition": "<= 500",
            "type": "1",
            "amountOrPercent": 5
         },
                  {
            "online": "Y",
            "tiered": true,
            "tierNumber": 2,
            "description": "FN NOTE SALES > 500",
            "tierCondition": "> 500",
            "type": "0",
            "amountOrPercent": 1
         },
                  {
            "online": "N",
            "tiered": true,
            "tierNumber": 1,
            "description": "NOTE SALES <=NZ 100",
            "tierCondition": "<= 100",
            "type": "1",
            "amountOrPercent": 5
         },
                  {
            "online": "N",
            "tiered": true,
            "tierNumber": 2,
            "description": "NOTE SALES <=NZ 500",
            "tierCondition": "<= 500",
            "type": "1",
            "amountOrPercent": 5
         },
                  {
            "online": "N",
            "tiered": true,
            "tierNumber": 3,
            "description": "NOTE SALES > NZ 500",
            "tierCondition": "> 500",
            "type": "0",
            "amountOrPercent": 1
         },
                  {
            "online": "N",
            "tiered": true,
            "tierNumber": 4,
            "description": "NOTE SALES <=NZ 1000",
            "tierCondition": "<= 1000",
            "type": "1",
            "amountOrPercent": 10
         },
                  {
            "online": "N",
            "tiered": true,
            "tierNumber": 5,
            "description": "NOTE SALES > NZ 1000",
            "tierCondition": "> 1000",
            "type": "0",
            "amountOrPercent": 1
         }
      ],
      "rateToUse": "sellsNotes"
   },
      {
      "productID": "NwAxADAAMwA",
      "name": "Sell Travellers Cheques",
      "group": "Foreign Exchange",
      "description": "Sell Travellers Cheques",
      "interestRates": [],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true,
      "foreignExchangeFees": [],
      "rateToUse": "sellsNotes"
   },
      {
      "productID": "NwAxADAANAA",
      "name": "Sell Drafts",
      "group": "Foreign Exchange",
      "description": "Sell Drafts",
      "interestRates": [],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true,
      "foreignExchangeFees":       [
                  {
            "online": "Y",
            "tiered": false,
            "description": "FN DRAFT SALE FEE",
            "type": "1",
            "amountOrPercent": 20
         },
                  {
            "online": "Y",
            "tiered": false,
            "description": "DRAFT COURIER FEE",
            "type": "1",
            "amountOrPercent": 30
         },
                  {
            "online": "N",
            "tiered": false,
            "description": "DRAFT NOT POSTED",
            "type": "1",
            "amountOrPercent": 25
         }
      ],
      "rateToUse": "sellsNotes"
   },
      {
      "productID": "NwAxADAANQA",
      "name": "Sell IMT",
      "group": "Foreign Exchange",
      "description": "Sell IMT",
      "interestRates": [],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true,
      "foreignExchangeFees":       [
                  {
            "online": "Y",
            "tiered": false,
            "description": "FN IMT SALE FEE",
            "type": "1",
            "amountOrPercent": 20
         },
                  {
            "online": "N",
            "tiered": false,
            "description": "EFT - NON AUSTRALIA",
            "type": "1",
            "amountOrPercent": 30
         },
                  {
            "online": "N",
            "tiered": false,
            "description": "EFT - AUSTRALIA",
            "type": "1",
            "amountOrPercent": 30
         }
      ],
      "rateToUse": "sellsNotes"
   },
      {
      "productID": "NwAxADAANgA",
      "name": "Buy Notes",
      "group": "Foreign Exchange",
      "description": "Buy Notes",
      "interestRates": [],
      "onlineStatements": false,
      "isDigitalOnboardingEnabled": false,
      "standalone": true,
      "foreignExchangeFees": [      {
         "online": "N",
         "tiered": false,
         "description": "BUY NOTES",
         "type": "1",
         "amountOrPercent": 0
      }],
      "rateToUse": "buysNotes"
   },
    ]
}

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

API Key

API Key: No API key is available.
- Toggle All
public
- - GET public/v1/products
    - Return a list of ASB products
    Implementation Notes
    
    Parameters
    
    Parameter Value Description
    
    Hide Response
    Query
    
    Response

ASB Bank LtdAPI Developer Portal

Products API

Requests

Responses

Security

Call Samples

public

GET public/v1/products

Implementation Notes

Parameters