Exchange rate API

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

Requests

The following parameters are supported in JSON format

Parameter             
Mandatory
Type         Description   

currencyCode

No

String

Filter by currency code, e.g. "AUD"

$fields

No

String

Specify the properties to include in the result set. E.g. $fields=currencyCode,buysNotes

$orderby

No

String

Specify the sort order, if not specified, by default the result is sorted by currencyCode

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

Sample Request/s:

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

https://api.asb.co.nz/public/v1/exchange-rates?currencyCode=AUD

https://api.asb.co.nz/public/v1/exchange-rates?$fields=currencyCode,buysNotes

Responses

Responses are in JSON format

Parameter             Type           Description   
currencyCodeStringForeign currency code, e.g. “EUR”
buysNotesDecimal

Exchange rate for when ASB buys foreign currency notes (i.e. cash) from customer.

Value expressed in term of amount of foreign currency per New Zealand dollar, same for all other exchange rate fields.
buysChequesDecimalExchange rate for when ASB buys foreign currency cheques from customer.
buysPaymentsDecimalExchange rate for when ASB receives an electronic payment originating in a foreign currency for credit to customer's ASB account.
sellsNotesDecimal

Exchange rate for when ASB sells foreign currency notes (i.e. cash) to customer.

Note: ASB currently only have one single advertised sell rate, so this is also applicable to cheque and payment.

asbSellsArray of StringList of descriptions of currency mediums ASB sells for this currency code.
asbBuysArray of StringList of descriptions of currency mediums ASB buys for this currency code.
descriptionStringCurrency description (e.g. "New Zealand Dollar")
isFeaturedBooleanIs a featured currency.
smallestNoteStringSmallest denomination of this currency available as a note versus coin.

 

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/exchange-rates

 

{
    "value": [
        {
            "currencyCode": "AUD",
            "buysNotes": 0.8321,
            "buysCheques": 0.8116,
            "buysPayments": 0.807,
            "sellsNotes": 0.7908,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "CAD",
            "buysNotes": 0.9207,
            "buysCheques": 0.8901,
            "buysPayments": 0.8885,
            "sellsNotes": 0.8631,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "CHF",
            "buysNotes": 0.8618,
            "buysCheques": 0.8344,
            "buysPayments": 0.83,
            "sellsNotes": 0.8057,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques"
            ],
            "asbSells": [
                "SellIMT",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "DKK",
            "buysNotes": 5.1521,
            "buysCheques": 4.9586,
            "buysPayments": 4.9428,
            "sellsNotes": 4.8162,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "EUR",
            "buysNotes": 0.6832,
            "buysCheques": 0.6653,
            "buysPayments": 0.6626,
            "sellsNotes": 0.5996,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "FJD",
            "buysNotes": 1.6427,
            "buysPayments": 1.5597,
            "sellsNotes": 1.492,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "GBP",
            "buysNotes": 0.5594,
            "buysCheques": 0.5456,
            "buysPayments": 0.5433,
            "sellsNotes": 0.5061,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "HKD",
            "buysNotes": 6.9179,
            "buysCheques": 6.7012,
            "buysPayments": 6.6543,
            "sellsNotes": 6.4929,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "INR",
            "buysPayments": 46.2481,
            "sellsNotes": 45.245,
            "asbBuys": [],
            "asbSells": [
                "SellIMT"
            ]
        },
        {
            "currencyCode": "JPY",
            "buysNotes": 85.0469,
            "buysCheques": 82.1623,
            "buysPayments": 81.5505,
            "sellsNotes": 79.3165,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "KRW",
            "buysNotes": 1067.5969,
            "buysPayments": 1009.9748,
            "sellsNotes": 960.1617,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "NOK",
            "buysNotes": 5.1938,
            "buysCheques": 5.0068,
            "buysPayments": 4.9824,
            "sellsNotes": 4.8364,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "PHP",
            "buysPayments": 34.8789,
            "sellsNotes": 32.9222,
            "asbBuys": [],
            "asbSells": [
                "SellIMT"
            ]
        },
        {
            "currencyCode": "SEK",
            "buysNotes": 5.8223,
            "buysCheques": 5.5649,
            "buysPayments": 5.526,
            "sellsNotes": 5.3779,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "SGD",
            "buysNotes": 1.1178,
            "buysCheques": 1.0814,
            "buysPayments": 1.077,
            "sellsNotes": 1.0153,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "THB",
            "buysNotes": 26.5632,
            "buysPayments": 25.4599,
            "sellsNotes": 24.3359,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "TOP",
            "buysNotes": 1.615,
            "buysPayments": 1.4912,
            "sellsNotes": 1.4224,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "USD",
            "buysNotes": 0.8872,
            "buysCheques": 0.8634,
            "buysPayments": 0.8578,
            "sellsNotes": 0.7712,
            "asbBuys": [
                "BuyDraftsPChequesMOrders",
                "BuyNotes",
                "BuyTravellersCheques",
                "BuyFrontierCardWithdrawal"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes",
                "SellFrontierCardDeposit"
            ]
        },
        {
            "currencyCode": "WST",
            "buysNotes": 2.1427,
            "buysPayments": 1.988,
            "sellsNotes": 1.8816,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "XPF",
            "buysNotes": 78.1454,
            "buysPayments": 63.1888,
            "sellsNotes": 77.7397,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellDrafts",
                "SellNotes"
            ]
        },
        {
            "currencyCode": "ZAR",
            "buysNotes": 8.1834,
            "buysPayments": 7.8475,
            "sellsNotes": 7.696,
            "asbBuys": [
                "BuyNotes"
            ],
            "asbSells": [
                "SellIMT",
                "SellDrafts",
                "SellNotes"
            ]
        }
    ]
}

Security

This API is non-authenticated