Get Account Detail V3
This page documents the obsolete version 3 of the Get Account Detail endpoint.
Data Holders can retire this version after May 11th 2026. Data Recipients must update to newer versions prior to this date.
Get Account Detail
Code samples
GET https://mtls.dh.example.com/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-v':'string',
'x-min-v':'string',
'x-fapi-interaction-id':'string',
'x-fapi-auth-date':'string',
'x-fapi-customer-ip-address':'string',
'x-cds-client-headers':'string'
};
fetch('https://mtls.dh.example.com/cds-au/v1/banking/accounts/{accountId}', {
method: 'GET',
headers: headers
}).then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /banking/accounts/{accountId}
Obtain detailed information on a single account.
Obsolete versions: v1, v2.
Endpoint Version
Parameters
| Name |
In |
Type |
Required |
Default |
Description |
| accountId |
path |
BankingAccountId |
mandatory |
|
The accountId to obtain data for. accountId values are returned by account list endpoints. |
| x-v |
header |
string |
mandatory |
|
Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable. See HTTP Headers. |
| x-min-v |
header |
string |
optional |
|
Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable. |
| x-fapi-interaction-id |
header |
string |
optional |
|
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| x-fapi-auth-date |
header |
string |
conditional |
|
The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. |
| x-fapi-customer-ip-address |
header |
string |
optional |
|
The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls. |
| x-cds-client-headers |
header |
Base64 |
conditional |
|
The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. |
Example responses
200 Response
{
"data": {
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "AUD",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "AUD",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "AUD",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "AUD",
"maxRedraw": "string",
"maxRedrawCurrency": "AUD",
"minRedraw": "string",
"minRedrawCurrency": "AUD",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Responses
| Status |
Header |
Type |
Required |
Description |
| 200 |
x-v |
string |
mandatory |
The payload version that the endpoint has responded with. |
| 200 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 400 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 404 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
| 406 |
x-fapi-interaction-id |
string |
mandatory |
An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction. |
Schemas
RequestAccountIdListV1
{
"data": {
"accountIds": [
"string"
]
},
"meta": {}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » accountIds |
[BankingAccountId] |
mandatory |
|
Array of accountId values to obtain data for. |
| meta |
Meta |
optional |
|
none |
ResponseBankingProductListV2
{
"data": {
"products": [
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
]
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » products |
[BankingProductV4] |
mandatory |
|
The list of products returned. If the filter results in an empty set then this array may have no records. |
| links |
LinksPaginated |
mandatory |
|
none |
| meta |
MetaPaginated |
mandatory |
|
none |
BankingProductV4
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| productId |
BankingProductId |
mandatory |
|
A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines. |
| effectiveFrom |
DateTimeString |
optional |
|
The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate. |
| effectiveTo |
DateTimeString |
optional |
|
The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products. |
| lastUpdated |
DateTimeString |
mandatory |
|
The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered). |
| productCategory |
BankingProductCategory |
mandatory |
|
The category to which a product or account belongs. See here for more details. |
| name |
string |
mandatory |
|
The display name of the product. |
| description |
string |
mandatory |
|
A description of the product. |
| brand |
string |
mandatory |
|
A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required. |
| brandName |
string |
optional |
|
An optional display name of the brand. |
| applicationUri |
URIString |
optional |
|
A link to an application web page where this product can be applied for. |
| isTailored |
Boolean |
mandatory |
|
Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable. |
| additionalInformation |
BankingProductAdditionalInformationV2 |
optional |
|
Object that contains links to additional information on specific topics. |
| cardArt |
[object] |
optional |
|
An array of card art images. |
| » title |
string |
optional |
|
Display label for the specific image. |
| » imageUri |
URIString |
mandatory |
|
URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to [RFC2397]. |
{
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
}
Object that contains links to additional information on specific topics.
| Name |
Type |
Required |
Default |
Description |
| overviewUri |
URIString |
conditional |
|
General overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents. |
| termsUri |
URIString |
conditional |
|
Terms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents. |
| eligibilityUri |
URIString |
conditional |
|
Eligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents. |
| feesAndPricingUri |
URIString |
conditional |
|
Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents. |
| bundleUri |
URIString |
conditional |
|
Description of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents. |
| additionalOverviewUris |
[BankingProductAdditionalInformationV2_additionalInformationUris] |
optional |
|
An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri. |
| additionalTermsUris |
[BankingProductAdditionalInformationV2_additionalInformationUris] |
optional |
|
An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri. |
| additionalEligibilityUris |
[BankingProductAdditionalInformationV2_additionalInformationUris] |
optional |
|
An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri. |
| additionalFeesAndPricingUris |
[BankingProductAdditionalInformationV2_additionalInformationUris] |
optional |
|
An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri. |
| additionalBundleUris |
[BankingProductAdditionalInformationV2_additionalInformationUris] |
optional |
|
An array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri. |
{
"description": "string",
"additionalInfoUri": "string"
}
| Name |
Type |
Required |
Default |
Description |
| description |
string |
optional |
|
Display text providing more information about the document URI. |
| additionalInfoUri |
URIString |
mandatory |
|
The URI describing the additional information. |
ResponseBankingProductByIdV5
{
"data": {
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
],
"bundles": [
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"constraints": [
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"eligibility": [
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
BankingProductDetailV5
{
"productId": "string",
"effectiveFrom": "string",
"effectiveTo": "string",
"lastUpdated": "string",
"productCategory": "BUSINESS_LOANS",
"name": "string",
"description": "string",
"brand": "string",
"brandName": "string",
"applicationUri": "string",
"isTailored": true,
"additionalInformation": {
"overviewUri": "string",
"termsUri": "string",
"eligibilityUri": "string",
"feesAndPricingUri": "string",
"bundleUri": "string",
"additionalOverviewUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalTermsUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalEligibilityUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalFeesAndPricingUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
],
"additionalBundleUris": [
{
"description": "string",
"additionalInfoUri": "string"
}
]
},
"cardArt": [
{
"title": "string",
"imageUri": "string"
}
],
"bundles": [
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"constraints": [
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"eligibility": [
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
Properties
allOf
| Name |
Type |
Required |
Default |
Description |
| anonymous |
BankingProductV4 |
mandatory |
|
none |
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » bundles |
[BankingProductBundle] |
optional |
|
An array of bundles that this product participates in. Each bundle is described by free form information but also by a list of productID values of the other products that are included in the bundle. It is assumed that the current product is included in the bundle also. |
| » features |
[BankingProductFeatureV2] |
optional |
|
Array of features available for the product. |
| » constraints |
[BankingProductConstraintV2] |
optional |
|
Constraints on the application for or operation of the product such as minimum balances or limit thresholds. |
| » eligibility |
[BankingProductEligibility] |
optional |
|
Eligibility criteria for the product. |
| » fees |
[BankingProductFee] |
optional |
|
Fees applicable to the product. |
| » depositRates |
[BankingProductDepositRate] |
optional |
|
Interest rates available for deposits. |
| » lendingRates |
[BankingProductLendingRateV2] |
optional |
|
Interest rates charged against lending balances. |
BankingProductBundle
{
"name": "string",
"description": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"productIds": [
"string"
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| name |
string |
mandatory |
|
Name of the bundle. |
| description |
string |
mandatory |
|
Description of the bundle. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the bundle. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on the bundle criteria and benefits. |
| productIds |
[BankingProductId] |
optional |
|
Array of productID values for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints. |
BankingProductFeatureV2
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| featureType |
Enum |
mandatory |
|
The type of feature described. For further details, refer to Product Feature Types. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType. |
| additionalInfo |
string |
conditional |
|
Display text providing more information on the feature. Mandatory if featureType is set to OTHER. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this feature. |
Enumerated Values
| Property |
Value |
| featureType |
ADDITIONAL_CARDS |
| featureType |
BALANCE_TRANSFERS |
| featureType |
BILL_PAYMENT |
| featureType |
BONUS_REWARDS |
| featureType |
CARD_ACCESS |
| featureType |
CASHBACK_OFFER |
| featureType |
COMPLEMENTARY_PRODUCT_DISCOUNTS |
| featureType |
DIGITAL_BANKING |
| featureType |
DIGITAL_WALLET |
| featureType |
DONATE_INTEREST |
| featureType |
EXTRA_REPAYMENTS |
| featureType |
FRAUD_PROTECTION |
| featureType |
FREE_TXNS |
| featureType |
FREE_TXNS_ALLOWANCE |
| featureType |
GUARANTOR |
| featureType |
INSURANCE |
| featureType |
INSTALMENT_PLAN |
| featureType |
INTEREST_FREE |
| featureType |
INTEREST_FREE_TRANSFERS |
| featureType |
LOYALTY_PROGRAM |
| featureType |
NOTIFICATIONS |
| featureType |
NPP_ENABLED |
| featureType |
NPP_PAYID |
| featureType |
OFFSET |
| featureType |
OTHER |
| featureType |
OVERDRAFT |
| featureType |
REDRAW |
| featureType |
RELATIONSHIP_MANAGEMENT |
| featureType |
UNLIMITED_TXNS |
BankingProductConstraintV2
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| constraintType |
Enum |
mandatory |
|
The type of constraint described. For further details, refer to Product Constraint Types. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the constraint. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on the constraint. |
Enumerated Values
| Property |
Value |
| constraintType |
MAX_BALANCE |
| constraintType |
MAX_LIMIT |
| constraintType |
MAX_LVR |
| constraintType |
MIN_BALANCE |
| constraintType |
MIN_LIMIT |
| constraintType |
MIN_LVR |
| constraintType |
OPENING_BALANCE |
BankingProductEligibility
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| eligibilityType |
Enum |
mandatory |
|
The type of eligibility criteria described. For further details, refer to Product Eligibility Types. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType. |
| additionalInfo |
string |
conditional |
|
Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this eligibility criteria. |
Enumerated Values
| Property |
Value |
| eligibilityType |
BUSINESS |
| eligibilityType |
EMPLOYMENT_STATUS |
| eligibilityType |
MAX_AGE |
| eligibilityType |
MIN_AGE |
| eligibilityType |
MIN_INCOME |
| eligibilityType |
MIN_TURNOVER |
| eligibilityType |
NATURAL_PERSON |
| eligibilityType |
OTHER |
| eligibilityType |
PENSION_RECIPIENT |
| eligibilityType |
RESIDENCY_STATUS |
| eligibilityType |
STAFF |
| eligibilityType |
STUDENT |
BankingProductFee
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| name |
string |
mandatory |
|
Name of the fee. |
| feeType |
Enum |
mandatory |
|
The type of fee. For further details, refer to Product Fee Types. |
| amount |
AmountString |
conditional |
|
The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| balanceRate |
RateString |
conditional |
|
A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| transactionRate |
RateString |
conditional |
|
A fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| accruedRate |
RateString |
conditional |
|
A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied. |
| accrualFrequency |
ExternalRef |
optional |
|
The indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| currency |
CurrencyString |
optional |
AUD |
The currency the fee will be charged in. Assumes AUD if absent. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the fee. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this fee. |
| discounts |
[BankingProductDiscount] |
optional |
|
An optional list of discounts to this fee that may be available. |
Enumerated Values
| Property |
Value |
| feeType |
DEPOSIT |
| feeType |
EVENT |
| feeType |
EXIT |
| feeType |
PAYMENT |
| feeType |
PERIODIC |
| feeType |
PURCHASE |
| feeType |
TRANSACTION |
| feeType |
UPFRONT |
| feeType |
VARIABLE |
| feeType |
WITHDRAWAL |
BankingProductDiscount
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| description |
string |
mandatory |
|
Description of the discount. |
| discountType |
Enum |
mandatory |
|
The type of discount. For further details, refer to Product Discount Types. |
| amount |
AmountString |
conditional |
|
Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. |
| balanceRate |
RateString |
conditional |
|
A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| transactionRate |
RateString |
conditional |
|
A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. |
| accruedRate |
RateString |
conditional |
|
A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| feeRate |
RateString |
conditional |
|
A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the discount. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this discount. |
| eligibility |
[BankingProductDiscountEligibility] |
conditional |
|
Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY. |
Enumerated Values
| Property |
Value |
| discountType |
BALANCE |
| discountType |
DEPOSITS |
| discountType |
ELIGIBILITY_ONLY |
| discountType |
FEE_CAP |
| discountType |
PAYMENTS |
BankingProductDiscountEligibility
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| discountEligibilityType |
Enum |
mandatory |
|
The type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType. |
| additionalInfo |
string |
conditional |
|
Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this eligibility constraint. |
Enumerated Values
| Property |
Value |
| discountEligibilityType |
BUSINESS |
| discountEligibilityType |
EMPLOYMENT_STATUS |
| discountEligibilityType |
INTRODUCTORY |
| discountEligibilityType |
MAX_AGE |
| discountEligibilityType |
MIN_AGE |
| discountEligibilityType |
MIN_INCOME |
| discountEligibilityType |
MIN_TURNOVER |
| discountEligibilityType |
NATURAL_PERSON |
| discountEligibilityType |
OTHER |
| discountEligibilityType |
PENSION_RECIPIENT |
| discountEligibilityType |
RESIDENCY_STATUS |
| discountEligibilityType |
STAFF |
| discountEligibilityType |
STUDENT |
BankingProductDepositRate
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| depositRateType |
Enum |
mandatory |
|
The type of rate (FIXED, VARIABLE, BONUS, etc.) For further details, refer to Product Deposit Rate Types. |
| rate |
RateString |
mandatory |
|
The rate to be applied. |
| calculationFrequency |
ExternalRef |
optional |
|
The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| applicationFrequency |
ExternalRef |
optional |
|
The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| tiers |
[BankingProductRateTierV3] |
optional |
|
Rate tiers applicable for this rate. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the rate. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this rate. |
Enumerated Values
| Property |
Value |
| depositRateType |
BONUS |
| depositRateType |
BUNDLE_BONUS |
| depositRateType |
FIXED |
| depositRateType |
FLOATING |
| depositRateType |
INTRODUCTORY |
| depositRateType |
MARKET_LINKED |
| depositRateType |
VARIABLE |
BankingProductLendingRateV2
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| lendingRateType |
Enum |
mandatory |
|
The type of rate (FIXED, VARIABLE, etc.) For further details, refer to Product Lending Rate Types. |
| rate |
RateString |
mandatory |
|
The rate to be applied. |
| comparisonRate |
RateString |
optional |
|
A comparison rate equivalent for this rate. |
| calculationFrequency |
ExternalRef |
optional |
|
The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| applicationFrequency |
ExternalRef |
optional |
|
The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
| interestPaymentDue |
Enum |
optional |
|
When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered. |
| repaymentType |
Enum |
optional |
|
Options in place for repayments. If absent, the lending rate is applicable to all repayment types. |
| loanPurpose |
Enum |
optional |
|
The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes. |
| tiers |
[BankingProductRateTierV3] |
optional |
|
Rate tiers applicable for this rate. |
| additionalValue |
string |
conditional |
|
Generic field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the rate. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this rate. |
Enumerated Values
| Property |
Value |
| lendingRateType |
BUNDLE_DISCOUNT_FIXED |
| lendingRateType |
BUNDLE_DISCOUNT_VARIABLE |
| lendingRateType |
CASH_ADVANCE |
| lendingRateType |
DISCOUNT |
| lendingRateType |
FIXED |
| lendingRateType |
FLOATING |
| lendingRateType |
INTRODUCTORY |
| lendingRateType |
MARKET_LINKED |
| lendingRateType |
PENALTY |
| lendingRateType |
PURCHASE |
| lendingRateType |
VARIABLE |
| interestPaymentDue |
IN_ADVANCE |
| interestPaymentDue |
IN_ARREARS |
| repaymentType |
INTEREST_ONLY |
| repaymentType |
PRINCIPAL_AND_INTEREST |
| loanPurpose |
INVESTMENT |
| loanPurpose |
OWNER_OCCUPIED |
BankingProductRateTierV3
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Defines the criteria and conditions for which a rate applies.
Properties
| Name |
Type |
Required |
Default |
Description |
| name |
string |
mandatory |
|
A display name for the tier. |
| unitOfMeasure |
Enum |
mandatory |
|
The unit of measure that applies to the minimumValue and maximumValue values e.g.,DOLLAR amount.PERCENT (in the case of loan-to-value ratio or LVR).- Tier term period representing a discrete number of
MONTH(s) or DAY(s) (in the case of term deposit tiers).
|
| minimumValue |
Number |
mandatory |
|
The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value. |
| maximumValue |
Number |
optional |
|
The number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. |
| rateApplicationMethod |
Enum |
optional |
|
The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). |
| applicabilityConditions |
BankingProductRateCondition |
optional |
|
Defines a condition for the applicability of a tiered rate. |
| additionalInfo |
string |
optional |
|
Display text providing more information on the rate tier. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this rate tier. |
Enumerated Values
| Property |
Value |
| unitOfMeasure |
DAY |
| unitOfMeasure |
DOLLAR |
| unitOfMeasure |
MONTH |
| unitOfMeasure |
PERCENT |
| rateApplicationMethod |
PER_TIER |
| rateApplicationMethod |
WHOLE_BALANCE |
BankingProductRateCondition
{
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Defines a condition for the applicability of a tiered rate.
Properties
| Name |
Type |
Required |
Default |
Description |
| additionalInfo |
string |
optional |
|
Display text providing more information on the condition. |
| additionalInfoUri |
URIString |
optional |
|
Link to a web page with more information on this condition. |
ResponseBankingAccountListV2
{
"data": {
"accounts": [
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
]
},
"links": {
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
},
"meta": {
"totalRecords": 0,
"totalPages": 0
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| data |
object |
mandatory |
|
none |
| » accounts |
[BankingAccountV2] |
mandatory |
|
The list of accounts returned. If the filter results in an empty set then this array may have no records. |
| links |
LinksPaginated |
mandatory |
|
none |
| meta |
MetaPaginated |
mandatory |
|
none |
BankingAccountV2
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| accountId |
BankingAccountId |
mandatory |
|
Unique identifier for the account. |
| creationDate |
DateString |
optional |
|
Date that the account was created (if known). |
| displayName |
string |
mandatory |
|
The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. |
| nickname |
string |
optional |
|
A customer supplied nickname for the account. |
| openStatus |
Enum |
optional |
OPEN |
Open or closed status for the account. If not present then OPEN is assumed. |
| isOwned |
Boolean |
optional |
true |
Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then true is assumed. |
| accountOwnership |
Enum |
mandatory |
|
Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers. |
| maskedNumber |
MaskedAccountString |
mandatory |
|
A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number. |
| productCategory |
BankingProductCategory |
mandatory |
|
The category to which a product or account belongs. See here for more details. |
| productName |
string |
mandatory |
|
The unique identifier of the account as defined by the data holder (akin to model number for the account). |
Enumerated Values
| Property |
Value |
| openStatus |
CLOSED |
| openStatus |
OPEN |
| accountOwnership |
UNKNOWN |
| accountOwnership |
ONE_PARTY |
| accountOwnership |
TWO_PARTY |
| accountOwnership |
MANY_PARTY |
| accountOwnership |
OTHER |
ResponseBankingAccountByIdV3
{
"data": {
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "AUD",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "AUD",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "AUD",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "AUD",
"maxRedraw": "string",
"maxRedrawCurrency": "AUD",
"minRedraw": "string",
"minRedrawCurrency": "AUD",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
},
"links": {
"self": "string"
},
"meta": {}
}
Properties
BankingAccountDetailV3
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"accountOwnership": "UNKNOWN",
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "AUD",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "AUD",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "AUD",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "AUD",
"maxRedraw": "string",
"maxRedrawCurrency": "AUD",
"minRedraw": "string",
"minRedrawCurrency": "AUD",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "VARIABLE",
"rate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"lendingRates": [
{
"lendingRateType": "FIXED",
"rate": "string",
"comparisonRate": "string",
"calculationFrequency": "string",
"applicationFrequency": "string",
"interestPaymentDue": "IN_ADVANCE",
"repaymentType": "INTEREST_ONLY",
"loanPurpose": "INVESTMENT",
"tiers": [
{
"name": "string",
"unitOfMeasure": "DAY",
"minimumValue": 0,
"maximumValue": 0,
"rateApplicationMethod": "PER_TIER",
"applicabilityConditions": {
"additionalInfo": "string",
"additionalInfoUri": "string"
},
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
],
"features": [
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"isActivated": true
}
],
"fees": [
{
"name": "string",
"feeType": "DEPOSIT",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"accrualFrequency": "string",
"currency": "AUD",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"discounts": [
{
"description": "string",
"discountType": "BALANCE",
"amount": "string",
"balanceRate": "string",
"transactionRate": "string",
"accruedRate": "string",
"feeRate": "string",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string",
"eligibility": [
{
"discountEligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
]
}
]
}
],
"addresses": [
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
]
}
Properties
allOf
| Name |
Type |
Required |
Default |
Description |
| anonymous |
BankingAccountV2 |
mandatory |
|
none |
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » bsb |
string |
optional |
|
The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. |
| » accountNumber |
string |
optional |
|
The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. |
| » bundleName |
string |
optional |
|
Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer. |
| » specificAccountUType |
Enum |
optional |
|
The type of structure to present account specific fields. |
| » termDeposit |
[BankingTermDepositAccount] |
conditional |
|
none |
| » creditCard |
BankingCreditCardAccount |
conditional |
|
none |
| » loan |
BankingLoanAccountV2 |
conditional |
|
none |
| » depositRate |
RateString |
optional |
|
Current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call. |
| » lendingRate |
RateString |
optional |
|
The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call. |
| » depositRates |
[BankingProductDepositRate] |
optional |
|
Fully described deposit rates for this account based on the equivalent structure in Product Reference. |
| » lendingRates |
[BankingProductLendingRateV2] |
optional |
|
Fully described lending rates for this account based on the equivalent structure in Product Reference. |
| » features |
[allOf] |
optional |
|
Array of features of the account based on the equivalent structure in Product Reference with the following additional field. |
allOf
and
| Name |
Type |
Required |
Default |
Description |
| »» anonymous |
object |
mandatory |
|
none |
| »»» isActivated |
Boolean |
optional |
true |
true if the feature is already activated and false if the feature is available for activation. Defaults to true if absent.
Note: this is an additional field appended to the feature object defined in the Product Reference payload. |
continued
| Name |
Type |
Required |
Default |
Description |
| » fees |
[BankingProductFee] |
optional |
|
Fees and charges applicable to the account based on the equivalent structure in Product Reference. |
| » addresses |
[CommonPhysicalAddress] |
optional |
|
The addresses for the account to be used for correspondence. |
Enumerated Values
| Property |
Value |
| specificAccountUType |
creditCard |
| specificAccountUType |
loan |
| specificAccountUType |
termDeposit |
BankingTermDepositAccount
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "AUD",
"maturityInstructions": "HOLD_ON_MATURITY"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| lodgementDate |
DateString |
mandatory |
|
The lodgement date of the original deposit. |
| maturityDate |
DateString |
mandatory |
|
Maturity date for the term deposit. |
| maturityAmount |
AmountString |
optional |
|
Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated. |
| maturityCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| maturityInstructions |
Enum |
mandatory |
|
Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments. |
Enumerated Values
| Property |
Value |
| maturityInstructions |
HOLD_ON_MATURITY |
| maturityInstructions |
PAID_OUT_AT_MATURITY |
| maturityInstructions |
ROLLED_OVER |
BankingCreditCardAccount
{
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "AUD",
"paymentDueDate": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| minPaymentAmount |
AmountString |
mandatory |
|
The minimum payment amount due for the next card payment. |
| paymentDueAmount |
AmountString |
mandatory |
|
The amount due for the next card payment. |
| paymentCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| paymentDueDate |
DateString |
mandatory |
|
Date that the next payment for the card is due. |
BankingLoanAccountV2
{
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "AUD",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "AUD",
"maxRedraw": "string",
"maxRedrawCurrency": "AUD",
"minRedraw": "string",
"minRedrawCurrency": "AUD",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| originalStartDate |
DateString |
optional |
|
Optional original start date for the loan. |
| originalLoanAmount |
AmountString |
optional |
|
Optional original loan value. |
| originalLoanCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| loanEndDate |
DateString |
optional |
|
Date that the loan is due to be repaid in full. |
| nextInstalmentDate |
DateString |
optional |
|
Next date that an instalment is required. |
| minInstalmentAmount |
AmountString |
optional |
|
Minimum amount of next instalment. |
| minInstalmentCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| maxRedraw |
AmountString |
optional |
|
Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account. |
| maxRedrawCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| minRedraw |
AmountString |
optional |
|
Minimum redraw amount. |
| minRedrawCurrency |
CurrencyString |
optional |
AUD |
If absent assumes AUD. |
| offsetAccountEnabled |
Boolean |
optional |
|
Set to true if one or more offset accounts are configured for this loan account. |
| offsetAccountIds |
[BankingAccountId] |
optional |
|
The accountId values of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation. |
| repaymentType |
Enum |
optional |
PRINCIPAL_AND_INTEREST |
Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST. |
| repaymentFrequency |
ExternalRef |
optional |
|
The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax). |
Enumerated Values
| Property |
Value |
| repaymentType |
INTEREST_ONLY |
| repaymentType |
PRINCIPAL_AND_INTEREST |
CommonPhysicalAddress
{
"addressUType": "paf",
"simple": {
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
},
"paf": {
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| addressUType |
Enum |
mandatory |
|
The type of address object present. |
| simple |
CommonSimpleAddress |
conditional |
|
Required if addressUType is set to simple. |
| paf |
CommonPAFAddress |
conditional |
|
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf. |
Enumerated Values
| Property |
Value |
| addressUType |
paf |
| addressUType |
simple |
CommonSimpleAddress
{
"mailingName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"postcode": "string",
"city": "string",
"state": "string",
"country": "AUS"
}
Required if addressUType is set to simple.
Properties
| Name |
Type |
Required |
Default |
Description |
| mailingName |
string |
optional |
|
Name of the individual or business formatted for inclusion in an address used for physical mail. |
| addressLine1 |
string |
mandatory |
|
First line of the standard address object. |
| addressLine2 |
string |
optional |
|
Second line of the standard address object. |
| addressLine3 |
string |
optional |
|
Third line of the standard address object. |
| postcode |
string |
conditional |
|
Mandatory for Australian addresses. |
| city |
string |
mandatory |
|
Name of the city or locality. |
| state |
string |
mandatory |
|
Free text if the country is not Australia. If country is Australia then must be one of the values defined by the State Type Abbreviation in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
| country |
ExternalRef |
optional |
AUS |
A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present. |
CommonPAFAddress
{
"dpid": "string",
"thoroughfareNumber1": 0,
"thoroughfareNumber1Suffix": "string",
"thoroughfareNumber2": 0,
"thoroughfareNumber2Suffix": "string",
"flatUnitType": "string",
"flatUnitNumber": "string",
"floorLevelType": "string",
"floorLevelNumber": "string",
"lotNumber": "string",
"buildingName1": "string",
"buildingName2": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"postalDeliveryType": "string",
"postalDeliveryNumber": 0,
"postalDeliveryNumberPrefix": "string",
"postalDeliveryNumberSuffix": "string",
"localityName": "string",
"postcode": "string",
"state": "string"
}
Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf.
Properties
| Name |
Type |
Required |
Default |
Description |
| dpid |
string |
optional |
|
Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. |
| thoroughfareNumber1 |
PositiveInteger |
optional |
|
Thoroughfare number for a property (first number in a property ranged address). |
| thoroughfareNumber1Suffix |
string |
optional |
|
Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated. |
| thoroughfareNumber2 |
PositiveInteger |
optional |
|
Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25). |
| thoroughfareNumber2Suffix |
string |
optional |
|
Suffix for the second thoroughfare number. Only relevant if thoroughfareNumber2 is populated. |
| flatUnitType |
string |
optional |
|
Type of flat or unit for the address. |
| flatUnitNumber |
string |
optional |
|
Unit number (including suffix, if applicable). |
| floorLevelType |
string |
optional |
|
Type of floor or level for the address. |
| floorLevelNumber |
string |
optional |
|
Floor or level number (including alpha characters). |
| lotNumber |
string |
optional |
|
Allotment number for the address. |
| buildingName1 |
string |
optional |
|
Building/Property name 1. |
| buildingName2 |
string |
optional |
|
Building/Property name 2. |
| streetName |
string |
optional |
|
The name of the street. |
| streetType |
string |
optional |
|
The street type. Valid enumeration defined by Australia Post PAF code file. |
| streetSuffix |
string |
optional |
|
The street type suffix. Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryType |
string |
optional |
|
Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. |
| postalDeliveryNumber |
PositiveInteger |
optional |
|
Postal delivery number if the address is a postal delivery type. |
| postalDeliveryNumberPrefix |
string |
optional |
|
Postal delivery number prefix related to the postal delivery number. |
| postalDeliveryNumberSuffix |
string |
optional |
|
Postal delivery number suffix related to the postal delivery number. |
| localityName |
string |
mandatory |
|
Full name of locality. |
| postcode |
string |
mandatory |
|
Postcode for the locality. |
| state |
string |
mandatory |
|
State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT. |
Links
{
"self": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| self |
URIString |
mandatory |
|
Fully qualified link that generated the current response document. |
{}
None
LinksPaginated
{
"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
Properties
| Name |
Type |
Required |
Default |
Description |
| self |
URIString |
mandatory |
|
Fully qualified link that generated the current response document. |
| first |
URIString |
conditional |
|
URI to the first page of this set. Mandatory if this response is not the first page. |
| prev |
URIString |
conditional |
|
URI to the previous page of this set. Mandatory if this response is not the first page. |
| next |
URIString |
conditional |
|
URI to the next page of this set. Mandatory if this response is not the last page. |
| last |
URIString |
conditional |
|
URI to the last page of this set. Mandatory if this response is not the last page. |
{
"totalRecords": 0,
"totalPages": 0
}
| Name |
Type |
Required |
Default |
Description |
| totalRecords |
NaturalNumber |
mandatory |
|
The total number of records in the full set. See pagination. |
| totalPages |
NaturalNumber |
mandatory |
|
The total number of pages in the full set. See pagination. |
{
"totalRecords": 0,
"totalPages": 0,
"isQueryParamUnsupported": false
}
allOf
| Name |
Type |
Required |
Default |
Description |
| anonymous |
MetaPaginated |
mandatory |
|
none |
and
| Name |
Type |
Required |
Default |
Description |
| anonymous |
object |
mandatory |
|
none |
| » isQueryParamUnsupported |
Boolean |
optional |
false |
true if text query parameter is not supported. |
ResponseErrorListV2
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
]
}
Properties
| Name |
Type |
Required |
Default |
Description |
| errors |
[ErrorV2] |
mandatory |
|
List of errors. |
ErrorV2
{
"code": "string",
"title": "string",
"detail": "string",
"meta": {
"urn": "string"
}
}
Properties
| Name |
Type |
Required |
Default |
Description |
| code |
string |
mandatory |
|
The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN. |
| title |
string |
mandatory |
|
A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code. |
| detail |
string |
mandatory |
|
A human-readable explanation specific to this occurrence of the problem. |
| meta |
object |
conditional |
|
Additional data for customised error codes. |
| » urn |
string |
conditional |
|
The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code. |
BankingProductCategory
"BUSINESS_LOANS"
The category to which a product or account belongs. See here for more details.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
Enum |
mandatory |
|
The category to which a product or account belongs. See here for more details. |
Enumerated Values
| Property |
Value |
| anonymous |
BUSINESS_LOANS |
| anonymous |
CRED_AND_CHRG_CARDS |
| anonymous |
LEASES |
| anonymous |
MARGIN_LOANS |
| anonymous |
OVERDRAFTS |
| anonymous |
PERS_LOANS |
| anonymous |
REGULATED_TRUST_ACCOUNTS |
| anonymous |
RESIDENTIAL_MORTGAGES |
| anonymous |
TERM_DEPOSITS |
| anonymous |
TRADE_FINANCE |
| anonymous |
TRANS_AND_SAVINGS_ACCOUNTS |
| anonymous |
TRAVEL_CARDS |
NppPaymentService
"X2P1"
Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. See here for more details.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
Enum |
mandatory |
|
Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. See here for more details. |
Enumerated Values
| Property |
Value |
| anonymous |
X2P1 |
| anonymous |
IFTI |
| anonymous |
BSCT |
| anonymous |
CATSCT |
BankingProductId
"string"
A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines. |
BankingAccountId
"string"
A unique identifier for a Banking account, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for a Banking account, generated according to CDR ID Permanence requirements. |
BankingTransactionId
"string"
A unique identifier for a Banking transaction, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for a Banking transaction, generated according to CDR ID Permanence requirements. |
BankingScheduledPaymentId
"string"
A unique identifier for a Banking scheduled payment, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for a Banking scheduled payment, generated according to CDR ID Permanence requirements. |
BankingPayeeId
"string"
A unique identifier for a Banking payee, generated according to CDR ID Permanence requirements.
Properties
| Name |
Type |
Required |
Default |
Description |
| anonymous |
ASCIIString |
mandatory |
|
A unique identifier for a Banking payee, generated according to CDR ID Permanence requirements. |
Product Categories
The productCategory enumeration provides the values for categorising products and accounts. These are explained in the following tables:
Deposit Products
| Enum |
Description |
| REGULATED_TRUST_ACCOUNTS |
This grouping of products includes accounts where funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers. |
| TERM_DEPOSITS |
This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds. |
| TRANS_AND_SAVINGS_ACCOUNTS |
This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc. |
| TRAVEL_CARDS |
This grouping of products includes prepaid cards with multi-currency capabilities. |
Lending Products
| Enum |
Description |
| BUSINESS_LOANS |
This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease. |
| CRED_AND_CHRG_CARDS |
This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards. |
| LEASES |
This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc. |
| MARGIN_LOANS |
This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds. |
| OVERDRAFTS |
This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements. |
| PERS_LOANS |
This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans. |
| RESIDENTIAL_MORTGAGES |
This grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing. |
| TRADE_FINANCE |
This grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit. |
Product & Account Components
Product Feature Types
Description of the usage of the featureType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| ADDITIONAL_CARDS |
Additional cards can be requested. |
The maximum number of additional cards. If no maximum then should be set to null. |
| BALANCE_TRANSFERS |
Balance transfers can be made to the account (e.g., for credit cards). |
N/A |
| BILL_PAYMENT |
The product can be attached to an automatic budgeting and bill payment service. |
Optional name of the service. |
| BONUS_REWARDS |
Bonus loyalty rewards points are available. |
Number of points available. |
| CARD_ACCESS |
A card is available for the product to access funds. |
Text describing list of card types that this product can be linked to. |
| CASHBACK_OFFER |
Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. |
The amount of the cashback offer (in AUD). |
| COMPLEMENTARY_PRODUCT_DISCOUNTS |
Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available. |
Description of the complementary offering. |
| DIGITAL_BANKING |
Access is available to online banking features for the product. |
N/A |
| DIGITAL_WALLET |
A Digital wallet can be attached to the product. |
The name or brand of the wallet. |
| DONATE_INTEREST |
Indicates that interest generated from the product can be automatically donated to a charity or community group. |
N/A |
| EXTRA_REPAYMENTS |
Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis). |
N/A |
| FRAUD_PROTECTION |
The product includes fraud protection features. |
N/A |
| FREE_TXNS |
A set number of free transactions available per month. |
The number of free transactions. |
| FREE_TXNS_ALLOWANCE |
A set amount of transaction fee value that is discounted per month. |
The amount of transaction fee discounted (in AUD). |
| GUARANTOR |
Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. |
N/A |
| INSTALMENT_PLAN |
The product has the option to pay for eligible purchases over time with a set number of payments. |
N/A |
| INSURANCE |
Insurance is provided as an additional feature of the product. |
Text description of the type of insurance (e.g., Travel Insurance). |
| INTEREST_FREE |
Interest free period for purchases. |
Interest free period. Formatted according to ISO 8601 Durations. |
| INTEREST_FREE_TRANSFERS |
Interest free period for balance transfers. |
Interest free period. Formatted according to ISO 8601 Durations. |
| LOYALTY_PROGRAM |
A points based loyalty program is available. |
Name of the loyalty program. |
| NOTIFICATIONS |
Advanced notifications are available for the product. |
Description of the notification capability. |
| NPP_ENABLED |
An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment. |
N/A |
| NPP_PAYID |
An account of this product type can be used as the target of an NPP PayID. |
N/A |
| OFFSET |
An offset account can be connected to the product. |
N/A |
| OTHER |
Another feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this type. |
N/A |
| OVERDRAFT |
An overdraft can be applied for. |
N/A |
| REDRAW |
Redraw of repaid principal above minimum required is available. |
N/A |
| RELATIONSHIP_MANAGEMENT |
Relationship management is available for eligible customers. |
N/A |
| UNLIMITED_TXNS |
Unlimited free transactions available. |
N/A |
Product Constraint Types
Description of the usage of the constraintType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| MAX_BALANCE |
A maximum balance is required for the product. |
The maximum balance in AmountString format. |
| MAX_LIMIT |
A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit). |
The maximum limit in AmountString format. |
| MAX_LVR |
A maximum LVR (Loan to Value Ratio) exists. |
The maximum LVR in RateString format. |
| MIN_BALANCE |
A minimum balance is required for the product. |
The minimum balance in AmountString format. |
| MIN_LIMIT |
A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit). |
The minimum limit in AmountString format. |
| MIN_LVR |
A minimum LVR (Loan to Value Ratio) exists. |
The minimum LVR in RateString format. |
| OPENING_BALANCE |
An opening balance is required for the product. |
The minimum opening balance in AmountString format. |
Product Eligibility Types
Description of the usage of the eligibilityType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| BUSINESS |
Only business may apply for the account. |
N/A |
| EMPLOYMENT_STATUS |
An eligibility constraint based on employment status applies. |
A description of the status required. |
| MAX_AGE |
Only customers younger than a maximum age may apply. |
The maximum age in years. |
| MIN_AGE |
Only customers older than a minimum age may apply. |
The minimum age in years. |
| MIN_INCOME |
The customer must have an income greater than a specified threshold to obtain the product. |
Minimum income in AmountString format. |
| MIN_TURNOVER |
Only a business with greater than a minimum turnover may apply. |
Minimum turnover in AmountString format. |
| NATURAL_PERSON |
The customer must be a natural person rather than another legal entity. |
N/A |
| OTHER |
Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory). |
N/A |
| PENSION_RECIPIENT |
Only a recipient of a government pension may apply for the product. |
N/A |
| RESIDENCY_STATUS |
An eligibility constraint based on residency status applies. |
A description of the status required. |
| STAFF |
Only a staff member of the provider may apply. |
N/A |
| STUDENT |
Only students may apply for the product. |
N/A |
Product Fee Types
Description of the usage of the feeType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| DEPOSIT |
A fee associated with making a deposit. |
N/A |
| EVENT |
A fee in relation to a particular event (e.g., ordering a new card, viewing a balance or stopping a cheque). |
N/A |
| EXIT |
A fee for closing the product. |
N/A |
| PAYMENT |
A fee associated with making a payment. |
N/A |
| PERIODIC |
A periodic fee such as a monthly account servicing fee. |
The period of charge. Formatted according to ISO 8601 Durations. |
| PURCHASE |
A fee associated with making a purchase at a merchant. |
N/A |
| TRANSACTION |
A fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE). |
N/A |
| UPFRONT |
A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee. |
N/A |
| VARIABLE |
An at-cost fee that is relevant to a customer's circumstances where the amount or rate may not be known until negotiated with the customer. |
N/A |
| WITHDRAWAL |
A fee associated with making a withdrawal. |
N/A |
Product Discount Types
Description of the usage of the discountType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| BALANCE |
Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee. |
The minimum balance in AmountString format. |
| DEPOSITS |
Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. |
The minimum deposit amount in AmountString format. |
| ELIGIBILITY_ONLY |
Discount applies based on customer eligibility (eligibility array must be populated). |
N/A |
| FEE_CAP |
The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period. |
The time period for which the fee cap applies. Formatted according to ISO 8601 Durations. |
| PAYMENTS |
Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. |
The payment threshold amount in AmountString format. |
Product Discount Eligibility Types
Description of the usage of the discountEligibilityType field as it applies to products.
| Value |
Description |
Use of additionalValue Field |
| BUSINESS |
A business or other non-person legal entity. |
N/A |
| EMPLOYMENT_STATUS |
An eligibility constraint based on employment status applies. |
A description of the status required. |
| INTRODUCTORY |
The discount is only available during an introductory period. |
The period of time for the introductory discount. Formatted according to ISO 8601 Durations. |
| MAX_AGE |
Only customers younger than a maximum age receive the discount. |
The maximum age in years. |
| MIN_AGE |
Only customers older than a minimum age receive the discount. |
The minimum age in years. |
| MIN_INCOME |
The customer must have an income greater than a specified threshold to obtain the discount. |
Minimum income in AmountString format. |
| MIN_TURNOVER |
Only a business with greater than a minimum turnover is eligible. |
Minimum turnover in AmountString format. |
| NATURAL_PERSON |
The customer must be a natural person rather than another legal entity. |
N/A |
| OTHER |
Another eligibility criteria exists as described in the additionalInfo field (if this option is specified then the additionalInfo field is mandatory). |
N/A |
| PENSION_RECIPIENT |
Only a recipient of a government pension may receive the discount. |
Optional. Should contain a description of which pensions qualify. |
| RESIDENCY_STATUS |
An eligibility constraint based on residency status applies. |
A description of the status required. |
| STAFF |
Only a staff member of the provider may receive the discount. |
N/A |
| STUDENT |
Only students may receive the discount. |
Optional. Should contain a description of who qualifies as a student, e.g., do apprentices qualify? |
Product Deposit Rate Types
Description of the usage of the depositRateType field as it applies to products.
A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
| Value |
Description |
Use of additionalValue Field |
| FIXED |
Fixed rate for a period of time. |
The period of time fixed. Formatted according to ISO 8601 Durations. |
| FLOATING |
A floating rate is relatively fixed but still adjusts under specific circumstances. |
Details of the float parameters. |
| MARKET_LINKED |
A rate that is linked to a specific market, commodity or asset class. |
Details of the market linkage. |
| VARIABLE |
A variable base rate for the product. |
N/A |
- Deposit Adjustment Rate Types
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
| Value |
Description |
Use of additionalValue Field |
| BONUS |
A bonus rate available by meeting a specific criteria. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). |
A description of the criteria to obtain the bonus. |
| BUNDLE_BONUS |
A bonus rate obtained by originating a bundle instead of a standalone product. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). |
The name of the bundle. |
| INTRODUCTORY |
An introductory bonus that will expire after a set period. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). |
The period of time for the introductory rate. Formatted according to ISO 8601 Durations. |
Product Lending Rate Types
Description of the usage of the lendingRateType field as it applies to products.
A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.
Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.
| Value |
Description |
Use of additionalValue Field |
| CASH_ADVANCE |
Specific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. |
N/A |
| FIXED |
Fixed rate for a period of time. |
The period of time fixed. Formatted according to ISO 8601 Durations. |
| FLOATING |
A floating rate is relatively fixed but still adjusts under specific circumstances. |
Details of the float parameters. |
| MARKET_LINKED |
A rate that is linked to a specific market, commodity or asset class. |
Details of the market linkage. |
| PURCHASE |
Specific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. |
N/A |
| VARIABLE |
A variable base rate for the product. |
N/A |
- Lending Adjustment Rate Types
A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.
| Value |
Description |
Use of additionalValue Field |
| BUNDLE_DISCOUNT_FIXED |
A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). |
The name of the bundle. |
| BUNDLE_DISCOUNT_VARIABLE |
A discount rate off the variable rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). |
The name of the bundle. |
| DISCOUNT |
A specific discount rate that may be applied. A discount rate reduces the interest payable. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). |
Description of the discount rate that is applicable. |
| INTRODUCTORY |
An introductory discount that will expire after a set period. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). |
The period of time for the introductory rate. Formatted according to ISO 8601 Durations. |
| PENALTY |
A specific penalty rate that may be applied. A penalty rate increases the interest payable. A lending 'penalty' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Penalty). |
Description of the penalty rate that is applicable. |
Banking Term Deposit Account Types
Description of the usage of the maturityInstructions field as it applies to accounts.
| Value |
Description |
Use of additionalValue Field |
| HOLD_ON_MATURITY |
Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer. |
N/A |
| PAID_OUT_AT_MATURITY |
Funds are to be paid out at maturity. |
N/A |
| ROLLED_OVER |
Funds are to be rolled over at maturity. |
N/A |
