Get Account Detail V1
This page documents the obsolete version 1 of the Get Account Detail end point.
This version is to be ceased to be called by data recipients by February 28th 2023 and can be decommissioned by data holders as of that date.
Get Account Detail
Code samples
GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId} HTTP/1.1
Host: data.holder.com.au
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
var 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'
};
$.ajax({
url: 'https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
GET /banking/accounts/{accountId}
Obtain detailed information on a single account
Endpoint Version
Parameters
| Name |
In |
Type |
Required |
Description |
| accountId |
path |
ASCIIString |
mandatory |
A tokenised identifier for the account which is unique but not shareable |
| x-v |
header |
string |
mandatory |
Version of the API end point requested by the client. Must be set to a positive integer. The data holder 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 data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v |
header |
string |
optional |
Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder 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 |
optional |
The time when the customer last logged in to the Data Recipient Software Product. Required for all resource calls (customer present and unattended). Not to be included 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 |
optional |
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,
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "BONUS",
"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": "BUNDLE_DISCOUNT_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": "string",
"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 |
Format |
Description |
| 200 |
x-v |
string |
|
The version of the API end point that the data holder has responded with. |
| 200 |
x-fapi-interaction-id |
string |
|
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. |
| 4xx |
x-fapi-interaction-id |
string |
|
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. |
Properties
| Name |
Type |
Required |
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 |
ResponseBankingAccountList
{
"data": {
"accounts": [
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"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 |
Description |
| data |
object |
mandatory |
none |
| » accounts |
[BankingAccount] |
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 |
BankingAccount
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
Properties
| Name |
Type |
Required |
Description |
| accountId |
ASCIIString |
mandatory |
A unique ID of the account adhering to the standards for ID permanence |
| 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 nick name for the account |
| openStatus |
string |
optional |
Open or closed status for the account. If not present then OPEN is assumed |
| isOwned |
Boolean |
optional |
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 |
| 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 |
ResponseBankingAccountById
{
"data": {
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "BONUS",
"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": "BUNDLE_DISCOUNT_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": "string",
"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
BankingAccount
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string"
}
Properties
| Name |
Type |
Required |
Description |
| accountId |
ASCIIString |
mandatory |
A unique ID of the account adhering to the standards for ID permanence |
| 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 nick name for the account |
| openStatus |
string |
optional |
Open or closed status for the account. If not present then OPEN is assumed |
| isOwned |
Boolean |
optional |
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 |
| 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 |
BankingAccountDetail
{
"accountId": "string",
"creationDate": "string",
"displayName": "string",
"nickname": "string",
"openStatus": "CLOSED",
"isOwned": true,
"maskedNumber": "string",
"productCategory": "BUSINESS_LOANS",
"productName": "string",
"bsb": "string",
"accountNumber": "string",
"bundleName": "string",
"specificAccountUType": "creditCard",
"termDeposit": [
{
"lodgementDate": "string",
"maturityDate": "string",
"maturityAmount": "string",
"maturityCurrency": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
],
"creditCard": {
"minPaymentAmount": "string",
"paymentDueAmount": "string",
"paymentCurrency": "string",
"paymentDueDate": "string"
},
"loan": {
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
},
"depositRate": "string",
"lendingRate": "string",
"depositRates": [
{
"depositRateType": "BONUS",
"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": "BUNDLE_DISCOUNT_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": "string",
"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 |
Description |
| anonymous |
BankingAccount |
mandatory |
none |
and
| Name |
Type |
Required |
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 for to the customer |
| » specificAccountUType |
string |
optional |
The type of structure to present account specific fields. |
| » termDeposit |
[BankingTermDepositAccount] |
conditional |
none |
| » creditCard |
BankingCreditCardAccount |
conditional |
none |
| » loan |
BankingLoanAccount |
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 deposit 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 |
Description |
| »» anonymous |
object |
mandatory |
none |
| »»» isActivated |
Boolean |
optional |
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 |
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": "string",
"maturityInstructions": "HOLD_ON_MATURITY"
}
Properties
| Name |
Type |
Required |
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 |
If absent assumes AUD |
| maturityInstructions |
string |
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": "string",
"paymentDueDate": "string"
}
Properties
| Name |
Type |
Required |
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 |
If absent assumes AUD |
| paymentDueDate |
DateString |
mandatory |
Date that the next payment for the card is due |
BankingLoanAccount
{
"originalStartDate": "string",
"originalLoanAmount": "string",
"originalLoanCurrency": "string",
"loanEndDate": "string",
"nextInstalmentDate": "string",
"minInstalmentAmount": "string",
"minInstalmentCurrency": "string",
"maxRedraw": "string",
"maxRedrawCurrency": "string",
"minRedraw": "string",
"minRedrawCurrency": "string",
"offsetAccountEnabled": true,
"offsetAccountIds": [
"string"
],
"repaymentType": "INTEREST_ONLY",
"repaymentFrequency": "string"
}
Properties
| Name |
Type |
Required |
Description |
| originalStartDate |
DateString |
optional |
Optional original start date for the loan |
| originalLoanAmount |
AmountString |
optional |
Optional original loan value |
| originalLoanCurrency |
CurrencyString |
optional |
If absent assumes AUD |
| loanEndDate |
DateString |
mandatory |
Date that the loan is due to be repaid in full |
| nextInstalmentDate |
DateString |
mandatory |
Next date that an instalment is required |
| minInstalmentAmount |
AmountString |
optional |
Minimum amount of next instalment |
| minInstalmentCurrency |
CurrencyString |
optional |
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 |
If absent assumes AUD |
| minRedraw |
AmountString |
optional |
Minimum redraw amount |
| minRedrawCurrency |
CurrencyString |
optional |
If absent assumes AUD |
| offsetAccountEnabled |
Boolean |
optional |
Set to true if one or more offset accounts are configured for this loan account |
| offsetAccountIds |
[string] |
optional |
The accountIDs 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 |
string |
optional |
Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST |
| repaymentFrequency |
ExternalRef |
mandatory |
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 |
BankingProductFeature
{
"featureType": "ADDITIONAL_CARDS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Description |
| featureType |
string |
mandatory |
The type of feature described |
| 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 the feature type 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 |
COMPLEMENTARY_PRODUCT_DISCOUNTS |
| featureType |
DIGITAL_BANKING |
| featureType |
DIGITAL_WALLET |
| featureType |
DONATE_INTEREST |
| featureType |
FREE_TXNS |
| featureType |
FREE_TXNS_ALLOWANCE |
| featureType |
INSURANCE |
| 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 |
UNLIMITED_TXNS |
BankingProductConstraint
{
"constraintType": "MAX_BALANCE",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Description |
| constraintType |
string |
mandatory |
The type of constraint described. See the next section for an overview of valid values and their meaning |
| 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 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 |
MIN_BALANCE |
| constraintType |
MIN_LIMIT |
| constraintType |
OPENING_BALANCE |
BankingProductEligibility
{
"eligibilityType": "BUSINESS",
"additionalValue": "string",
"additionalInfo": "string",
"additionalInfoUri": "string"
}
Properties
| Name |
Type |
Required |
Description |
| eligibilityType |
string |
mandatory |
The type of eligibility criteria described. See the next section for an overview of valid values and their meaning |
| 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": "string",
"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 |
Description |
| name |
string |
mandatory |
Name of the fee |
| feeType |
string |
mandatory |
The type of fee |
| 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 |
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 |
Description |
| description |
string |
mandatory |
Description of the discount |
| discountType |
string |
mandatory |
The type of discount. See the next section for an overview of valid values and their meaning |
| 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 |
Description |
| discountEligibilityType |
string |
mandatory |
The type of the specific eligibility constraint for a discount |
| 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": "BONUS",
"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 |
Description |
| depositRateType |
string |
mandatory |
The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning |
| 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": "BUNDLE_DISCOUNT_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 |
Description |
| lendingRateType |
string |
mandatory |
The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning |
| 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 |
string |
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 |
string |
optional |
Options in place for repayments. If absent, the lending rate is applicable to all repayment types |
| loanPurpose |
string |
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 |
Description |
| name |
string |
mandatory |
A display name for the tier |
| unitOfMeasure |
string |
mandatory |
The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a 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 tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value |
| maximumValue |
Number |
optional |
The number of tierUnitOfMeasure 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 tierValueMinimum. Where this is the same as the tierValueMinimum 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 |
string |
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
