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 |
$offset | No | Integer | Page offset (number of records to skip) |
$limit | No | Integer | Page 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 |
---|---|---|
currencyCode | String | Foreign currency code, e.g. “EUR” |
buysNotes | Decimal |
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. |
buysCheques | Decimal | Exchange rate for when ASB buys foreign currency cheques from customer. |
buysPayments | Decimal | Exchange rate for when ASB receives an electronic payment originating in a foreign currency for credit to customer's ASB account. |
sellsNotes | Decimal |
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. |
asbSells | Array of String | List of descriptions of currency mediums ASB sells for this currency code. |
asbBuys | Array of String | List of descriptions of currency mediums ASB buys for this currency code. |
description | String | Currency description (e.g. "New Zealand Dollar") |
isFeatured | Boolean | Is a featured currency. |
smallestNote | String | Smallest 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
|
Security
This API is non-authenticated
-
API URL : https://api.asb.co.nz
-
-
-