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

Newcastle Permanent Building Society Accounts API

The Accounts API from Newcastle Permanent Building Society — 6 operation(s) for accounts.

Newcastle Permanent Building Society Accounts API is one of 14 APIs that Newcastle Permanent Building Society publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 6 paths, and defines 40 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.

7 operations 6 paths 40 schemas 6 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://openbank.newcastlepermanent.com.au/cds-au/v1/banking/products
Resource Areas
1

Paths & Operations 7

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

Accounts 7
GET
/banking/accounts
Get Accounts
listAccounts 11 params → 200400406422
GET
/banking/accounts/balances
Get Bulk Balances
listBalancesBulk 11 params → 200400406422
POST
/banking/accounts/balances
Get Balances For Specific Accounts
listBalancesSpecificAccounts 8 params body → 200400406422
GET
/banking/accounts/{accountId}/balance
Get Account Balance
getBalance 7 params → 200400404406
GET
/banking/accounts/{accountId}
Get Account Detail
getAccountDetail 7 params → 200400404406
GET
/banking/accounts/{accountId}/transactions
Get Transactions For Account
getTransactions 14 params → 200400404406422
GET
/banking/accounts/{accountId}/transactions/{transactionId}
Get Transaction Detail
getTransactionDetail 8 params → 200400404406

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CommonPAFAddress (22 properties), BankingTransaction (18 properties), BankingLoanAccount (15 properties), BankingProductLendingRate (14 properties). Each schema is shown below with its type and property counts.

BankingTransactionDetail_extendedData_nppPayload
object
5 properties 3 required
BankingProductCategory
string
The category to which a product or account belongs. See [here](https://consumerdatastandardsaustralia.github.io/standards/product-categories) for more details
ResponseErrorList
object
1 property 1 required
BankingTransactionDetail_extendedDataV2
object
4 properties
BankingProductFeature
object
4 properties 1 required
ResponseBankingTransactionList
object
3 properties 3 required
BankingTransactionDetail
CommonSimpleAddress
object
8 properties 3 required
BankingProductDepositRate
object
10 properties 2 required
ResponseBankingAccountById
object
3 properties 2 required
ResponseBankingAccountsBalanceList
object
3 properties 3 required
BankingTermDepositAccount
object
5 properties 3 required
CommonPAFAddress
object
Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspostcorp/media/documents/austr…
22 properties 3 required
BankingTransactionDetail_extendedData_x2p101Payload
object
3 properties 1 required
LinksPaginated
object
5 properties 1 required
BankingProductFee
object
13 properties 2 required
BankingCreditCardAccount
object
4 properties 3 required
ResponseBankingTransactionByIdV2
object
3 properties 2 required
BankingBalance
object
7 properties 3 required
RequestAccountIds
object
2 properties 1 required
CommonPhysicalAddress
object
3 properties 1 required
Meta
object
ResponseBankingAccountsBalanceList_data
object
1 property 1 required
ResponseBankingAccountsBalanceById
object
3 properties 2 required
BankingTransactionDetailV2
ResponseBankingAccountList_data
object
1 property 1 required
MetaPaginated
object
2 properties 2 required
ResponseErrorList_errors
object
4 properties 3 required
BankingTransaction
object
18 properties 7 required
BankingProductLendingRate
object
14 properties 2 required
ResponseBankingTransactionList_data
object
1 property 1 required
BankingBalancePurse
object
2 properties 1 required
BankingAccountDetail
RequestAccountIds_data
object
1 property 1 required
BankingAccount
object
10 properties 6 required
ResponseBankingTransactionById
object
3 properties 2 required
ResponseBankingAccountList
object
3 properties 3 required
BankingTransactionDetail_extendedData
object
5 properties 1 required
Links
object
1 property 1 required
BankingLoanAccount
object
15 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-accounts-api-openapi.yml Raw ↑

Other APIs Newcastle Permanent Building Society publishes across the network.

Newcastle Permanent Building Society Banking Account Balances API
Newcastle Permanent Building Society Banking Account Direct Debits API
Newcastle Permanent Building Society Banking Account Scheduled Payments API
Newcastle Permanent Building Society Banking Account Transactions API
Newcastle Permanent Building Society Banking Accounts API
Newcastle Permanent Building Society Banking API
Newcastle Permanent Building Society Banking Payees API
Newcastle Permanent Building Society Banking Products API
Newcastle Permanent Building Society Common API
Newcastle Permanent Building Society Customer API
Newcastle Permanent Building Society Direct Debits API
Newcastle Permanent Building Society Payees API