Your browser is out of date. From Thu 28 April 2022, the Great Southern Bank website will not support your current browser, and you may have a degraded experience or be unable to connect. Update your browser to secure your online experience.

Search
Close

The Great Southern Bank Open Banking Consumer and Public APIs provide access to customer and non-customer related information.

To access the Consumer APIs, you will need to:

  • be accredited by the Australian Competition and Consumer Commission (ACCC), and
  • be provided consent by the customer.

Our APIs currently cover information about:

  • features, rates and fees for savings and transaction accounts, credit cards, term deposits and home loans;
  • availability and planned outages; and
  • customer details.

We will update the APIs progressively in line with the Consumer Data Right legislation timeframe.

Great Southern Bank APIs are designed and documented to adhere to the Australian Consumer Data Standards.

Mobile Banking

These are the APIs for Great Southern Bank’s mobile banking platform.

APIs

Public APIs

The Public APIs are available to everyone from a public cloud with no restrictions on use. They can be accessed by HTTP/GET in REST format.

Products

Get Products

https://api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/products

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 3.
Get Product Detail

https://api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/products/{productId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 4.

Status and outages

Get Status

https://api.open-banking.greatsouthernbank.com.au/cds-au/v1/discovery/status

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Outages

https://api.open-banking.greatsouthernbank.com.au/cds-au/v1/discovery/outages

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
APIs

Consumer APIs

The Consumer APIs will only be available to you if you have been accredited by the ACCC and the customer has provided their consent. They can be accessed by HTTP/GET or HTTP/POST in REST format.

Accounts

Get Accounts

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are 1 and 2.
Get Account Detail

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are 2 and 3.

Balances

Get Bulk Balances

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/balances

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Balances for Specific Accounts

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/balances

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Account Balance

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/balance

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Customer

Get Customer

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/common/customer

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Customer Detail

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/common/customer/detail

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.

Transaction

Get Transactions for Account

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/transactions

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Transaction Detail

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Direct Debits

Get Direct Debits For Account

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Bulk Direct Debits

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/direct-debits

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Direct Debits For Specific Accounts

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/direct-debits

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Scheduled Payments

Get Scheduled Payments for Account

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.
Get Scheduled Payments Bulk

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/payments/scheduled

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.
Get Scheduled Payments For Specific Accounts

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/payments/scheduled

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.

Payees

Get Payees

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/payees

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.
Get Payee Detail

https://secure.api.open-banking.greatsouthernbank.com.au/cds-au/v1/banking/payees/{payeeId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.

Business app

These are the APIs for Great Southern Bank’s Business app platform.

APIs

Public APIs

The Public APIs are available to everyone from a public cloud with no restrictions on use. They can be accessed by HTTP/GET in REST format.

Products

Get Products

https://api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/products

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 3.
Get Product Detail

https://api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/products/{productId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer
  • Our supported version of this end point is 4.

Status and outages

Get Status

https://api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/discovery/status

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer
  • Our supported version of this end point is 1.
Get Outages

https://api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/discovery/outages

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer
  • Our supported version of this end point is 1.
APIs

Consumer APIs

The Consumer APIs will only be available to you if you have been accredited by the ACCC and the customer has provided their consent. They can be accessed by HTTP/GET or HTTP/POST in REST format.

Accounts

Get Accounts

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are 1 and 2.
Get Account Detail

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are 2 and 3.

Balances

Get Bulk Balances

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/balances

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Balances for Specific Accounts

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/balances

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Account Balance

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/balance

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Customer

Get Customer

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/common/customer

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Customer Detail

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/common/customer/detail

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.

Transaction

Get Transactions for Account

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/transactions

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Transaction Detail

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/transactions/{transactionId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Direct Debits

Get Direct Debits For Account

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/direct-debits

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Bulk Direct Debits

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/direct-debits

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.
Get Direct Debits For Specific Accounts

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/direct-debits

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 1.

Scheduled Payments

Get Scheduled Payments for Account

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.
Get Scheduled Payments Bulk

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/payments/scheduled

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.
Get Scheduled Payments For Specific Accounts

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/payments/scheduled

  • HTTP/POST
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point are v1 and v2.

Payees

Get Payees

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/payees

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.
Get Payee Detail

https://secure.api.open-banking.business.greatsouthernbank.com.au/cds-au/v1/banking/payees/{payeeId}

  • HTTP/GET
  • All API requests require a mandatory header parameter “x-v” and the value must be set to a positive integer.
  • Our supported version of this end point is 2.