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

AMP Bank Banking Account Scheduled Payments API

Banking Account Scheduled Payment endpoints

AMP Bank Banking Account Scheduled Payments API is one of 7 APIs that AMP Bank 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 38 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 operations 4 paths 38 schemas 4 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://api.cdr-api.amp.com.au/cds-au/v1/banking/products
Resource Areas
1

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Banking Account Scheduled Payments 5

Banking Account Scheduled Payment endpoints

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
GET
/banking/accounts/{accountId}/payments/plans
Get Instalment Plans for Account
listInstalmentPlans 10 params → 200400404406422
GET
/banking/accounts/payments/plans
Get Instalment Plans Bulk
listInstalmentPlansBulk 9 params → 200400406422

Schemas 38

The contract defines 38 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.

BankingDomesticPayeeAccount
object
3 properties 2 required
BankingInternationalPayee_bankDetails
object
9 properties 2 required
BankingInternationalPayee
object
2 properties 2 required
ResponseBankingInstalmentPlanList_data
object
1 property 1 required
BankingInstalmentPlan
object
14 properties 10 required
ErrorV2_meta
object
Additional data for customised error codes.
1 property
MetaPaginated
object
2 properties 2 required
BankingBillerPayee
object
3 properties 2 required
ResponseBankingScheduledPaymentsListV2
object
3 properties 3 required
BankingScheduledPaymentRecurrence
object
Object containing the detail of the schedule for the payment.
6 properties 1 required
BankingScheduledPaymentV2
object
8 properties 6 required
BankingScheduledPaymentRecurrenceIntervalSchedule
object
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if the recurrenceUType value is intervalSchedule.
4 properties 1 required
BankingProductCategoryV2
string
The category to which a product or account belongs. See [here](product-categories) for more details.
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 property 1 required
BankingScheduledPaymentId
string
A unique identifier for a Banking scheduled payment, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingInternationalPayee_beneficiaryDetails
object
3 properties 1 required
BankingInstalmentPlanSchedule
object
3 properties 2 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 property 1 required
ResponseErrorListV2
object
1 property 1 required
RequestAccountIdListV1
object
2 properties 1 required
BankingInstalmentPlanId
string
A unique identifier for a Banking instalment plan, generated according to [CDR ID Permanence](id-permanence) requirements.
ResponseBankingScheduledPaymentsListV2_data
object
1 property 1 required
ErrorV2
object
4 properties 3 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 the recurrenceUType valu…
5 properties 2 required
BankingDigitalWalletPayee
object
4 properties 4 required
BankingDomesticPayeeCard
object
1 property 1 required
BankingAccountId
string
A unique identifier for a Banking account, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingDomesticPayeePayId
object
3 properties 2 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 properties 1 required
RequestAccountIdListV1_data
object
1 property 1 required
LinksPaginated
object
5 properties 1 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 property 1 required
BankingDomesticPayee
object
4 properties 1 required
BankingPayeeId
string
A unique identifier for a Banking payee, generated according to [CDR ID Permanence](id-permanence) requirements.
BankingInternationalPayee_bankDetails_bankAddress
object
2 properties 2 required
ResponseBankingInstalmentPlanList
object
3 properties 3 required
BankingScheduledPaymentInterval
object
2 properties 1 required
BankingScheduledPaymentToV2
object
Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amp-bank-banking-account-scheduled-payments-api-openapi.yml Raw ↑

Other APIs AMP Bank publishes across the network.

AMP Bank Banking Account Balances API
AMP Bank Banking Account Direct Debits API
AMP Bank Banking Account Transactions API
AMP Bank Banking Accounts API
AMP Bank Banking Payees API
AMP Bank Banking Products API