Skip to main content

Balances API

View the balance information of statement accounts. Use this API to list accounts or dates with available balance information, and get balance information for a specific account and date.

List accounts

Request

GET /balances/accounts
Request body

None.

Response

This is a paginated resource. The list is sorted by account number.

Field Format Data
links Array of Links Links to related resources and documentation.
data Array of Account Model A paginated list of balance accounts.
HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.

List account balance dates

Request

GET /balances/accounts/{account}
Path parameters
Parameter Name Format Description
account string The full account number identifying the account.
Request body

None.

Response

This is a paginated resource. The list is sorted by date descending.

Field Format Data
links Array of Links Links to related resources and documentation.
data Array of Date Model A paginated list of balance account date models.
HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
404 NOT FOUND The account path parameter may be incorrect.

Get account balance

Request

GET /balances/accounts/{account}/{date}
Path parameters
Parameter Name Format Description
account string The full account number identifying the account.
date date The date of the balance information.
Request body

None.

Response

If successful, this method returns the following in the response body.

Field Format Data
links Array of Links Links to related resources and documentation.
date date The date of the balance information.
closingBalance decimal Monetary amount to two decimal places.
availableBalance decimal Monetary amount to two decimal places.

Example account balance response

{
  "links": [],
  "date": "2026-08-17",
  "closingBalance": "2077.00",
  "availableBalance": "2077.00"
}
HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
404 NOT FOUND The account path parameter may be incorrect.

Account model

Field Format Description
account string The full account number identifying the account.

Example balance account response

{
  "links": [
    {
      "rel": "balances",
      "method": "GET",
      "href": ".../rest/v1/balances/accounts/032000000007"
    }
  ],
  "account": "032000000007"
}

Date model

Field Format Description
links Array of Links Links to related resources and documentation.
date date The date of the account balance.

Example account balance date response

{
  "links": [
    {
      "rel": "balance",
      "method": "GET",
      "href": ".../rest/v1/balances/accounts/032000000007/2026-08-17"
    }
  ],
  "date": "2026-07-29"
}
Privacy Statement

Privacy Statement (for individuals whose personal information may be collected - in this clause referred to as "you"). All personal information we collect about you is collected, used and disclosed by us in accordance with our Privacy Statement which is available at Privacy Statement or by calling us through your relationship manager or Westpac representative. Our Privacy Statement also provides information about how you can access and correct your personal information and make a complaint. You do not have to provide us with any personal information but, if you don't, we may not be able to process an application or a request for a product or service.