How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Commonwealth Bank Regular Payments API API

Obtain the Regular Payment details authorised to be shared by the customer. Regular Payments API is a consumer API. To access data you'll need the customer's consent.Host URLCommBank requests are passed to the URL https://secure.api.commbank.com.au/api/cds-au/v1/bankingCBA – CommBiz requests are passed to the URL https://secure.cdr.commbiz.api.commbank.com.au/cbzapi/cds-au/v1/banking

Commonwealth Bank Regular Payments API API is one of 25 APIs that Commonwealth Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://secure.api.commbank.com.au/api/cds-au/v1/banking.

6 operations 4 paths 38 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.commbank.com.au/public/cds-au/v1/banking/products
Resource Areas
1

Paths & Operations 6

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

Regular Payments API 6

Obtain the Regular Payment details authorised to be shared by the customer. Regular Payments API is a consumer API. To access data you'll need the customer's consent. Host URL Com…

GET
/accounts/{accountId}/direct-debits
Get Direct Debits For Account
listDirectDebits 9 params → 200400406422429500
GET
/accounts/direct-debits
Get Bulk Direct Debits
listDirectDebitsBulk 11 params → 200400406422429500
POST
/accounts/direct-debits
Get Direct Debits For Specific Accounts
listDirectDebitsSpecificAccounts 8 params body → 200400406422429500
GET
/accounts/{accountId}/payments/scheduled
Get Scheduled Payments for Account
listScheduledPayments 9 params → 200400406422429500
GET
/payments/scheduled
Get Scheduled Payments Bulk
listScheduledPaymentsBulk 11 params → 200400406422429500
POST
/payments/scheduled
Get Scheduled Payments For Specific Accounts
listScheduledPaymentsSpecificAccounts 8 params body → 200400406422429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are BankingInternationalPayee_bankDetails (9 properties), BankingScheduledPayment (8 properties), BankingScheduledPaymentTo (6 properties), BankingScheduledPaymentRecurrence (6 properties). Each schema is shown below with its type and property counts.

Meta
object
BankingScheduledPaymentRecurrenceEventBased
object
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined.
1 property 1 required
BankingInternationalPayee
object
2 properties 2 required
BankingAuthorisedEntity
object
5 properties
ResponseBankingScheduledPaymentsBulkList
object
3 properties 3 required
BankingDomesticPayeePayId
object
3 properties 2 required
LinksPaginated
object
5 properties 1 required
BankingScheduledPaymentInterval
object
2 properties 1 required
ResponseBankingScheduledPaymentsList_data
object
1 property 1 required
BankingDomesticPayee
object
4 properties 1 required
BankingDirectDebit
object
4 properties 2 required
BankingScheduledPayment
object
8 properties 7 required
ResponseBankingDirectDebitAuthorisationList_data
object
1 property 1 required
BankingScheduledPaymentRecurrenceIntervalSchedule
object
Indicates that the schedule of payments is defined by a series of intervals.
4 properties 1 required
BankingScheduledPaymentRecurrenceOnceOff
object
Indicates that the payment is a once off payment on a specific future date.
1 property 1 required
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
BankingDomesticPayeeAccount
object
3 properties 2 required
RequestAccountIds_data
object
1 property 1 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
ErrorResponse422
object
1 property
BankingScheduledPaymentTo
object
Object containing details of the destination of the payment.
6 properties 1 required
BankingBillerPayee
object
3 properties 2 required
ErrorResponse400
object
1 property
RequestAccountIds
object
2 properties 1 required
BankingScheduledPaymentSet
object
The set of payment amounts and destination accounts for this payment accommodating multi-part payments.
4 properties 1 required
MetaPaginated
object
2 properties 2 required
BankingScheduledPaymentRecurrenceLastWeekday
object
Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval.
5 properties 2 required
ResponseBankingScheduledPaymentsList
object
3 properties 3 required
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment
6 properties 1 required
BankingDomesticPayeeCard
object
1 property 1 required
ResponseBankingDirectDebitAuthorisationBulkList
object
3 properties 3 required
ErrorResponse500
object
1 property
Error
object
3 properties
BankingScheduledPaymentFrom
object
Object containing details of the source of the payment.
1 property 1 required
ResponseNoBody
object
ResponseBankingDirectDebitAuthorisationList
object
3 properties 3 required
ErrorResponse406
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

commonwealth-bank-regular-payments-api-api-openapi.yml Raw ↑

Other APIs Commonwealth Bank publishes across the network.

Commonwealth Bank Fast Payment (Credit Transfer Initiation) API
Commonwealth Bank NameCheck API
Commonwealth Bank PayTo API
CommBank Payment Gateway API
CommBank API Banking for Business
CommBank International Payments
CommBank Merchant Payments
CommBank Mobile App
CommBank Yello
Commonwealth Bank Accounts API API
Where this information came from

This is an independent, third-party profile of Commonwealth Bank Regular Payments API API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.