Australian Consumer Data Standards

CDR Banking API

Specifications for resource endpoints applicable to data holders in the Banking sector.

Government & public#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Specifications for resource endpoints applicable to data holders in the Banking sector.

Endpoints 19

Banking Products

  • GETGet Productshttps://tls.dh.example.com/cds-au/v1/banking/productsObtain a list of products that are currently openly offered to the market. Note that the results returned by this endpoint are expected to be ordered in…
  • GETGet Product Detailhttps://tls.dh.example.com/cds-au/v1/banking/products/:productIdObtain detailed information on a single product offered openly to the market. Obsolete versions: v1, v2, v3, v4, v5, v6.

Banking Accounts

  • GETGet Accounts/banking/accountsObtain a list of accounts. Obsolete versions: v1, v2.
  • GETGet Account Detail/banking/accounts/:accountIdObtain detailed information on a single account. Obsolete versions: v1, v2, v3, v4.

Banking Account Balances

  • GETGet Bulk Balances/banking/accounts/balancesObtain balances for multiple, filtered accounts. Obsolete versions: v1.
  • POSTGet Balances For Specific Accounts/banking/accounts/balancesObtain balances for a specified list of accounts.
  • GETGet Account Balance/banking/accounts/:accountId/balanceObtain the balance for a single specified account.

Banking Account Transactions

  • GETGet Transactions For Account/banking/accounts/:accountId/transactionsObtain transactions for a specific account. Some general notes that apply to all endpoints that retrieve transactions:<ul><li>Where multiple transactions are…
  • GETGet Transaction Detail/banking/accounts/:accountId/transactions/:transactionIdObtain detailed information on a transaction for a specific account. Obsolete versions: v1, v2.

Banking Account Direct Debits

  • GETGet Direct Debits For Account/banking/accounts/:accountId/direct-debitsObtain direct debit authorisations for a specific account.
  • GETGet Bulk Direct Debits/banking/accounts/direct-debitsObtain direct debit authorisations for multiple, filtered accounts. Obsolete versions: v1.
  • POSTGet Direct Debits For Specific Accounts/banking/accounts/direct-debitsObtain direct debit authorisations for a specified list of accounts.

Banking Account Scheduled Payments

  • GETGet Scheduled Payments for Account/banking/accounts/:accountId/payments/scheduledObtain scheduled, outgoing payments for a specific account. Obsolete versions: v1.
  • GETGet Scheduled Payments Bulk/banking/payments/scheduledObtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments. Obsolete versions: v1, v2.
  • POSTGet Scheduled Payments For Specific Accounts/banking/payments/scheduledObtain scheduled payments for a specified list of accounts. Obsolete versions: v1.
  • GETGet Instalment Plans for Account/banking/accounts/:accountId/payments/plansObtain instalment plans for a single specified account. The response MUST be ordered by plan _creationDate_ in descending order. If…
  • GETGet Instalment Plans Bulk/banking/accounts/payments/plansObtain instalment plans for multiple accounts. The response MUST be ordered by plan _creationDate_ in descending order. If instalments are not supported for…

Banking Payees

  • GETGet Payees/banking/payeesObtain a list of pre-registered payees. Obsolete versions: v1.
  • GETGet Payee Detail/banking/payees/:payeeIdObtain detailed information on a single payee. Note that the payee sub-structure should be selected to represent the payment destination only rather than any…

API details

Base URL
https://mtls.dh.example.com/cds-au/v1
Authentication
None declared in the description
Operations
19 operations on 16 pathsGET 16POST 3
Main resources
Banking Account Scheduled Payments 5Banking Account Balances 3Banking Account Direct Debits 3Banking Account Transactions 2Banking Accounts 2Banking Payees 2Banking Products 2
Description format
OpenAPI 3.0.3, API version 1.36.0

How to test the CDR Banking API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CDR Banking API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Products” (GET https://tls.dh.example.com/cds-au/v1/banking/products), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CDR Banking API?

Specifications for resource endpoints applicable to data holders in the Banking sector. It is listed under Government & public and has 19 endpoints.

Who publishes the CDR Banking API?

It is listed from Australian Consumer Data Standards's public API description (an OpenAPI document), not published by Australian Consumer Data Standards on Swastik Codes. Anyone who controls consumerdatastandards.gov.au can claim the profile by adding a DNS TXT record.

What is the base URL of the CDR Banking API?

Requests go to https://mtls.dh.example.com/cds-au/v1. Endpoint paths are added to this base URL.

How do I authenticate with the CDR Banking API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the CDR Banking API have?

19 operations on 16 paths (16 GET, 3 POST). The largest groups are Banking Account Scheduled Payments, Banking Account Balances, Banking Account Direct Debits, Banking Account Transactions.

Is forking the CDR Banking API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.