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 Direct Debits API

The Direct Debits API from Newcastle Permanent Building Society — 2 operation(s) for direct debits.

Newcastle Permanent Building Society Direct Debits 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 Direct Debits. 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 11 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 11 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://openbank.newcastlepermanent.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.

Direct Debits 3
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

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are BankingAuthorisedEntity (5 properties), LinksPaginated (5 properties), BankingDirectDebit (4 properties), ResponseErrorList_errors (4 properties). Each schema is shown below with its type and property counts.

BankingAuthorisedEntity
object
5 properties
RequestAccountIds
object
2 properties 1 required
ResponseBankingDirectDebitAuthorisationList
object
3 properties 3 required
Meta
object
ResponseErrorList
object
1 property 1 required
RequestAccountIds_data
object
1 property 1 required
BankingDirectDebit
object
4 properties 2 required
MetaPaginated
object
2 properties 2 required
ResponseErrorList_errors
object
4 properties 3 required
ResponseBankingDirectDebitAuthorisationList_data
object
1 property 1 required
LinksPaginated
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-direct-debits-api-openapi.yml Raw ↑

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 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 Payees API