Newcastle Permanent Building Society Banking Account 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 Banking Account Scheduled Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 4 paths,
and defines 39 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.
5 operations4 paths39 schemas4 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are BankingInstalmentPlan (14 properties), BankingScheduledPaymentToV2 (9 properties), BankingInternationalPayee_bankDetails (9 properties), BankingScheduledPaymentV2 (8 properties). Each schema is shown below with its type and property counts.
BankingDigitalWalletPayee
object
4 properties4 required
ErrorV2_meta
object
Additional data for customised error codes.
1 property
ResponseBankingInstalmentPlanList_data
object
1 property1 required
BankingScheduledPaymentV2
object
8 properties6 required
RequestAccountIdListV1_data
object
1 property1 required
BankingInternationalPayee_bankDetails
object
9 properties2 required
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties2 required
BankingPayeeId
string
A unique identifier for a Banking payee, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingDomesticPayeeCard
object
1 property1 required
BankingScheduledPaymentToV2
object
Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
9 properties1 required
BankingScheduledPaymentId
string
A unique identifier for a Banking scheduled payment, generated according to [CDR ID Permanence](id-permanence) requirements.
ResponseBankingScheduledPaymentsListV2_data
object
1 property1 required
BankingScheduledPaymentRecurrenceOnceOff
object
Indicates that the payment is a once off payment on a specific future date. Mandatory if the recurrenceUType value is onceOff.
1 property1 required
ResponseErrorListV2
object
1 property1 required
BankingScheduledPaymentRecurrenceEventBased
object
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if the recurrenceUType value is event…
1 property1 required
BankingInstalmentPlanSchedule
object
3 properties2 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.
ResponseBankingInstalmentPlanList
object
3 properties3 required
LinksPaginated
object
5 properties1 required
BankingScheduledPaymentFrom
object
Object containing details of the source of the payment. Currently only specifies an accountId but provided as an object to facilitate future extensibility and…
1 property1 required
BankingScheduledPaymentSetV2
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 properties1 required
BankingScheduledPaymentRecurrenceIntervalSchedule
object
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if the recurrenceUType value is intervalSchedule.
4 properties1 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 the recurrenceUType valu…
5 properties2 required
BankingScheduledPaymentInterval
object
2 properties1 required
BankingDomesticPayeeAccount
object
3 properties2 required
MetaPaginated
object
2 properties2 required
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment.
6 properties1 required
BankingBillerPayee
object
3 properties2 required
BankingInternationalPayee_beneficiaryDetails
object
3 properties1 required
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingDomesticPayeePayId
object
3 properties2 required
BankingDomesticPayee
object
4 properties1 required
BankingInstalmentPlan
object
14 properties10 required
ResponseBankingScheduledPaymentsListV2
object
3 properties3 required
BankingInternationalPayee
object
2 properties2 required
RequestAccountIdListV1
object
2 properties1 required
ErrorV2
object
4 properties3 required
BankingInstalmentPlanId
string
A unique identifier for a Banking instalment plan, generated according to [CDR ID Permanence](id-permanence) requirements.
Specification
The full machine-readable OpenAPI contract behind this narrative.
