Skip to main content

List Banking Accounts

The purpose of this endpoint is to deliver accounts related to a specific Principal using the principalId .

This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoints:

Data Adapter API​

List Banking Accounts​

Loading...

Β 


Consumer Data Standards Associations​

Get Banking Accounts​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.400urn:au-cds:error:cds-all:GeneralError/Expected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid

Get Account Detail​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

404urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.400urn:au-cds:error:cds-all:GeneralError/Expected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid

Get Account Balance​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

404urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.400urn:au-cds:error:cds-all:GeneralError/Expected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid

Get Bulk Balances​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

404urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.400urn:au-cds:error:cds-all:GeneralError/Expected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid

Get Balances For Specific Banking Accounts​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Field400urn:au-cds:error:cds-all:Field/Invalid

Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints.
Invalid format supplied for accountIds.

404urn:au-cds:error:cds-banking:Authorisation/UnavailableBankingAccount
Invalid Header400urn:au-cds:error:cds-all:Header/Invalid

Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards.
x-fapi-interaction-id - If supplied, it must be a Universal Unique Identifier (UUID) and compliant with RFC4122. If not supplied, a compliant value is autogenerated.
Invalid format supplied for
x-fapi-interaction-id.

500urn:au-cds:error:cds-all:GeneralError/Unexpected
Expected Error400urn:au-cds:error:cds-all:GeneralError/ExpectedThis status code indicates that the Expected Error has encountered.400urn:au-cds:error:cds-all:GeneralError/Expected
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:GeneralError/Unexpected
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid

Data Adapter version to CDR version mapping​

Note

AdapterBankingAccountV3 must be supported before March 16th 2026. Support for AdapterBankingAccountV2 will be removed in the Nebula.01 Series release.

We recommend adopting AdapterBankingAccountV5 which includes support for the latest CDR product and account endpoints.

Data Adapter VersionCDR VersionTransformation details
AdapterBankingAccountV5Get Account Detail V5This is a 1:1 mapping. No transformation required.
Get Account Detail V4Further information on this transformation, refer to downgrade logic detailed below for corresponding objects.
Get Account Detail V3Further information on this transformation, refer to downgrade logic detailed below for corresponding objects.
AdapterBankingAccountV4Get Account Detail V5This is a 1:1 mapping. No transformation required.
Get Account Detail V4Further information on this transformation, refer to downgrade logic detailed below for corresponding objects.
Get Account Detail V3Further information on this transformation, refer to downgrade logic detailed below for corresponding objects.
AdapterBankingAccountV3Get Account Detail V4This is a 1:1 mapping. No transformation required.
Get Account Detail V5⚠️ Not supported.
AdapterBankingAccountV2Get Account Detail V3This is a 1:1 mapping. No transformation required. Supported only until 10th May 2026.
Get Account Detail V4⚠️ Not supported.
Get Account Detail V5⚠️ Not supported.

AdapterBankingAccountV4 -> AdapterBankingAccountV5 Changes​

Note

AdapterBankingAccountV5 was introduced in HaaS Data Adapter API 2.4.0. It maps 1:1 to Get Account Detail V5, the same as AdapterBankingAccountV4; the change is on the adapter's own account representation rather than the CDR-facing shape.

CategoryChange SummaryDetails
Now Optionalbsbbsb is no longer a required field. Not all account types have a BSB β€” for example accounts held with a non-bank lender (NBL) may not have one, in which case the field should be omitted.
Downgrade logic – AdapterBankingAccountV5 β†’ AdapterBankingAccountV4​
ObjectFieldDowngrade Logic
AdapterBankingAccountV5β†’AdapterBankingAccountV4bsbbsb is mandatory on AdapterBankingAccountV4. If bsb is absent on the AdapterBankingAccountV5 account, the account will be dropped.

Get Account Detail V5 Changes​

Note

Summary of changes for Get Account Detail V5 included in AdapterBankingAccountV4:

  1. Introduction of BankingProductInstalments

  2. BankingProductFeatureV3 β†’ BankingProductFeatureV4

  3. BankingProductCategory β†’ BankingProductCategoryV2

CategoryChange SummaryDetails
New FieldinstalmentsDetails of instalment features on the account.
New FieldisInstalmentDetailAvailableboolean (default false). true if any active or inactive instalment plans are available in the Get Instalment Plans endpoints; false if instalment plans are not applicable to the account. Signals to ADRs whether the Get Instalment Plans endpoints should be called for the account.
Expanded EnumproductCategorySame as V1 plus new enum BUY_NOW_PAY_LATER.
Downgrade logic – Get Account Detail V5 β†’ Get Account Detail V4 and Get Account Detail V5 -> Get Account Detail V3 Changes​
ObjectFieldDowngrade Logic
Get Account Detail V5β†’Get Account Detail V4instalmentsIf instalments present, the instalments object will be dropped
Get Account Detail V5β†’Get Account Detail V4isInstalmentDetailAvailableIf isInstalmentDetailAvailable present, the field will be dropped
Get Account Detail V5β†’Get Account Detail V4productCategoryIf productCategory=BUY_NOW_PAY_LATER, this account will be dropped
Get Account Detail V5β†’Get Account Detail V3instalmentsIf instalments present, the instalments object will be dropped
Get Account Detail V5β†’Get Account Detail V3productCategoryIf productCategory=BUY_NOW_PAY_LATER, this account will be dropped

BankingProductInstalmentsV1​

The instalments object (BankingProductInstalmentsV1) describes the instalment features available on the account.

FieldTypeRequiredDescription
maximumConcurrentPlansNaturalNumberOPTIONALMaximum number of concurrent active instalment plans that may be created on the account. If null, there is no predetermined maximum number.
instalmentsLimitAmountStringOPTIONALMaximum combined limit of all instalment plans that may be created on the account. If null or not present, an opened account balance creditLimit may be assumed.
minimumPlanValueAmountStringOPTIONALMinimum value that can be opened as an instalment plan.
maximumPlanValueAmountStringOPTIONALMaximum value that can be opened as an instalment plan. If null or not present, instalmentsLimit is assumed to be the maximum individual plan value.
minimumSplitPositiveIntegerREQUIREDMinimum number of instalment payments a plan can be created with.
maximumSplitPositiveIntegerREQUIREDMaximum number of instalment payments a plan can be created with.

Get Account Detail V4 Changes​

Note

Summary of changes for Get Account Detail V4 included in AdapterBankingAccountV3:

  1. BankingLoanAccountV2 β†’ BankingLoanAccountV3
  2. BankingProductDepositRateV2 β†’ BankingProductDepositRateV3
  3. BankingProductLendingRateV2 β†’ BankingProductLendingRateV3
  4. BankingProductFeatureV2 β†’ BankingProductFeatureV3
  5. BankingProductFee β†’ BankingProductFeeV2

BankingLoanAccountV3 Changes​

ObjectFieldChangeDescription
BankingLoanAccountV3repaymentType requiredNew enum values introduced. No default values. Field is now mandatory.Map old β†’ new: - INTEREST_ONLY β†’ same - PRINCIPAL_AND_INTEREST β†’ same - handle OTHER or UNCONSTRAINED if applicable.
BankingLoanAccountV3New default currenciesDefault values added for consistency.Set default AUD when not specified.
Downgrade logic​
ObjectFieldDowngrade Logic
BankingLoanAccountV3->BankingLoanAccountV2repaymentTypeIf values are either OTHER or UNCONSTRAINED, the loan will be marked as null, and data.specificAccountUType field will also be marked as null.

BankingProductDepositRateV3 Changes​

DioBankingProductDepositRateV2 β†’ BankingProductDepositRateV3 Changes​
CategoryChange SummaryDetails
New FieldapplicationTypeNew enum describing when the deposit rate applies.Values: MATURITY, PERIODIC, UPFRONT.
New FieldrateApplicabilityTypeNew enum defining why or under what rule a rate is applied (see below for full list).
Conditional FieldapplicationFrequencyMandatory only when applicationType = PERIODIC.
Conditional FieldadditionalValueWhether mandatory or not is dependent on the value of depositRateType
New FieldapplicabilityConditionsArray of structured condition objects (BankingProductRateConditionV2) defining eligibility logic.
Updated ReferencetiersSchema updated from BankingProductRateTierV3 β†’ BankingProductRateTierV4.
Required FieldsUpdatedMust now include applicationType, rateApplicabilityType, depositRateType, and rate.
BankingProductRateTierV3 β†’ BankingProductRateTierV4 Changes​
Change TypeFieldDescription
ChangedapplicabilityConditionsChanged from BankingProductRateCondition to an array of BankingProductRateConditionV2 Each tier can define its own BankingProductRateConditionV2 list.
ClarifiedminimumValue / maximumValueExplicitly defined as inclusive bounds.
BankingProductRateCondition β†’ BankingProductRateConditionV2 Changes​
Change TypeFieldDescription
New Enum FieldrateApplicabilityTypeCategory of applicability condition associated with the rate.
New FieldadditionalValueGeneric field containing additional information relevant to the rateApplicabilityType specified. Whether mandatory or not is dependent on the value of rateApplicabilityType.
RetainedadditionalInfoDisplay text providing more information on the condition. Mandatory if the rateApplicabilityType value is OTHER.
Downgrade logic​
ObjectFieldDowngrade Logic
BankingProductDepositRateV3 β†’ BankingProductDepositRateV2applicationType, rateApplicabilityType, and applicabilityConditionsSince these are newly introduced fields, downgrade will drop these fields.
BankingProductRateTierV4.[BankingProductRateConditionV2] β†’ BankingProductRateTierV3.BankingProductRateConditionV1rateApplicabilityType and additionalValuerateApplicabilityType and additionalValue fields will be dropped, and if there are more than one eligibility conditions, for each, a new tier will be created when downgrading.

BankingProductLendingRateV3 Changes​

CategoryChange SummaryDetails
New FieldapplicationTypeNew enum describing when the lending rate applies.Values: MATURITY, PERIODIC, UPFRONT.
New FieldapplicabilityConditionsArray of structured condition objects (BankingProductRateConditionV2) defining eligibility logic.
Conditional FieldapplicationFrequencyMandatory only when applicationType = PERIODIC.
Conditional FieldadditionalValueWhether mandatory or not is dependent on the value of lendingRateType
Required FieldsUpdatedMust now include applicationType, lendingRateType, loanPurpose, repaymentType and rate.
Downgrade logic​
ObjectFieldDowngrade Logic
BankingProductLendingRateV3β†’ BankingProductLendingRateV2applicationType and applicabilityConditionsSince these are newly introduced fields, downgrade will drop these fields.
BankingProductLendingRateV3β†’ BankingProductLendingRateV2lendingRateTypeIf lendingRateType = BALANCE_TRANSFER, downgrade will drop this lending rate record.
BankingProductRateTierV4.[BankingProductRateConditionV2] β†’ BankingProductRateTierV3.BankingProductRateConditionV1rateApplicabilityType and additionalValuerateApplicabilityType and additionalValue fields will be dropped, and if there are more than one eligibility conditions, for each, a new tier will be created when downgrading.

BankingProductFeatureV3 Changes​

CategoryChange SummaryDetails
Expanded EnumfeatureTypeSame as V2 plus new enum FUNDS_AVAILABLE_AFTER.
Conditional FieldadditionalInfoNow mandatory when featureType = OTHER.
Conditional FieldadditionalValueNow mandatory when featureType = OTHER.
Changed FieldisActivatedType changed (boolean β†’ enum)
ObjectFieldDowngrade Logic
BankingProductFeatureV3β†’BankingProductFeatureV2featureTypeIf the new enum FUNDS_AVAILABLE_AFTER is present, whole feature object will dropped, as this a mandatory field.
BankingProductFeatureV3β†’BankingProductFeatureV2isActivatedACTIVATED will be transformed to true and false for any other values.

BankingProductFeatureV3 β†’ BankingProductFeatureV4 Changes​

CategoryChange SummaryDetails
Expanded EnumfeatureTypeSame as V3 plus new enum EXTRA_DOWN_PAYMENT.
Downgrade logic​
ObjectFieldDowngrade Logic
BankingProductFeatureV4β†’BankingProductFeatureV3featureTypeIf the new enum EXTRA_DOWN_PAYMENT is present, whole feature object will dropped, as this a mandatory field.
BankingProductFeatureV4β†’BankingProductFeatureV2featureTypeIf the new enum EXTRA_DOWN_PAYMENT or FUNDS_AVAILABLE_AFTER is present, whole feature object will dropped, as this a mandatory field.
BankingProductFeatureV4β†’BankingProductFeatureV2isActivatedACTIVATED will be transformed to true and false for any other values.
BankingProductFeatureV3β†’BankingProductFeatureV2featureTypeIf the new enum FUNDS_AVAILABLE_AFTER is present, whole feature object will dropped, as this a mandatory field.
BankingProductFeatureV3β†’BankingProductFeatureV2isActivatedACTIVATED will be transformed to true and false for any other values.

BankingProductFeeV2 Changes​

CategoryChange SummaryDetails
Expanded EnumfeeTypeRemoved - VARIABLE Added - CASH_ADVANCE, DISHONOUR, ENQUIRY, LATE_PAYMENT, OTHER, REPLACEMENT, UPFRONT_PER_PLAN, VARIATION.
New FieldfeeMethodUTypestring enum: fixedAmount, rateBased, variable.
New FieldfeeCapcap amount if multiple occurrences are capped.
New FieldfeeCapPeriodSpecifies a duration over which multiple occurrences of the fee will be capped.
New FieldvariableMandatory if the feeMethodUType value is variable, and structurally changed to BankingFeeRangeV1
New FieldrateBasedMandatory if the feeMethodUType value is rateBased, and structurally changed to BankingFeeRateV1
Changed FieldaccruedRate β†’ rateBased.*Mandatory if the feeMethodUType value is rateBased. and rateBased.rateType = INTEREST_ACCRUED.
Changed FieldbalanceRate β†’ rateBased.*Mandatory if the feeMethodUType value is rateBased. and rateBased.rateType = BALANCE.
Changed FieldtransactionRate β†’ rateBased.*Mandatory if the feeMethodUType value is rateBased. and rateBased.rateType = TRANSACTION.
Changed FieldaccrualFrequency β†’ ratedBased.accrualFrequencyMoved under rateBased object. Applies only if the feeMethodUType value is rateBased. and rateBased.rateType = INTEREST_ACCRUED or BALANCE
Changed FieldamountMandatory if the feeMethodUType value is fixedAmount. Moved into fixedAmount, and structurally changed to BankingFeeAmountV1
Changed FieldcurrencyCurrency is expressed inside BankingFeeAmountV1.
Conditional FieldadditionalInfoNow mandatory when feeType = OTHER.
Conditional FieldadditionalValueNow mandatory when feeType = OTHER.
BankingFeeDiscountAmountV1 -> BankingFeeDiscountAmountV2 Changes​
CategoryChange SummaryDetails
Changed Fielddiscounts.amount β†’ discounts.fixedAmount.amountMandatory if the discountMethodUType value is fixedAmount.
Changed Fielddiscounts.currency β†’ discounts.fixedAmount.currencyMandatory if the discountMethodUType value is fixedAmount.
Changed Fielddiscounts.accruedRate β†’ discounts.rateBasedMandatory if the discountMethodUType value is rateBased.
Changed Fielddiscounts.balanceRate β†’ discounts.rateBasedMandatory if the discountMethodUType value is rateBased.
Changed Fielddiscounts.transactionRate β†’ discounts.rateBasedMandatory if the discountMethodUType value is rateBased.
Changed Fielddiscounts.feeRate β†’ discounts.rateBasedMandatory if the discountMethodUType value is rateBased.
Downgrade logic​
ObjectFieldDowngrade Logic
BankingProductFeeV2β†’BankingProductFeeV1feeTypefeeType = CASH_ADVANCE, DISHONOUR, ENQUIRY, LATE_PAYMENT, OTHER, REPLACEMENT, UPFRONT_PER_PLAN, VARIATION the fee record will be dropped.
BankingProductFeeV2β†’BankingProductFeeV1If feeMethodUType=rateBased; then rateBased will be transformed.accruedRate or transactionRate or balanceRate will be built, based on rateBased.rateType
BankingProductFeeV2β†’BankingProductFeeV1If feeMethodUType=rateBased and rateBased.rateType=BALANCE/INTEREST_ACCRUED ratedBased.accrualFrequency -> accrualFrequency
BankingProductFeeV2β†’BankingProductFeeV1If feeMethodUType=fixedAmount; then fixedAmount will be transformed.fixedAmount.amount -> amount will be built and if amount is not null/empty currency will be defaulted to AUD.
BankingProductFeeV2β†’BankingProductFeeV1If feeMethodUType=variable; then variable will be transformed.If feeMethodUType=variable; then feeType will be set to variable, and amount will be set to null, as feeMinimum and feeMaximum cannot be mapped.
BankingProductFeeV2β†’BankingProductFeeV1feeCapThis will be dropped.
BankingProductFeeV2β†’BankingProductFeeV1feeCapPeriodThis will be dropped.
BankingProductDiscountV2β†’BankingProductDiscountV1If the discountMethodUType value is fixedAmount, fixedAmount.amount -> amountdiscounts.fixedAmount.amount -> discounts.amount discounts.fixedAmount.currency -> discounts.currency
BankingProductDiscountV2β†’BankingProductDiscountV1If the discountMethodUType value is rateBased and discounts.rateBased.rateType = BALANCE or FEE or INTEREST_ACCRUED or TRANSACTIONdiscounts.rateBased.accruedRate -> discounts.accruedRate discounts.rateBased.balanceRate -> discounts.balanceRate discounts.rateBased.transactionRate -> discounts.transactionRate discounts.rateBased.feeRate -> discounts.feeRate

Supplemental Fields​

Beyond attributes which map one-to-one between Data Adapter and Consumer Data Standards fields the following are identified as additional fields specifically with relation to the successful operation of the HaaS environment:

NameDescription
accountCustomers[]An array of relationships between a specified account and one or more Principals.
accountCustomers[].userIdThe User Identifier associated with the specified relationship.
accountCustomers[].relationshipAn enumeration specifying the type of relationship for the account and specified Principal
accountCustomers[].vulnerableA boolean specifying whether, in the context of this particular Account and Principal relationship the Principal should be considered a vulnerable customer.

Endpoint Specific Guidance​

  • The Data Adapter call is made with an accountIds filter for any call after consent flow is completed

  • In a number of cases the Data Adapter specifically uses a JSON number type rather than an x-cds-type and additionally may apply a minimum and maximum value. The reasoning for this is to avoid source system issues related to;

  • Conversion issues (ie. floating points)

  • Incorrect decimalisation (i.e., interest rate of 1.5% being incorrectly provided as 1.5 which is equal to 150%).

The HaaS environment will ensure that number types will be appropriately converted to the relevant CDS types (ie. RateString and AmountString)

List Banking Accounts Optimisation Guidelines​

The List Banking Accounts endpoint combines several purposes and CDR endpoints into one call. However, you can still identify the specific purpose of each request. There are three different ways List Banking Accounts can be called, and each determines how much data is returned:

List Accounts ParametersMeaningOccurrence
No account IDsConsent Flow
β–ͺ Consent Flow
β–ͺ HaaS Admin
1 account IDCDS DetailADR data requests
> 1 account IDCDS BasicADR data requests
Adapter SpecConsent flowbank:accounts.basic:read
id ≀ 255 Characters
> A unique ID of the account.
REQUIREDREQUIRED
internalId
> Internal Account Identifier.
REQUIREDREQUIRED
accountNumber
> The Account Number for the account. Note: As from 1.12.1, this field has changed from a Number to a String. This change is backwards compatible and will currently accept a JSON number returned from the adapter but this behaviour is now deprecated and will be removed in a future release.
REQUIREDREQUIRED
displayName
> The display name of the account as defined by the bank. This should not incorporate account numbers or PANs.
REQUIREDREQUIRED
bsb INTEGER β‰₯ 1
> The BSB for the account. If a string is supplied and it is a valid integer it will be parsed and then zero padded on return.
⚠️ As of AdapterBankingAccountV5 (HaaS Data Adapter API 2.4.0), bsb is optional on the adapter response β€” not all account types (e.g. non-bank lender accounts) have a BSB.
REQUIREDOPTIONAL
productCategory ENUM
> The Product Category enumeration lists the available product categories for categorising products and accounts. These are explained in the following tables:
REQUIREDREQUIRED
productName
> The Product Name associated with the Account
REQUIREDREQUIRED
nickname
> A customer supplied nick name for the Account
REQUIREDOPTIONAL
status ENUM
> Open or closed status for the account. If not present then OPEN is assumed.
β–ͺ CLOSED
β–ͺ OPEN
REQUIREDOPTIONAL
If not present then OPEN is assumed.
accountCustomers LIST
> List of Account Customer entries
REQUIREDREQUIRED
displayName
> The display name of the account as defined by the bank. This should not incorporate account numbers or PANs.
REQUIREDREQUIRED
creationDate DATE
Date that the account was created (if known)
REQUIREDOPTIONAL

Β 


Supplemental fields​

No supplemental fields are specified.

Endpoint Specific Guidance​

N/A