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 14 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 17 operations across 14 paths, and defines 85 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.
17 operations
14 paths
85 schemas
14 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 17
Across 14 paths, the API surfaces 17 operations — 14 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Banking 17
GET
/banking/accounts
Get Accounts
GET
/banking/accounts/balances
Get Bulk Balances
POST
/banking/accounts/balances
Get Balances For Specific Accounts
GET
/banking/accounts/{accountId}/balance
Get Account Balance
GET
/banking/accounts/{accountId}
Get Account Detail
GET
/banking/accounts/{accountId}/transactions
Get Transactions For Account
GET
/banking/accounts/{accountId}/transactions/{transactionId}
Get Transaction Detail
GET
/banking/accounts/{accountId}/direct-debits
Get Direct Debits For Account
GET
/banking/accounts/direct-debits
Get Bulk Direct Debits
POST
/banking/accounts/direct-debits
Get Direct Debits For Specific Accounts
GET
/banking/accounts/{accountId}/payments/scheduled
Get Scheduled Payments for Account
GET
/banking/payments/scheduled
Get Scheduled Payments Bulk
POST
/banking/payments/scheduled
Get Scheduled Payments For Specific Accounts
GET
/banking/payees
Get Payees
GET
/banking/payees/{payeeId}
Get Payee Detail
GET
/banking/products
Get Products
GET
/banking/products/{productId}
Get Product Detail
Schemas 85
The contract defines 85 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.
ResponseErrorList
object
1 property
1 required
ResponseBankingPayeeById
object
3 properties
2 required
BankingDomesticPayeeCard
object
1 property
1 required
ResponseBankingTransactionList
object
3 properties
3 required
BankingTransactionDetail
ResponseBankingAccountById
object
3 properties
2 required
BankingTransactionDetail_extendedData_x2p101Payload
object
3 properties
1 required
ResponseBankingProductList
object
3 properties
3 required
ResponseBankingProductById
object
3 properties
2 required
BankingBalance
object
7 properties
3 required
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
RequestAccountIds
object
2 properties
1 required
Meta
object
ResponseBankingAccountsBalanceList_data
object
1 property
1 required
BankingScheduledPaymentInterval
object
2 properties
1 required
BankingDomesticPayeeAccount
object
3 properties
2 required
ResponseBankingAccountList_data
object
1 property
1 required
ResponseErrorList_errors
object
4 properties
3 required
BankingBillerPayee
object
3 properties
2 required
BankingDomesticPayee
object
4 properties
1 required
BankingBalancePurse
object
2 properties
1 required
ResponseBankingDirectDebitAuthorisationList
object
3 properties
3 required
Links
object
1 property
1 required
BankingLoanAccount
object
15 properties
3 required
BankingTransactionDetail_extendedData_nppPayload
object
5 properties
3 required
BankingProductV3
object
14 properties
7 required
BankingProductDetailV3
BankingProductFee_2
object
13 properties
2 required
BankingProductCategory
string
The category to which a product or account belongs. See [here](https://consumerdatastandardsaustralia.github.io/standards/product-categories) for more details
BankingProductConstraintV2
object
4 properties
1 required
BankingProductCategory_2
string
The category to which a product or account belongs. See [here](https://urldefense.com/v3/https://consumerdatastandardsaustralia.github.io/standards/product-cat…
BankingProductFeature
object
4 properties
1 required
BankingInternationalPayee_bankDetails
object
9 properties
2 required
ResponseBankingScheduledPaymentsList_data
object
1 property
1 required
CommonSimpleAddress
object
8 properties
3 required
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
LinksPaginated
object
5 properties
1 required
BankingProductLendingRate_2
object
14 properties
2 required
ResponseBankingTransactionByIdV2
object
3 properties
2 required
CommonPhysicalAddress
object
3 properties
1 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
BankingScheduledPayment
object
8 properties
7 required
ResponseBankingScheduledPaymentsList
object
3 properties
3 required
BankingProductEligibility
object
4 properties
1 required
BankingDomesticPayeePayId
object
3 properties
2 required
BankingProductBundle
object
5 properties
2 required
ResponseBankingTransactionById
object
3 properties
2 required
BankingProductDepositRate_2
object
10 properties
2 required
BankingProductConstraint
object
4 properties
1 required
BankingPayee
object
5 properties
3 required
BankingTransactionDetail_extendedDataV2
object
4 properties
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties
2 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
BankingProductDepositRate
object
10 properties
2 required
ResponseBankingAccountsBalanceList
object
3 properties
3 required
BankingPayeeDetail
BankingProductFee
object
13 properties
2 required
BankingCreditCardAccount
object
4 properties
3 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
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
BankingTransactionDetailV2
MetaPaginated
object
2 properties
2 required
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment
6 properties
1 required
BankingTransaction
object
18 properties
7 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties
1 required
ResponseBankingPayeeList_data
object
1 property
1 required
ResponseBankingPayeeList
object
3 properties
3 required
BankingAccountDetail
BankingAccount
object
10 properties
6 required
BankingTransactionDetail_extendedData
object
5 properties
1 required
BankingInternationalPayee
object
2 properties
2 required
MetaPaginated_2
object
2 properties
2 required
ResponseBankingDirectDebitAuthorisationList_data
object
1 property
1 required
BankingAuthorisedEntity
object
5 properties
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
BankingProductRateTierV3
object
Defines the criteria and conditions for which a rate applies
8 properties
3 required
ResponseBankingAccountsBalanceById
object
3 properties
2 required
BankingDirectDebit
object
4 properties
2 required
BankingProductLendingRate
object
14 properties
2 required
ResponseBankingTransactionList_data
object
1 property
1 required
RequestAccountIds_data
object
1 property
1 required
ResponseBankingAccountList
object
3 properties
3 required
BankingProductFeature_2
object
4 properties
1 required
BankingScheduledPaymentTo
object
Object containing details of the destination of the payment. Used to specify a variety of payment destination types
6 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Newcastle Permanent Building Society 12
Other APIs Newcastle Permanent Building Society publishes across the network.
Newcastle Permanent Building Society Accounts API
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
Newcastle Permanent Building Society Customer API
Newcastle Permanent Building Society Direct Debits API
Newcastle Permanent Building Society Payees API
#Banking