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.
| Field | Change | Old | New | Notes |
|---|---|---|---|---|
bsb | Required β Optional | Required | Optional | Removed from required array. Accounts without a BSB (e.g., non-bank lender accounts) should omit this field. All other fields identical to V4. |
Optional (recommended). Implement endpoint V3 (AdapterBankingAccountV5).
See AdapterBankingAccountV4 β AdapterBankingAccountV5 changes.
List Transactions: V1 β V2β
Adapter operation listBankingTransactions.
Schema upgrade: DioTransactionV3 β DioTransactionV4.
| Field | Change | Old | New | Notes |
|---|---|---|---|---|
instalmentPlanId | Added | β | string, optional | Links the transaction to a BankingInstalmentPlanV1. Omit if the transaction is not associated with a plan. |
directDeposit | Sub-schema upgraded | DioTransactionDirectDepositV1 | DioTransactionDirectDepositV2 | See direct deposit detail below. |
DioTransactionDirectDepositV1 β DioTransactionDirectDepositV2
| Field | Change | Old | New | Notes |
|---|---|---|---|---|
bsb | Removed | string, pattern ^\d{6}, required | β | Replaced by apcaNumber. |
apcaNumber | Added | β | string, pattern ^\d{6}$, required | 6-digit APCA number for the initiating institution; zero-padded. e.g., 484799. |
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
| Field | Required | Type | Notes |
|---|---|---|---|
accountIds | Yes | string[] (min 1) | Account IDs to query. HaaS controls authorisation. |
planStatus | No | ACTIVE | INACTIVE | ALL, default ACTIVE | Filter by plan status. |
page | No | integer, min 1, default 1 | CDR pagination. |
pageSize | No | integer, min 1, default 25 | CDR pagination. |
Response: BankingInstalmentPlanV1
| Field | Required | Type | Notes |
|---|---|---|---|
accountId | Yes | string | Account the plan belongs to. |
planId | Yes | string (CDR ID permanence) | Unique plan identifier. |
planReference | Yes | string | Purchase/order reference. e.g., ORD-998832. |
merchantName | Yes | string | Name of merchant. e.g., ACME Retail. |
merchantCategoryCode | No | string | MCC for the merchant. |
planNickname | Yes | string | Short display name. |
creationDate | Yes | date string | Date plan was created. |
amount | Yes | AmountString | Original transaction amount including any upfront payment. |
planCurrency | No | string (ISO 4217), default AUD | Currency of plan amount. |
planCharge | No | AmountString | Total charges incorporated into scheduled amounts (e.g., BNPL fee). |
planRate | No | RateString | Percentage value of charges if displayed to consumer. |
duration | Yes | ISO 8601 Duration | Repayment period from creation. e.g., P6W. |
instalmentInterval | Yes | ISO 8601 Duration | Expected repayment interval. e.g., P2W. |
schedule | Yes | BankingInstalmentPlanScheduleV1[] | Scheduled repayments. |
BankingInstalmentPlanScheduleV1
| Field | Required | Type | Notes |
|---|---|---|---|
amountDue | Yes | AmountString | Amount due for this repayment. |
dueDate | Yes | date string | Date this repayment is/was due. |
isPaid | No | boolean, default false | Whether this repayment has been paid. |
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.