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 Scheduled Payments API

The Scheduled Payments API from Newcastle Permanent Building Society — 2 operation(s) for scheduled payments.

Newcastle Permanent Building Society Scheduled Payments 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 Scheduled Payments. 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 28 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 28 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.

Scheduled Payments 3
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

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are BankingInternationalPayee_bankDetails (9 properties), BankingScheduledPayment (8 properties), BankingScheduledPaymentRecurrence (6 properties), BankingScheduledPaymentTo (6 properties). Each schema is shown below with its type and property counts.

ResponseErrorList
object
1 property 1 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required
ResponseBankingScheduledPaymentsList_data
object
1 property 1 required
BankingDomesticPayeeCard
object
1 property 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
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
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
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
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
BankingScheduledPaymentInterval
object
2 properties 1 required
BankingScheduledPayment
object
8 properties 7 required
ResponseBankingScheduledPaymentsList
object
3 properties 3 required
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
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment
6 properties 1 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
BankingDomesticPayeePayId
object
3 properties 2 required
BankingDomesticPayee
object
4 properties 1 required
RequestAccountIds_data
object
1 property 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
BankingInternationalPayee
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-permanent-scheduled-payments-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