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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Newcastle Permanent Building Society

Newcastle Permanent Building Society Banking Accounts API

Banking Account endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

Newcastle Permanent Building Society Banking 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 Banking Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

2 operations 2 paths 36 schemas 2 GET

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
Contact
Data Standards Body
License
MIT License
Resource Areas
1

Paths & Operations 2

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

Banking Accounts 2

Banking Account endpoints

GET
/banking/accounts
Get Accounts
listBankingAccounts 11 params → 200400406422
GET
/banking/accounts/{accountId}
Get Account Detail
getBankingAccountDetail 7 params → 200400404406

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CommonPAFAddress (22 properties), BankingLoanAccountV3 (15 properties), BankingAccountDetailV5_allOf (15 properties), BankingProductLendingRateV3 (14 properties). Each schema is shown below with its type and property counts.

ErrorV2_meta
object
Additional data for customised error codes.
1 property
BankingProductInstalments
object
Details of instalment features on the account.
6 properties 2 required
ResponseBankingAccountListV3
object
3 properties 3 required
BankingProductLendingRateV3
object
14 properties 5 required
BankingAccountDetailV5_allOf
object
15 properties
BankingFeeDiscountAmount
object
1 property 1 required
ResponseBankingAccountListV3_data
object
1 property 1 required
ResponseErrorListV2
object
1 property 1 required
BankingFeeDiscountRange
object
A minimum or maximum fee discount amount where a specific fixed amount is not known until the fee is incurred.
2 properties
CommonSimpleAddress
object
Mandatory if the addressUType value is simple.
8 properties 3 required
ResponseBankingAccountByIdV5
object
3 properties 2 required
BankingFeeAmount
object
1 property 1 required
BankingProductDepositRateV2
object
10 properties 3 required
BankingTermDepositAccount
object
5 properties 3 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.
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
BankingProductRateConditionV2
object
Defines a condition for the applicability of a rate.
4 properties 1 required
LinksPaginated
object
5 properties 1 required
BankingFeeDiscountRate
object
3 properties 2 required
BankingCreditCardAccount
object
4 properties 3 required
CommonPhysicalAddress
object
3 properties 1 required
Meta
object
BankingProductDiscountEligibility
object
4 properties 1 required
BankingProductFeatureV4
object
4 properties 1 required
BankingProductRateTierV4
object
Defines the criteria and conditions for which a rate applies.
8 properties 3 required
MetaPaginated
object
2 properties 2 required
ErrorV2
object
4 properties 3 required
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingLoanAccountV3
object
15 properties 1 required
BankingAccountV3
object
11 properties 6 required
BankingAccountDetailV5
BankingFeeRange
object
A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.
2 properties
Links
object
1 property 1 required
BankingProductFeeV2
object
13 properties 3 required
BankingProductDiscountV2
object
Note that the currency of the fee discount is expected to be the same as the currency of the fee itself.
9 properties 3 required
BankingFeeRate
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Newcastle Permanent Building Society publishes across the network.

Newcastle Permanent Building Society Accounts API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Account Balances API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Account Direct Debits API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Account Scheduled Payments API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Account Transactions API
AE Profile APIs.io
Newcastle Permanent Building Society Banking API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Payees API
AE Profile APIs.io
Newcastle Permanent Building Society Banking Products API
AE Profile APIs.io
Newcastle Permanent Building Society Common API
AE Profile APIs.io
Newcastle Permanent Building Society Customer API
AE Profile APIs.io
Newcastle Permanent Building Society Direct Debits API
AE Profile APIs.io
Newcastle Permanent Building Society Payees API
AE Profile APIs.io
#Banking Accounts
← Back to N APIs
API Details
ID
newcastle-permanent:newcastle-permanent-banking-accounts-api
Base URL
https://openbank.newcastlepermanent.com.au/cds-au/v1/banking/products
Docs
https://developer.newcastlepermanent.com.au/
Provider
Newcastle Permanent Building Society
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network