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

Westpac Banking Corporation Banking Account Direct Debits API

Banking Account Direct Debit endpoints

Westpac Banking Corporation Banking Account Direct Debits 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 Account Direct Debits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 13 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.

3 operations 2 paths 13 schemas 2 GET1 POST

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
Resource Areas
1

Paths & Operations 3

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

Banking Account Direct Debits 3

Banking Account Direct Debit endpoints

GET
/banking/accounts/{accountId}/direct-debits
Get Direct Debits For Account
listDirectDebits 9 params → 200400404406422
GET
/banking/accounts/direct-debits
Get Bulk Direct Debits
listDirectDebitsBulk 11 params → 200400406422
POST
/banking/accounts/direct-debits
Get Direct Debits For Specific Accounts
listDirectDebitsSpecificAccounts 8 params body → 200400406422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BankingAuthorisedEntity (5 properties), LinksPaginated (5 properties), BankingDirectDebit (4 properties), ErrorV2 (4 properties). Each schema is shown below with its type and property counts.

ErrorV2
object
4 properties 3 required
LinksPaginated
object
5 properties 1 required
BankingAuthorisedEntity
object
5 properties
BankingDirectDebit
object
4 properties 2 required
ErrorV2_meta
object
Additional data for customised error codes.
1 property
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
ResponseBankingDirectDebitAuthorisationList_data
object
1 property 1 required
ResponseBankingDirectDebitAuthorisationList
object
3 properties 3 required
MetaPaginated
object
2 properties 2 required
RequestAccountIdListV1
object
2 properties 1 required
ResponseErrorListV2
object
1 property 1 required
RequestAccountIdListV1_data
object
1 property 1 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

westpac-banking-account-direct-debits-api-openapi.yml Raw ↑

Other APIs Westpac Banking Corporation publishes across the network.

Westpac PayWay REST API
Westpac QuickStream REST API
Westpac Banking Corporation Banking Account Balances API
Westpac Banking Corporation Banking Account Scheduled Payments API
Westpac Banking Corporation Banking Account Transactions API
Westpac Banking Corporation Banking Accounts API
Westpac Banking Corporation Banking Payees API
Westpac Banking Corporation Banking Products API