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

HSBC Bank Australia Banking Account Balances API

Banking Account Balance endpoints

HSBC Bank Australia Banking Account Balances API is one of 8 APIs that HSBC Bank Australia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 1.36.0.

Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.

3 operations 2 paths 16 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.36.0
Base URL
https://public.ob.hsbc.com.au/cds-au/v1/banking/products
Resource Areas
1

Paths & Operations 3

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

Banking Account Balances 3

Banking Account Balance endpoints

GET
/banking/accounts/balances
Get Bulk Balances
listBankingBalancesBulk 11 params → 200400406422
POST
/banking/accounts/balances
Get Balances For Specific Accounts
listBankingBalancesSpecificAccounts 8 params body → 200400406422
GET
/banking/accounts/{accountId}/balance
Get Account Balance
getBankingBalance 7 params → 200400404406

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BankingBalance (7 properties), LinksPaginated (5 properties), ErrorV2 (4 properties), ResponseBankingAccountsBalanceById (3 properties). Each schema is shown below with its type and property counts.

Meta
object
ErrorV2_meta
object
Additional data for customised error codes.
1 property
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
LinksPaginated
object
5 properties 1 required
ErrorV2
object
4 properties 3 required
BankingBalance
object
7 properties 3 required
RequestAccountIdListV1_data
object
1 property 1 required
Links
object
1 property 1 required
ResponseErrorListV2
object
1 property 1 required
MetaPaginated
object
2 properties 2 required
BankingBalancePurse
object
2 properties 1 required
ResponseBankingAccountsBalanceList
object
3 properties 3 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.
ResponseBankingAccountsBalanceList_data
object
1 property 1 required
ResponseBankingAccountsBalanceById
object
3 properties 2 required
RequestAccountIdListV1
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hsbc-australia-banking-account-balances-api-openapi.yml Raw ↑

Other APIs HSBC Bank Australia publishes across the network.

HSBC Developer Portal - Commercial APIs (HSBC Group, partner-gated)
HSBC Bank Australia Banking Account Direct Debits API
HSBC Bank Australia Banking Account Scheduled Payments API
HSBC Bank Australia Banking Account Transactions API
HSBC Bank Australia Banking Accounts API
HSBC Bank Australia Banking Payees API
HSBC Bank Australia Banking Products API