Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Westpac Banking Corporation

Westpac Banking Corporation Banking Accounts API

Banking Account endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

Westpac Banking Corporation Banking Accounts API is one of 9 APIs that Westpac Banking Corporation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Banking Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 35 schemas. It is described by OpenAPI 3.0.3, at version 1.36.0.

Requests are made against 2 base URLs: https://digital-api.westpac.com.au/cds-au/v1, https://mtls.dh.example.com/cds-au/v1.

2 operations 2 paths 35 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.36.0
Base URL
https://digital-api.westpac.com.au/cds-au/v1/banking/products
Contact
Data Standards Body
License
MIT License
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Banking Accounts 2

Banking Account endpoints

GET
/banking/accounts
Get Accounts
listBankingAccounts 11 params → 200400406422
GET
/banking/accounts/{accountId}
Get Account Detail
getBankingAccountDetail 7 params → 200400404406

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are CommonPAFAddress (22 properties), BankingLoanAccountV3 (15 properties), BankingAccountDetailV5_allOf (15 properties), BankingProductLendingRateV3 (14 properties). Each schema is shown below with its type and property counts.

BankingProductInstalments
object
Details of instalment features on the account.
6 properties 2 required
BankingProductRateConditionV2
object
Defines a condition for the applicability of a rate.
4 properties 1 required
CommonPhysicalAddress
object
3 properties 1 required
ResponseBankingAccountByIdV5
object
3 properties 2 required
BankingFeeRange
object
A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.
2 properties
ErrorV2_meta
object
Additional data for customised error codes.
1 property
MetaPaginated
object
2 properties 2 required
BankingProductFeeV2
object
13 properties 3 required
BankingProductRateTierV4
object
Defines the criteria and conditions for which a rate applies.
8 properties 3 required
Links
object
1 property 1 required
BankingProductFeatureV4
object
4 properties 1 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.
BankingProductDiscountEligibility
object
4 properties 1 required
BankingLoanAccountV3
object
15 properties 1 required
BankingProductDepositRateV2
object
10 properties 3 required
ResponseErrorListV2
object
1 property 1 required
CommonSimpleAddress
object
Mandatory if the addressUType value is simple.
8 properties 3 required
ErrorV2
object
4 properties 3 required
BankingFeeRate
object
4 properties 2 required
BankingProductDiscountV2
object
Note that the currency of the fee discount is expected to be the same as the currency of the fee itself.
9 properties 3 required
BankingTermDepositAccount
object
5 properties 3 required
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
ResponseBankingAccountListV3_data
object
1 property 1 required
BankingFeeDiscountRange
object
A minimum or maximum fee discount amount where a specific fixed amount is not known until the fee is incurred.
2 properties
ResponseBankingAccountListV3
object
3 properties 3 required
CommonPAFAddress
object
Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspostcorp/media/documents/austr…
22 properties 3 required
BankingAccountV3
object
11 properties 6 required
BankingAccountDetailV5_allOf
object
15 properties
BankingProductLendingRateV3
object
14 properties 5 required
LinksPaginated
object
5 properties 1 required
BankingCreditCardAccount
object
4 properties 3 required
BankingFeeDiscountRate
object
3 properties 2 required
BankingFeeAmount
object
1 property 1 required
BankingAccountDetailV5
BankingFeeDiscountAmount
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

westpac-banking-accounts-api-openapi.yml Raw ↑

Other APIs Westpac Banking Corporation publishes across the network.

Westpac PayWay REST API
AE Profile APIs.io
Westpac QuickStream REST API
AE Profile APIs.io
Westpac Banking Corporation Banking Account Balances API
AE Profile APIs.io
Westpac Banking Corporation Banking Account Direct Debits API
AE Profile APIs.io
Westpac Banking Corporation Banking Account Scheduled Payments API
AE Profile APIs.io
Westpac Banking Corporation Banking Account Transactions API
AE Profile APIs.io
Westpac Banking Corporation Banking Payees API
AE Profile APIs.io
Westpac Banking Corporation Banking Products API
AE Profile APIs.io
#Banking Accounts
← Back to W APIs
API Details
ID
westpac:westpac-banking-accounts-api
Base URL
https://digital-api.westpac.com.au/cds-au/v1/banking/products
Docs
https://www.westpac.com.au/about-westpac/innovation/open-banking/product-api/
Provider
Westpac Banking Corporation
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network