Skip to main content

Adapter endpoint changes summary

All changes introduced in HaaS Data Adapter API 2.4.0 (DSB Standards 1.36.3). For full transformation and downgrade logic, follow the endpoint links.


List Banking Accounts: V2 β†’ V3​

Adapter operation listBankingAccounts. Schema upgrade: AdapterBankingAccountV4 β†’ AdapterBankingAccountV5.

FieldChangeOldNewNotes
bsbRequired β†’ OptionalRequiredOptionalRemoved from required array. Accounts without a BSB (e.g., non-bank lender accounts) should omit this field. All other fields identical to V4.
Your action

Optional (recommended). Implement endpoint V3 (AdapterBankingAccountV5). See AdapterBankingAccountV4 β†’ AdapterBankingAccountV5 changes.


List Transactions: V1 β†’ V2​

Adapter operation listBankingTransactions. Schema upgrade: DioTransactionV3 β†’ DioTransactionV4.

FieldChangeOldNewNotes
instalmentPlanIdAddedβ€”string, optionalLinks the transaction to a BankingInstalmentPlanV1. Omit if the transaction is not associated with a plan.
directDepositSub-schema upgradedDioTransactionDirectDepositV1DioTransactionDirectDepositV2See direct deposit detail below.

DioTransactionDirectDepositV1 β†’ DioTransactionDirectDepositV2

FieldChangeOldNewNotes
bsbRemovedstring, pattern ^\d{6}, requiredβ€”Replaced by apcaNumber.
apcaNumberAddedβ€”string, pattern ^\d{6}$, required6-digit APCA number for the initiating institution; zero-padded. e.g., 484799.
Your action

Mandatory for Banking (FDO-26Q411). Implement endpoint V2 (DioTransactionV4) to support Get Transactions for Account V2 and Get Transaction Detail V3.


List Instalment Plans: New endpoint (V1)​

Adapter operation listBankingInstalmentPlans. New endpoint. Response schema: BankingInstalmentPlanV1.

Request

FieldRequiredTypeNotes
accountIdsYesstring[] (min 1)Account IDs to query. HaaS controls authorisation.
planStatusNoACTIVE | INACTIVE | ALL, default ACTIVEFilter by plan status.
pageNointeger, min 1, default 1CDR pagination.
pageSizeNointeger, min 1, default 25CDR pagination.

Response: BankingInstalmentPlanV1

FieldRequiredTypeNotes
accountIdYesstringAccount the plan belongs to.
planIdYesstring (CDR ID permanence)Unique plan identifier.
planReferenceYesstringPurchase/order reference. e.g., ORD-998832.
merchantNameYesstringName of merchant. e.g., ACME Retail.
merchantCategoryCodeNostringMCC for the merchant.
planNicknameYesstringShort display name.
creationDateYesdate stringDate plan was created.
amountYesAmountStringOriginal transaction amount including any upfront payment.
planCurrencyNostring (ISO 4217), default AUDCurrency of plan amount.
planChargeNoAmountStringTotal charges incorporated into scheduled amounts (e.g., BNPL fee).
planRateNoRateStringPercentage value of charges if displayed to consumer.
durationYesISO 8601 DurationRepayment period from creation. e.g., P6W.
instalmentIntervalYesISO 8601 DurationExpected repayment interval. e.g., P2W.
scheduleYesBankingInstalmentPlanScheduleV1[]Scheduled repayments.

BankingInstalmentPlanScheduleV1

FieldRequiredTypeNotes
amountDueYesAmountStringAmount due for this repayment.
dueDateYesdate stringDate this repayment is/was due.
isPaidNoboolean, default falseWhether this repayment has been paid.
Your action

Mandatory for Banking customers with instalment/BNPL products (FDO-26Q412). Customers without these products do not need to implement this endpoint. Until you advertise support via V6 Get Endpoint Meta, HaaS returns a CDR-compliant 404 Resource/NotImplemented.