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

The Payees API from Newcastle Permanent Building Society — 2 operation(s) for payees.

Newcastle Permanent Building Society Payees 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 Payees. 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 20 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 20 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
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.

Payees 2
GET
/banking/payees
Get Payees
listPayees 9 params → 200400406422
GET
/banking/payees/{payeeId}
Get Payee Detail
getPayeeDetail 7 params → 200400404406422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are BankingInternationalPayee_bankDetails (9 properties), LinksPaginated (5 properties), BankingPayee (5 properties), BankingDomesticPayee (4 properties). Each schema is shown below with its type and property counts.

BankingPayee
object
5 properties 3 required
ResponseErrorList
object
1 property 1 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required
ResponseBankingPayeeById
object
3 properties 2 required
BankingDomesticPayeeCard
object
1 property 1 required
BankingPayeeDetail
LinksPaginated
object
5 properties 1 required
Meta
object
BankingDomesticPayeeAccount
object
3 properties 2 required
MetaPaginated
object
2 properties 2 required
ResponseErrorList_errors
object
4 properties 3 required
BankingBillerPayee
object
3 properties 2 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
ResponseBankingPayeeList_data
object
1 property 1 required
ResponseBankingPayeeList
object
3 properties 3 required
BankingDomesticPayeePayId
object
3 properties 2 required
BankingDomesticPayee
object
4 properties 1 required
BankingInternationalPayee
object
2 properties 2 required
Links
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-payees-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 Direct Debits API