How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newcastle Permanent Building Society Banking API

The Banking API from Newcastle Permanent Building Society — 14 operation(s) for banking.

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

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

This API exposes 15 operations across 12 paths, and defines 70 schemas. It is described by OpenAPI 3.2.0, at version 1.36.0.

Requests are made against a single base URL, https://openbank-secure.newcastlepermanent.com.au/cds-au/v1.

15 operations 12 paths 70 schemas 12 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.36.0
Base URL
https://openbank.newcastlepermanent.com.au/cds-au/v1/banking/products
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Newcastle Permanent Building Society Banking API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 8 scopes. It supports OAuth 2.0 (default) using the authorizationCode flow, exposing 8 scopes.

  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 15

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

Banking 15
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
GET
/banking/accounts/{accountId}/direct-debits
Get Direct Debits For Account
listDirectDebits 9 params → 200400404406422
GET
/banking/accounts/direct-debits
Get Bulk Direct Debits
listDirectDebitsBulk 11 params → 200400406422
POST
/banking/accounts/direct-debits
Get Direct Debits For Specific Accounts
listDirectDebitsSpecificAccounts 8 params body → 200400406422
GET
/banking/accounts/{accountId}/payments/scheduled
Get Scheduled Payments for Account
listScheduledPayments 9 params → 200400404406422
GET
/banking/payments/scheduled
Get Scheduled Payments Bulk
listScheduledPaymentsBulk 11 params → 200400406422
POST
/banking/payments/scheduled
Get Scheduled Payments For Specific Accounts
listScheduledPaymentsSpecificAccounts 8 params body → 200400406422
GET
/banking/payees
Get Payees
listPayees 9 params → 200400406422
GET
/banking/payees/{payeeId}
Get Payee Detail
getPayeeDetail 7 params → 200400404406422

Schemas 70

The contract defines 70 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.

ResponseBankingAccountsBalanceById
object
3 properties 2 required
ResponseBankingAccountsBalanceList_data
object
1 property 1 required
BankingBalancePurse
object
2 properties 1 required
BankingBillerPayee
object
3 properties 2 required
BankingProductDepositRate
object
10 properties 2 required
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required
BankingScheduledPaymentSet
object
The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one dest…
4 properties 1 required
ResponseBankingScheduledPaymentsList
object
3 properties 3 required
Meta
object
BankingScheduledPaymentRecurrenceIntervalSchedule
object
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
4 properties 1 required
BankingScheduledPaymentRecurrenceOnceOff
object
Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
1 property 1 required
ResponseBankingScheduledPaymentsList_data
object
1 property 1 required
BankingScheduledPaymentFrom
object
Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and…
1 property 1 required
BankingAccount
object
10 properties 6 required
RequestAccountIds
object
2 properties 1 required
ResponseBankingDirectDebitAuthorisationList_data
object
1 property 1 required
ResponseBankingAccountList
object
3 properties 3 required
BankingProductFee
object
13 properties 2 required
ResponseBankingTransactionById
object
3 properties 2 required
BankingCreditCardAccount
object
4 properties 3 required
ResponseErrorList_errors
object
4 properties 3 required
BankingAccountDetail
BankingScheduledPayment
object
8 properties 7 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
BankingTransactionDetailV2
BankingTransactionDetail
BankingDomesticPayeeCard
object
1 property 1 required
ResponseBankingTransactionList
object
3 properties 3 required
BankingTransactionDetail_extendedData_nppPayload
object
5 properties 3 required
BankingAuthorisedEntity
object
5 properties
ResponseBankingPayeeById
object
3 properties 2 required
CommonPhysicalAddress
object
3 properties 1 required
BankingPayee
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
BankingScheduledPaymentRecurrenceEventBased
object
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBas…
1 property 1 required
BankingDomesticPayeePayId
object
3 properties 2 required
BankingDomesticPayee
object
4 properties 1 required
BankingTermDepositAccount
object
5 properties 3 required
ResponseBankingTransactionList_data
object
1 property 1 required
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment
6 properties 1 required
BankingBalance
object
7 properties 3 required
BankingProductLendingRate
object
14 properties 2 required
BankingTransactionDetail_extendedData_x2p101Payload
object
3 properties 1 required
ResponseBankingAccountList_data
object
1 property 1 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
BankingLoanAccount
object
15 properties 3 required
ResponseBankingPayeeList
object
3 properties 3 required
ResponseBankingAccountById
object
3 properties 2 required
LinksPaginated
object
5 properties 1 required
BankingTransactionDetail_extendedData
object
5 properties 1 required
BankingPayeeDetail
BankingScheduledPaymentTo
object
Object containing details of the destination of the payment. Used to specify a variety of payment destination types
6 properties 1 required
BankingInternationalPayee
object
2 properties 2 required
ResponseBankingPayeeList_data
object
1 property 1 required
BankingTransaction
object
18 properties 7 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
ResponseErrorList
object
1 property 1 required
BankingDirectDebit
object
4 properties 2 required
ResponseBankingDirectDebitAuthorisationList
object
3 properties 3 required
Links
object
1 property 1 required
CommonSimpleAddress
object
8 properties 3 required
MetaPaginated
object
2 properties 2 required
BankingScheduledPaymentRecurrenceLastWeekday
object
Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set t…
5 properties 2 required
BankingProductFeature
object
4 properties 1 required
ResponseBankingTransactionByIdV2
object
3 properties 2 required
BankingDomesticPayeeAccount
object
3 properties 2 required
ResponseBankingAccountsBalanceList
object
3 properties 3 required
RequestAccountIds_data
object
1 property 1 required
BankingScheduledPaymentInterval
object
2 properties 1 required
BankingTransactionDetail_extendedDataV2
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-banking-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 Payees API
Newcastle Permanent Building Society Banking Products API
Newcastle Permanent Building Society Common API
Where this information came from

This is an independent, third-party profile of Newcastle Permanent Building Society Banking API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.