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 Payees API

Banking Payee endpoints

Westpac Banking Corporation Banking Payees 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 Payees. 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 23 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 23 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
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 Payees 2

Banking Payee endpoints

GET
/banking/payees
Get Payees
listBankingPayees 9 params → 200400406422
GET
/banking/payees/{payeeId}
Get Payee Detail
getBankingPayeeDetail 7 params → 200400404406422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are BankingInternationalPayee_bankDetails (9 properties), LinksPaginated (5 properties), BankingPayeeV2 (5 properties), BankingPayeeDetailV2_allOf (5 properties). Each schema is shown below with its type and property counts.

BankingDomesticPayeeAccount
object
3 properties 2 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
BankingInternationalPayee
object
2 properties 2 required
BankingPayeeDetailV2_allOf
object
5 properties 1 required
BankingPayeeDetailV2
ErrorV2_meta
object
Additional data for customised error codes.
1 property
ResponseBankingPayeeByIdV2
object
3 properties 2 required
BankingBillerPayee
object
3 properties 2 required
MetaPaginated
object
2 properties 2 required
Links
object
1 property 1 required
BankingPayeeV2
object
5 properties 3 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
ResponseErrorListV2
object
1 property 1 required
ErrorV2
object
4 properties 3 required
BankingDigitalWalletPayee
object
4 properties 4 required
BankingDomesticPayeeCard
object
1 property 1 required
ResponseBankingPayeeListV2
object
3 properties 3 required
BankingDomesticPayeePayId
object
3 properties 2 required
ResponseBankingPayeeListV2_data
object
1 property 1 required
LinksPaginated
object
5 properties 1 required
BankingDomesticPayee
object
4 properties 1 required
BankingPayeeId
string
A unique identifier for a Banking payee, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

westpac-banking-payees-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 Direct Debits 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 Products API