diff --git a/docs/includes/cds_banking b/docs/includes/cds_banking
index 06946c73..f662129d 100644
--- a/docs/includes/cds_banking
+++ b/docs/includes/cds_banking
@@ -3163,6 +3163,12 @@ To perform this operation, you must be authenticated and authorised with the fol
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -3591,6 +3597,12 @@ To perform this operation, you must be authenticated and authorised with the fol
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -3938,6 +3950,12 @@ To perform this operation, you must be authenticated and authorised with the fol
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -10373,6 +10391,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -10520,6 +10544,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -10687,6 +10717,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -10781,6 +10817,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -10867,6 +10909,12 @@ This operation does not require authentication
| The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level. |
+| digitalWallet |
+BankingDigitalWalletPayee |
+conditional |
+none |
+
+
| domestic |
BankingDomesticPayee |
conditional |
@@ -10902,6 +10950,10 @@ This operation does not require authentication
| toUType |
+digitalWallet |
+
+
+| toUType |
domestic |
diff --git a/docs/includes/swagger/cds_banking.json b/docs/includes/swagger/cds_banking.json
index fbbd92bc..9170ba32 100644
--- a/docs/includes/swagger/cds_banking.json
+++ b/docs/includes/swagger/cds_banking.json
@@ -5092,7 +5092,7 @@
"properties" : {
"toUType" : {
"description" : "The type of object provided that specifies the destination of the funds for the payment.",
- "enum" : [ "accountId", "biller", "domestic", "international", "payeeId" ],
+ "enum" : [ "accountId", "biller", "digitalWallet", "domestic", "international", "payeeId" ],
"type" : "string"
},
"accountId" : {
@@ -5113,6 +5113,9 @@
"description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.",
"type" : "string"
},
+ "digitalWallet" : {
+ "$ref" : "#/components/schemas/BankingDigitalWalletPayee"
+ },
"domestic" : {
"$ref" : "#/components/schemas/BankingDomesticPayee"
},
@@ -5125,7 +5128,7 @@
},
"required" : [ "toUType" ],
"type" : "object",
- "x-conditional" : [ "accountId", "payeeId", "domestic", "biller", "international", "nickname", "payeeReference" ]
+ "x-conditional" : [ "accountId", "payeeId", "digitalWallet", "domestic", "biller", "international", "nickname", "payeeReference" ]
},
"BankingScheduledPaymentFrom" : {
"description" : "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 consistency with the to object",
diff --git a/docs/includes/swagger/cds_banking.yaml b/docs/includes/swagger/cds_banking.yaml
index 01833c72..8dd95765 100644
--- a/docs/includes/swagger/cds_banking.yaml
+++ b/docs/includes/swagger/cds_banking.yaml
@@ -5634,6 +5634,11 @@ components:
- beneficiaryDetails
type: object
BankingDigitalWalletPayee:
+ example:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
properties:
name:
description: The name assigned to the digital wallet by the owner of the
@@ -5818,6 +5823,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5860,6 +5870,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5932,6 +5947,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5974,6 +5994,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6069,6 +6094,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6111,6 +6141,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6208,6 +6243,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6273,6 +6313,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6301,6 +6346,7 @@ components:
enum:
- accountId
- biller
+ - digitalWallet
- domestic
- international
- payeeId
@@ -6329,6 +6375,8 @@ components:
not empty, it overrides the value provided at the BankingScheduledPayment
level.
type: string
+ digitalWallet:
+ $ref: '#/components/schemas/BankingDigitalWalletPayee'
domestic:
$ref: '#/components/schemas/BankingDomesticPayee'
biller:
@@ -6341,6 +6389,7 @@ components:
x-conditional:
- accountId
- payeeId
+ - digitalWallet
- domestic
- biller
- international
@@ -7494,6 +7543,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7536,6 +7590,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7608,6 +7667,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7650,6 +7714,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
diff --git a/docs/index.html b/docs/index.html
index 36a985f4..9699c5a1 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -16251,6 +16251,12 @@ Parameters
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -16691,6 +16697,12 @@ Enumerated Values
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -17046,6 +17058,12 @@ Parameters
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -23553,6 +23571,12 @@ ResponseBan
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -23700,6 +23724,12 @@ BankingScheduledPayment<
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -23867,6 +23897,12 @@ BankingScheduledPayme
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -23965,6 +24001,12 @@ BankingScheduledPaymen
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -24054,6 +24096,12 @@ Properties
The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level. |
+| digitalWallet |
+BankingDigitalWalletPayee |
+conditional |
+none |
+
+
| domestic |
BankingDomesticPayee |
conditional |
@@ -24091,6 +24139,10 @@ Enumerated Values
| toUType |
+digitalWallet |
+
+
+| toUType |
domestic |
diff --git a/slate/source/includes/_banking_apis.md.erb b/slate/source/includes/_banking_apis.md.erb
index 6ffeea82..757f8bf9 100644
--- a/slate/source/includes/_banking_apis.md.erb
+++ b/slate/source/includes/_banking_apis.md.erb
@@ -10,6 +10,32 @@ This specification defines the APIs for Data Holders exposing Banking endpoints.
| Banking OpenAPI Specification (YAML) |
+```diff
+Updated the versions of the following APIs:
++ Get Scheduled Payments For Account from v1 to v2
++ Get Scheduled Payments Bulk from v1 to v2
++ Get Scheduled Payments For Specific Accounts from v1 to v2
+
+
+Updated the following structures
+from:
+- ResponseBankingScheduledPaymentsList
+- BankingScheduledPayment
+- BankingScheduledPaymentSet
+- BankingScheduledPaymentTo
+
+to:
++ ResponseBankingScheduledPaymentsListV2
++ BankingScheduledPaymentV2
++ BankingScheduledPaymentSetV2
++ BankingScheduledPaymentToV2
+
+Added the following to 'BankingScheduledPaymentToV2' structure:
++ 'digitalWallet' ENUM value to the toUType field
++ 'digitalWallet' object
++ 'BankingDigitalWalletPayee' schema for 'digitalWallet' object
+```
+
<%= partial "includes/cds_banking.md" %>
<%= partial "includes/banking/_product_categories.md" %>
<%= partial "includes/banking/_product_components.md" %>
diff --git a/slate/source/includes/_energy_apis.md.erb b/slate/source/includes/_energy_apis.md.erb
index 670c8a83..eac47e30 100644
--- a/slate/source/includes/_energy_apis.md.erb
+++ b/slate/source/includes/_energy_apis.md.erb
@@ -9,6 +9,12 @@ This specification defines the APIs for Data Holders exposing Energy endpoints.
```diff
+Updated description of EnergyPaymentSchedule.digitalWallet.name field
+from:
+- The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider
+to:
++ The display name of the wallet as given by the customer, else a default value defined by the data holder
+
Updated description of `EnergyPaymentSchedule.isTokenised` field to further clarify when it can be used
Updated the versions of the following APIs:
diff --git a/slate/source/includes/_telco_apis.md.erb b/slate/source/includes/_telco_apis.md.erb
index 8b2ba0dd..d017c371 100644
--- a/slate/source/includes/_telco_apis.md.erb
+++ b/slate/source/includes/_telco_apis.md.erb
@@ -14,4 +14,12 @@ Note that the standards for the telecommunications sector are currently in draft
| Telco OpenAPI Specification (YAML) |
+```diff
+Updated description of TelcoPaymentScheduleDigitalWallet.name field
+from:
+- The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider
+to:
++ The display name of the wallet as given by the customer, else a default value defined by the data holder
+```
+
<%= partial "includes/cds_telco.md" %>
diff --git a/slate/source/includes/cds_banking.md b/slate/source/includes/cds_banking.md
index 1560b220..baca122e 100644
--- a/slate/source/includes/cds_banking.md
+++ b/slate/source/includes/cds_banking.md
@@ -1696,6 +1696,12 @@ Obtain scheduled, outgoing payments for a specific account
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -1933,6 +1939,12 @@ Obtain scheduled payments for multiple, filtered accounts that are the source of
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -2161,6 +2173,12 @@ Obtain scheduled payments for a specified list of accounts
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -5940,6 +5958,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6065,6 +6089,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6178,6 +6208,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6250,6 +6286,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6307,6 +6349,7 @@ This operation does not require authentication
|payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead|
|nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels|
|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.|
+|digitalWallet|[BankingDigitalWalletPayee](#schemacdr-banking-apibankingdigitalwalletpayee)|conditional|none|
|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none|
|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none|
|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none|
@@ -6317,6 +6360,7 @@ This operation does not require authentication
|---|---|
|toUType|accountId|
|toUType|biller|
+|toUType|digitalWallet|
|toUType|domestic|
|toUType|international|
|toUType|payeeId|
diff --git a/slate/source/includes/endpoint-version-schedule/includes/_banking-dh.md b/slate/source/includes/endpoint-version-schedule/includes/_banking-dh.md
index c7c081f1..5a5c6549 100644
--- a/slate/source/includes/endpoint-version-schedule/includes/_banking-dh.md
+++ b/slate/source/includes/endpoint-version-schedule/includes/_banking-dh.md
@@ -3,29 +3,32 @@
| Section | Sub-section | Endpoint | Method | Version | Binding Date | Retirement Date | Date Introduced | Date Deprecated |
|-----------------|---------------------------------------------|------------------------------------------------------------|--------|---------|---------------------|-----------------|--------------------|--------------------|
| Banking APIs | Get Products | ``/banking/products`` | GET | V1 | 2020-02-01 | 2020-09-29 | 2019-09-30, V1.0.0 | 2020-01-31, V1.2.0 |
-| Banking APIs | GetProducts | ``/banking/products`` | GET | V2 | 2020-07-31 | 2021-05-31 | 2020-01-31, V1.2.0 | 2021-04-29, V1.9.0 |
-| Banking APIs | GetProducts | ``/banking/products`` | GET | V3 | 2021-02-28 | N/A | 2020-04-17, V1.3.0 | N/A |
-| Banking APIs | GetProduct Detail | ``/banking/product/{productId}`` | GET | V1 | 2020-02-01 | 2020-09-29 | 2019-09-30, V1.0.0 | 2020-01-31, V1.2.0 |
-| Banking APIs | GetProduct Detail | ``/banking/product/{productId}`` | GET | V2 | 2020-07-31 | 2021-05-31 | 2020-01-31, V1.2.0 | 2021-04-29, V1.9.0 |
-| Banking APIs | GetProduct Detail | ``/banking/product/{productId}`` | GET | V3 | 2021-02-28 | 2023-02-28 | 2020-04-17, V1.3.0 | 2021-12-23, V1.15.0|
-| Banking APIs | GetProduct Detail | ``/banking/product/{productId}`` | GET | V4 | 2022-11-31 | N/A | 2021-12-23, V1.15.0| N/A |
-| Banking APIs | GetAccounts | ``/banking/accounts/`` | GET | V1 | 2020-07-01 | 2024-03-11 | 2019-09-30, V1.0.0 | 2022-12-22, v1.22.0 |
-| Banking APIs | GetAccounts | ``/banking/accounts/`` | GET | V2 | 2023-07-10 | N/A | 2022-12-22, v1.22.0 | N/A |
-| Banking APIs | GetAccount Balances | ``/banking/accounts/balances`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetBalances For Specific Accounts | ``/banking/accounts/balances`` | POST | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetAccount Balance | ``/banking/accounts/{accountId}/balance`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetAccount Detail | ``/banking/accounts/{accountId}`` | GET | V1 | 2020-11-01 | 2023-02-28 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
-| Banking APIs | GetAccount Detail | ``/banking/accounts/{accountId}`` | GET | V2 | 2022-11-31 | 2024-03-11 | 2021-12-23, V1.15.0| 2022-12-22, V1.22.0 |
-| Banking APIs | GetAccount Detail | ``/banking/accounts/{accountId}`` | GET | V3 | 2023-07-10 | N/A | 2022-12-22, V1.22.0| N/A |
-| Banking APIs | GetTransactions For Account | ``/banking/accounts/{accountId}/transactions`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetTransaction Detail | ``/banking/accounts/{accountId}/``
``transactions/{transactionId}``|GET| V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetDirect Debits For Account | ``/banking/accounts/{accountId}/direct-debits`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetBulk Direct Debits | ``/banking/accounts/direct-debits`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetDirect Debits For Specific Accounts | ``/banking/accounts/direct-debits`` | POST | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetScheduled Payments For Account | ``/banking/accounts/{accountId}/``
``payments/scheduled`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetScheduled Payments Bulk | ``/banking/payments/scheduled`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetScheduled Payments For Specific Accounts | ``/banking/payments/scheduled`` | POST | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetPayees | ``/banking/payees`` | GET | V1 | 2020-11-01 | 2022-08-31 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
-| Banking APIs | GetPayees | ``/banking/payees`` | GET | V2 | 2022-07-31 | N/A | 2019-09-30, V1.0.0 | N/A |
-| Banking APIs | GetPayee Detail | ``/banking/payees/{payeeId}`` | GET | V1 | 2020-11-01 | 2022-08-31 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
-| Banking APIs | GetPayee Detail | ``/banking/payees/{payeeId}`` | GET | V2 | 2022-07-31 | N/A | 2021-12-23, V1.15.0| N/A |
+| Banking APIs | Get Products | ``/banking/products`` | GET | V2 | 2020-07-31 | 2021-05-31 | 2020-01-31, V1.2.0 | 2021-04-29, V1.9.0 |
+| Banking APIs | Get Products | ``/banking/products`` | GET | V3 | 2021-02-28 | N/A | 2020-04-17, V1.3.0 | N/A |
+| Banking APIs | Get Product Detail | ``/banking/product/{productId}`` | GET | V1 | 2020-02-01 | 2020-09-29 | 2019-09-30, V1.0.0 | 2020-01-31, V1.2.0 |
+| Banking APIs | Get Product Detail | ``/banking/product/{productId}`` | GET | V2 | 2020-07-31 | 2021-05-31 | 2020-01-31, V1.2.0 | 2021-04-29, V1.9.0 |
+| Banking APIs | Get Product Detail | ``/banking/product/{productId}`` | GET | V3 | 2021-02-28 | 2023-02-28 | 2020-04-17, V1.3.0 | 2021-12-23, V1.15.0|
+| Banking APIs | Get Product Detail | ``/banking/product/{productId}`` | GET | V4 | 2022-11-31 | N/A | 2021-12-23, V1.15.0| N/A |
+| Banking APIs | Get Accounts | ``/banking/accounts/`` | GET | V1 | 2020-07-01 | 2024-03-11 | 2019-09-30, V1.0.0 | 2022-12-22, v1.22.0 |
+| Banking APIs | Get Accounts | ``/banking/accounts/`` | GET | V2 | 2023-07-10 | N/A | 2022-12-22, v1.22.0 | N/A |
+| Banking APIs | Get Account Balances | ``/banking/accounts/balances`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Balances For Specific Accounts | ``/banking/accounts/balances`` | POST | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Account Balance | ``/banking/accounts/{accountId}/balance`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Account Detail | ``/banking/accounts/{accountId}`` | GET | V1 | 2020-11-01 | 2023-02-28 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
+| Banking APIs | Get Account Detail | ``/banking/accounts/{accountId}`` | GET | V2 | 2022-11-31 | 2024-03-11 | 2021-12-23, V1.15.0| 2022-12-22, V1.22.0 |
+| Banking APIs | Get Account Detail | ``/banking/accounts/{accountId}`` | GET | V3 | 2023-07-10 | N/A | 2022-12-22, V1.22.0| N/A |
+| Banking APIs | Get Transactions For Account | ``/banking/accounts/{accountId}/transactions`` | GET | V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Transaction Detail | ``/banking/accounts/{accountId}/``
``transactions/{transactionId}``|GET| V1 | 2020-07-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Direct Debits For Account | ``/banking/accounts/{accountId}/direct-debits`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Bulk Direct Debits | ``/banking/accounts/direct-debits`` | GET | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Direct Debits For Specific Accounts | ``/banking/accounts/direct-debits`` | POST | V1 | 2020-11-01 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Scheduled Payments For Account | ``/banking/accounts/{accountId}/``
``payments/scheduled`` | GET | V1 | 2020-11-01 | 2024-09-09 | 2019-09-30, V1.0.0 | TBC, V1.25.0 |
+| Banking APIs | Get Scheduled Payments For Account | ``/banking/accounts/{accountId}/``
``payments/scheduled`` | GET | V2 | 2024-03-11 | N/A | TBC, V1.25.0 | N/A |
+| Banking APIs | Get Scheduled Payments Bulk | ``/banking/payments/scheduled`` | GET | V1 | 2020-11-01 | 2024-09-09 | 2019-09-30, V1.0.0 | TBC, V1.25.0 |
+| Banking APIs | Get Scheduled Payments Bulk | ``/banking/payments/scheduled`` | GET | V2 | 2024-03-11 | N/A | TBC, V1.25.0 | N/A |
+| Banking APIs | Get Scheduled Payments For Specific Accounts | ``/banking/payments/scheduled`` | POST | V1 | 2020-11-01 | 2024-09-09 | 2019-09-30, V1.0.0 | TBC, V1.25.0 |
+| Banking APIs | Get Scheduled Payments For Specific Accounts | ``/banking/payments/scheduled`` | POST | V2 | 2024-03-11 | N/A | TBC, V1.25.0 | N/A |
+| Banking APIs | Get Payees | ``/banking/payees`` | GET | V1 | 2020-11-01 | 2022-08-31 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
+| Banking APIs | Get Payees | ``/banking/payees`` | GET | V2 | 2022-07-31 | N/A | 2019-09-30, V1.0.0 | N/A |
+| Banking APIs | Get Payee Detail | ``/banking/payees/{payeeId}`` | GET | V1 | 2020-11-01 | 2022-08-31 | 2019-09-30, V1.0.0 | 2021-12-23, V1.15.0|
+| Banking APIs | Get Payee Detail | ``/banking/payees/{payeeId}`` | GET | V2 | 2022-07-31 | N/A | 2021-12-23, V1.15.0| N/A |
diff --git a/slate/source/includes/introduction/_fdo.md b/slate/source/includes/introduction/_fdo.md
index 8849597c..e321503c 100644
--- a/slate/source/includes/introduction/_fdo.md
+++ b/slate/source/includes/introduction/_fdo.md
@@ -31,6 +31,9 @@ The table below highlights these areas of the standards.
|[Private Key JWT Client Authentication](#https://consumerdatastandardsaustralia.github.io/standards/?examples#client-authentication) | Change to support [**[RFC7521]**](#nref-RFC7521) such that, until November 13th 2023, clients authenticating using Private Key JWT are _recommended_ to provide the `client_id`, but no longer required. From November 13th 2023, it is then _optional_ to provide the `client_id`. This applies to ADRs and the CDR Register authenticating with Data Holders and ADRs authenticating with the CDR Regsiter. | November 13th 2023 |
|[Get Accounts V1](#get-account-detail)|Data Holders **MAY** decommission v1 of this end point from March 11th 2024| March 11th 2024 |
|[Get Account Detail V2](#get-account-detail)|Data Holders **MAY** decommission v2 of this end point from March 11th 2024| March 11th 2024 |
+|[Get Scheduled Payments for Account V2](#get-scheduled-payments-for-account)|- Data Holder **MUST** implement v2 of this endpoint by **March 11th 2024**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| March 11th 2024 |
+|[Get Scheduled Payments Bulk V2](#get-scheduled-payments-bulk)|- Data Holder **MUST** implement v2 of this endpoint by **March 11th 2024**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| March 11th 2024 |
+|[Get Scheduled Payments For Specific Accounts V2](#get-scheduled-payments-for-specific-accounts)|- Data Holder **MUST** implement v2 of this endpoint by **March 11th 2024**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| March 11th 2024 |
|[Get Billing For Account V2](#get-billing-for-account)|- Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| November 1st 2023 |
|[Get Bulk Billing V2](#get-bulk-billing)|- Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| November 1st 2023 |
-|[Get Billing For Specific Accounts V2](#get-billing-for-specific-accounts)|- Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| November 1st 2023 |
\ No newline at end of file
+|[Get Billing For Specific Accounts V2](#get-billing-for-specific-accounts)|- Data Holder **MUST** implement v2 of this endpoint by **November 1st 2023**
- Data Holders **MAY** obsolete v1 of this endpoint from **September 9th 2024**
| November 1st 2023 |
diff --git a/slate/source/includes/obsolete/get-scheduled-payments-bulk-v1.html.md b/slate/source/includes/obsolete/get-scheduled-payments-bulk-v1.html.md
new file mode 100644
index 00000000..97523bc2
--- /dev/null
+++ b/slate/source/includes/obsolete/get-scheduled-payments-bulk-v1.html.md
@@ -0,0 +1,1146 @@
+---
+title: Get Scheduled Payments Bulk v1
+
+#language_tabs: # must be one of https://git.io/vQNgJ
+# - shell
+# - javascript
+
+toc_footers:
+ - Consumer Data Standards
+
+search: false
+---
+
+# Get Scheduled Payments Bulk V1
+This page documents the obsolete version 1 of the Get Scheduled Payments Bulk endpoint.
+
+* Data Holder **MUST** implement Get Scheduled Payments Bulk v2 by **March 11th 2024**.
+
+This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
+
+## Get Scheduled Payments Bulk
+
+
+
+> Code samples
+
+```http
+GET https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+```
+
+```javascript
+var headers = {
+ 'Accept':'application/json',
+ 'x-v':'string',
+ 'x-min-v':'string',
+ 'x-fapi-interaction-id':'string',
+ 'x-fapi-auth-date':'string',
+ 'x-fapi-customer-ip-address':'string',
+ 'x-cds-client-headers':'string'
+
+};
+
+$.ajax({
+ url: 'https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+ method: 'get',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+```
+
+`GET /banking/payments/scheduled`
+
+Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
+
+###Endpoint Version
+| | |
+|---|--|
+|Version|**1**
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|product-category|query|string|optional|Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.|
+|open-status|query|string|optional|Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed|
+|is-owned|query|[Boolean](#common-field-types)|optional|Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts|
+|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)|
+|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)|
+|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)|
+|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.|
+|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.|
+|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.|
+|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.|
+
+#### Enumerated Values
+
+|Parameter|Value|
+|---|---|
+|product-category|BUSINESS_LOANS|
+|product-category|CRED_AND_CHRG_CARDS|
+|product-category|LEASES|
+|product-category|MARGIN_LOANS|
+|product-category|OVERDRAFTS|
+|product-category|PERS_LOANS|
+|product-category|REGULATED_TRUST_ACCOUNTS|
+|product-category|RESIDENTIAL_MORTGAGES|
+|product-category|TERM_DEPOSITS|
+|product-category|TRADE_FINANCE|
+|product-category|TRANS_AND_SAVINGS_ACCOUNTS|
+|product-category|TRAVEL_CARDS|
+|open-status|ALL|
+|open-status|CLOSED|
+|open-status|OPEN|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsList](#schemacdr-banking-apiresponsebankingscheduledpaymentslist)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+
+### Response Headers
+
+|Status|Header|Type|Format|Description|
+|---|---|---|---|---|
+|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.|
+|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+
+
+
+
+
+
+ResponseBankingScheduledPaymentsList
+
+
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|data|object|mandatory|none|
+|» scheduledPayments|[[BankingScheduledPayment](#schemacdr-banking-apibankingscheduledpayment)]|mandatory|The list of scheduled payments to return|
+|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none|
+|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none|
+
+BankingScheduledPayment
+
+
+
+```json
+{
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|scheduledPaymentId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the scheduled payment adhering to the standards for ID permanence|
+|nickname|string|optional|The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels|
+|payerReference|string|mandatory|The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided|
+|status|string|mandatory|Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.|
+|from|[BankingScheduledPaymentFrom](#schemacdr-banking-apibankingscheduledpaymentfrom)|mandatory|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 consistency with the to object|
+|paymentSet|[[BankingScheduledPaymentSet](#schemacdr-banking-apibankingscheduledpaymentset)]|mandatory|[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]|
+|recurrence|[BankingScheduledPaymentRecurrence](#schemacdr-banking-apibankingscheduledpaymentrecurrence)|mandatory|Object containing the detail of the schedule for the payment|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|ACTIVE|
+|status|INACTIVE|
+|status|SKIP|
+
+BankingScheduledPaymentFrom
+
+
+
+```json
+{
+ "accountId": "string"
+}
+
+```
+
+*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 consistency with the to object*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account that is the source of funds for the payment|
+
+
+BankingScheduledPaymentRecurrence
+
+
+
+```json
+{
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+}
+
+```
+
+*Object containing the detail of the schedule for the payment*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|nextPaymentDate|[DateString](#common-field-types)|optional|The date of the next payment under the recurrence schedule|
+|recurrenceUType|string|mandatory|The type of recurrence used to define the schedule|
+|onceOff|[BankingScheduledPaymentRecurrenceOnceOff](#schemacdr-banking-apibankingscheduledpaymentrecurrenceonceoff)|conditional|Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff|
+|intervalSchedule|[BankingScheduledPaymentRecurrenceIntervalSchedule](#schemacdr-banking-apibankingscheduledpaymentrecurrenceintervalschedule)|conditional|Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule|
+|lastWeekDay|[BankingScheduledPaymentRecurrenceLastWeekday](#schemacdr-banking-apibankingscheduledpaymentrecurrencelastweekday)|conditional|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 to lastWeekDay|
+|eventBased|[BankingScheduledPaymentRecurrenceEventBased](#schemacdr-banking-apibankingscheduledpaymentrecurrenceeventbased)|conditional|Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|recurrenceUType|eventBased|
+|recurrenceUType|intervalSchedule|
+|recurrenceUType|lastWeekDay|
+|recurrenceUType|onceOff|
+
+BankingScheduledPaymentRecurrenceOnceOff
+
+
+
+```json
+{
+ "paymentDate": "string"
+}
+
+```
+
+*Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|paymentDate|[DateString](#common-field-types)|mandatory|The scheduled date for the once off payment|
+
+BankingScheduledPaymentRecurrenceIntervalSchedule
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+}
+
+```
+
+*Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+|intervals|[[BankingScheduledPaymentInterval](#schemacdr-banking-apibankingscheduledpaymentinterval)]|mandatory|An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentInterval
+
+
+
+```json
+{
+ "interval": "string",
+ "dayInInterval": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|interval|[ExternalRef](#common-field-types)|mandatory|An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|dayInInterval|[ExternalRef](#common-field-types)|optional|Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.|
+
+BankingScheduledPaymentRecurrenceLastWeekday
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+}
+
+```
+
+*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 to lastWeekDay*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|interval|[ExternalRef](#common-field-types)|mandatory|The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|lastWeekDay|string|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|lastWeekDay|FRI|
+|lastWeekDay|MON|
+|lastWeekDay|SAT|
+|lastWeekDay|SUN|
+|lastWeekDay|THU|
+|lastWeekDay|TUE|
+|lastWeekDay|WED|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentRecurrenceEventBased
+
+
+
+```json
+{
+ "description": "string"
+}
+
+```
+
+*Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|description|string|mandatory|Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer|
+
+
+
+
+
+
+
+
+BankingScheduledPaymentSet
+
+
+
+```json
+{
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+}
+
+```
+
+*The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|to|[BankingScheduledPaymentTo](#schemacdr-banking-apibankingscheduledpaymentto)|mandatory|Object containing details of the destination of the payment. Used to specify a variety of payment destination types|
+|isAmountCalculated|[Boolean](#common-field-types)|optional|Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed|
+|amount|[AmountString](#common-field-types)|conditional|The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present|
+|currency|[CurrencyString](#common-field-types)|optional|The currency for the payment. AUD assumed if not present|
+
+BankingScheduledPaymentTo
+
+
+
+```json
+{
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+}
+
+```
+
+*Object containing details of the destination of the payment. Used to specify a variety of payment destination types*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|toUType|string|mandatory|The type of object provided that specifies the destination of the funds for the payment.|
+|accountId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent|
+|payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead|
+|nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.|
+|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none|
+|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none|
+|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|toUType|accountId|
+|toUType|biller|
+|toUType|domestic|
+|toUType|international|
+|toUType|payeeId|
+
+BankingDomesticPayee
+
+
+
+```json
+{
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|payeeAccountUType|string|mandatory|Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP|
+|account|[BankingDomesticPayeeAccount](#schemacdr-banking-apibankingdomesticpayeeaccount)|conditional|none|
+|card|[BankingDomesticPayeeCard](#schemacdr-banking-apibankingdomesticpayeecard)|conditional|none|
+|payId|[BankingDomesticPayeePayId](#schemacdr-banking-apibankingdomesticpayeepayid)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|payeeAccountUType|account|
+|payeeAccountUType|card|
+|payeeAccountUType|payId|
+
+
+BankingDomesticPayeeAccount
+
+
+
+```json
+{
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountName|string|optional|Name of the account to pay to|
+|bsb|string|mandatory|BSB of the account to pay to|
+|accountNumber|string|mandatory|Number of the account to pay to|
+
+BankingDomesticPayeeCard
+
+
+
+```json
+{
+ "cardNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|cardNumber|[MaskedPANString](#common-field-types)|mandatory|Name of the account to pay to|
+
+
+BankingDomesticPayeePayId
+
+
+
+```json
+{
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|name|string|optional|The name assigned to the PayID by the owner of the PayID|
+|identifier|string|mandatory|The identifier of the PayID (dependent on type)|
+|type|string|mandatory|The type of the PayID|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|type|ABN|
+|type|EMAIL|
+|type|ORG_IDENTIFIER|
+|type|TELEPHONE|
+
+
+BankingBillerPayee
+
+
+
+```json
+{
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|billerCode|string|mandatory|BPAY Biller Code of the Biller|
+|crn|string|conditional|BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.|
+|billerName|string|mandatory|Name of the Biller|
+
+BankingInternationalPayee
+
+
+
+```json
+{
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|beneficiaryDetails|object|mandatory|none|
+|» name|string|optional|Name of the beneficiary|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» message|string|optional|Response message for the payment|
+|bankDetails|object|mandatory|none|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» accountNumber|string|mandatory|Account Targeted for payment|
+|» bankAddress|object|optional|none|
+|»» name|string|mandatory|Name of the recipient Bank|
+|»» address|string|mandatory|Address of the recipient Bank|
+|» beneficiaryBankBIC|[ExternalRef](#common-field-types)|optional|Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)|
+|» fedWireNumber|string|optional|Number for Fedwire payment (Federal Reserve Wire Network)|
+|» sortCode|string|optional|Sort code used for account identification in some jurisdictions|
+|» chipNumber|string|optional|Number for the Clearing House Interbank Payments System|
+|» routingNumber|string|optional|International bank routing number|
+|» legalEntityIdentifier|[ExternalRef](#common-field-types)|optional|The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)|
+
+
+ResponseErrorListV2
+
+
+
+```json
+{
+ "errors": [
+ {
+ "code": "string",
+ "title": "string",
+ "detail": "string",
+ "meta": {
+ "urn": "string"
+ }
+ }
+ ]
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|errors|[object]|mandatory|none|
+|» code|string|mandatory|The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.|
+|» title|string|mandatory|A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.|
+|» detail|string|mandatory|A human-readable explanation specific to this occurrence of the problem.|
+|» meta|[MetaError](#schemacdr-banking-apimetaerror)|optional|Additional data for customised error codes|
+
+
+LinksPaginated
+
+
+
+```json
+{
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|self|[URIString](#common-field-types)|mandatory|Fully qualified link that generated the current response document|
+|first|[URIString](#common-field-types)|conditional|URI to the first page of this set. Mandatory if this response is not the first page|
+|prev|[URIString](#common-field-types)|conditional|URI to the previous page of this set. Mandatory if this response is not the first page|
+|next|[URIString](#common-field-types)|conditional|URI to the next page of this set. Mandatory if this response is not the last page|
+|last|[URIString](#common-field-types)|conditional|URI to the last page of this set. Mandatory if this response is not the last page|
+
+
+
+
+
+```json
+{
+ "totalRecords": 0,
+ "totalPages": 0
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|totalRecords|[NaturalNumber](#common-field-types)|mandatory|The total number of records in the full set. See [pagination](#pagination).|
+|totalPages|[NaturalNumber](#common-field-types)|mandatory|The total number of pages in the full set. See [pagination](#pagination).|
\ No newline at end of file
diff --git a/slate/source/includes/obsolete/get-scheduled-payments-for-account-v1.html.md b/slate/source/includes/obsolete/get-scheduled-payments-for-account-v1.html.md
new file mode 100644
index 00000000..3abbf201
--- /dev/null
+++ b/slate/source/includes/obsolete/get-scheduled-payments-for-account-v1.html.md
@@ -0,0 +1,1120 @@
+---
+title: Get Scheduled Payments for Account v1
+
+#language_tabs: # must be one of https://git.io/vQNgJ
+# - shell
+# - javascript
+
+toc_footers:
+ - Consumer Data Standards
+
+search: false
+---
+
+# Get Scheduled Payments for Account V1
+This page documents the obsolete version 1 of the Get Scheduled Payments for Account endpoint.
+
+* Data Holder **MUST** implement Get Scheduled Payments for Account v2 by **March 11th 2024**.
+
+This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
+
+## Get Scheduled Payments for Account
+
+
+
+> Code samples
+
+```http
+GET https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+```
+
+```javascript
+var headers = {
+ 'Accept':'application/json',
+ 'x-v':'string',
+ 'x-min-v':'string',
+ 'x-fapi-interaction-id':'string',
+ 'x-fapi-auth-date':'string',
+ 'x-fapi-customer-ip-address':'string',
+ 'x-cds-client-headers':'string'
+
+};
+
+$.ajax({
+ url: 'https://data.holder.com.au/cds-au/v1/banking/accounts/{accountId}/payments/scheduled',
+ method: 'get',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+```
+
+`GET /banking/accounts/{accountId}/payments/scheduled`
+
+Obtain scheduled, outgoing payments for a specific account
+
+###Endpoint Version
+| | |
+|---|--|
+|Version|**1**
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|accountId|path|[ASCIIString](#common-field-types)|mandatory|ID of the account to get scheduled payments for. Must have previously been returned by one of the account list end points. The account specified is the source account for the payment|
+|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)|
+|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)|
+|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)|
+|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.|
+|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.|
+|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.|
+|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsList](#schemacdr-banking-apiresponsebankingscheduledpaymentslist)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The following error codes MUST be supported:
- [404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)
- [404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+
+### Response Headers
+
+|Status|Header|Type|Format|Description|
+|---|---|---|---|---|
+|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.|
+|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|404|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+
+
+
+
+
+
+ResponseBankingScheduledPaymentsList
+
+
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|data|object|mandatory|none|
+|» scheduledPayments|[[BankingScheduledPayment](#schemacdr-banking-apibankingscheduledpayment)]|mandatory|The list of scheduled payments to return|
+|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none|
+|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none|
+
+BankingScheduledPayment
+
+
+
+```json
+{
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|scheduledPaymentId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the scheduled payment adhering to the standards for ID permanence|
+|nickname|string|optional|The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels|
+|payerReference|string|mandatory|The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided|
+|status|string|mandatory|Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.|
+|from|[BankingScheduledPaymentFrom](#schemacdr-banking-apibankingscheduledpaymentfrom)|mandatory|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 consistency with the to object|
+|paymentSet|[[BankingScheduledPaymentSet](#schemacdr-banking-apibankingscheduledpaymentset)]|mandatory|[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]|
+|recurrence|[BankingScheduledPaymentRecurrence](#schemacdr-banking-apibankingscheduledpaymentrecurrence)|mandatory|Object containing the detail of the schedule for the payment|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|ACTIVE|
+|status|INACTIVE|
+|status|SKIP|
+
+BankingScheduledPaymentFrom
+
+
+
+```json
+{
+ "accountId": "string"
+}
+
+```
+
+*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 consistency with the to object*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account that is the source of funds for the payment|
+
+
+BankingScheduledPaymentRecurrence
+
+
+
+```json
+{
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+}
+
+```
+
+*Object containing the detail of the schedule for the payment*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|nextPaymentDate|[DateString](#common-field-types)|optional|The date of the next payment under the recurrence schedule|
+|recurrenceUType|string|mandatory|The type of recurrence used to define the schedule|
+|onceOff|[BankingScheduledPaymentRecurrenceOnceOff](#schemacdr-banking-apibankingscheduledpaymentrecurrenceonceoff)|conditional|Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff|
+|intervalSchedule|[BankingScheduledPaymentRecurrenceIntervalSchedule](#schemacdr-banking-apibankingscheduledpaymentrecurrenceintervalschedule)|conditional|Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule|
+|lastWeekDay|[BankingScheduledPaymentRecurrenceLastWeekday](#schemacdr-banking-apibankingscheduledpaymentrecurrencelastweekday)|conditional|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 to lastWeekDay|
+|eventBased|[BankingScheduledPaymentRecurrenceEventBased](#schemacdr-banking-apibankingscheduledpaymentrecurrenceeventbased)|conditional|Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|recurrenceUType|eventBased|
+|recurrenceUType|intervalSchedule|
+|recurrenceUType|lastWeekDay|
+|recurrenceUType|onceOff|
+
+BankingScheduledPaymentRecurrenceOnceOff
+
+
+
+```json
+{
+ "paymentDate": "string"
+}
+
+```
+
+*Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|paymentDate|[DateString](#common-field-types)|mandatory|The scheduled date for the once off payment|
+
+BankingScheduledPaymentRecurrenceIntervalSchedule
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+}
+
+```
+
+*Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+|intervals|[[BankingScheduledPaymentInterval](#schemacdr-banking-apibankingscheduledpaymentinterval)]|mandatory|An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentInterval
+
+
+
+```json
+{
+ "interval": "string",
+ "dayInInterval": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|interval|[ExternalRef](#common-field-types)|mandatory|An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|dayInInterval|[ExternalRef](#common-field-types)|optional|Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.|
+
+BankingScheduledPaymentRecurrenceLastWeekday
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+}
+
+```
+
+*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 to lastWeekDay*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|interval|[ExternalRef](#common-field-types)|mandatory|The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|lastWeekDay|string|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|lastWeekDay|FRI|
+|lastWeekDay|MON|
+|lastWeekDay|SAT|
+|lastWeekDay|SUN|
+|lastWeekDay|THU|
+|lastWeekDay|TUE|
+|lastWeekDay|WED|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentRecurrenceEventBased
+
+
+
+```json
+{
+ "description": "string"
+}
+
+```
+
+*Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|description|string|mandatory|Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer|
+
+
+
+
+
+
+
+
+BankingScheduledPaymentSet
+
+
+
+```json
+{
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+}
+
+```
+
+*The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|to|[BankingScheduledPaymentTo](#schemacdr-banking-apibankingscheduledpaymentto)|mandatory|Object containing details of the destination of the payment. Used to specify a variety of payment destination types|
+|isAmountCalculated|[Boolean](#common-field-types)|optional|Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed|
+|amount|[AmountString](#common-field-types)|conditional|The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present|
+|currency|[CurrencyString](#common-field-types)|optional|The currency for the payment. AUD assumed if not present|
+
+BankingScheduledPaymentTo
+
+
+
+```json
+{
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+}
+
+```
+
+*Object containing details of the destination of the payment. Used to specify a variety of payment destination types*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|toUType|string|mandatory|The type of object provided that specifies the destination of the funds for the payment.|
+|accountId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent|
+|payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead|
+|nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.|
+|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none|
+|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none|
+|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|toUType|accountId|
+|toUType|biller|
+|toUType|domestic|
+|toUType|international|
+|toUType|payeeId|
+
+BankingDomesticPayee
+
+
+
+```json
+{
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|payeeAccountUType|string|mandatory|Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP|
+|account|[BankingDomesticPayeeAccount](#schemacdr-banking-apibankingdomesticpayeeaccount)|conditional|none|
+|card|[BankingDomesticPayeeCard](#schemacdr-banking-apibankingdomesticpayeecard)|conditional|none|
+|payId|[BankingDomesticPayeePayId](#schemacdr-banking-apibankingdomesticpayeepayid)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|payeeAccountUType|account|
+|payeeAccountUType|card|
+|payeeAccountUType|payId|
+
+
+BankingDomesticPayeeAccount
+
+
+
+```json
+{
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountName|string|optional|Name of the account to pay to|
+|bsb|string|mandatory|BSB of the account to pay to|
+|accountNumber|string|mandatory|Number of the account to pay to|
+
+BankingDomesticPayeeCard
+
+
+
+```json
+{
+ "cardNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|cardNumber|[MaskedPANString](#common-field-types)|mandatory|Name of the account to pay to|
+
+
+BankingDomesticPayeePayId
+
+
+
+```json
+{
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|name|string|optional|The name assigned to the PayID by the owner of the PayID|
+|identifier|string|mandatory|The identifier of the PayID (dependent on type)|
+|type|string|mandatory|The type of the PayID|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|type|ABN|
+|type|EMAIL|
+|type|ORG_IDENTIFIER|
+|type|TELEPHONE|
+
+
+BankingBillerPayee
+
+
+
+```json
+{
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|billerCode|string|mandatory|BPAY Biller Code of the Biller|
+|crn|string|conditional|BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.|
+|billerName|string|mandatory|Name of the Biller|
+
+BankingInternationalPayee
+
+
+
+```json
+{
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|beneficiaryDetails|object|mandatory|none|
+|» name|string|optional|Name of the beneficiary|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» message|string|optional|Response message for the payment|
+|bankDetails|object|mandatory|none|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» accountNumber|string|mandatory|Account Targeted for payment|
+|» bankAddress|object|optional|none|
+|»» name|string|mandatory|Name of the recipient Bank|
+|»» address|string|mandatory|Address of the recipient Bank|
+|» beneficiaryBankBIC|[ExternalRef](#common-field-types)|optional|Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)|
+|» fedWireNumber|string|optional|Number for Fedwire payment (Federal Reserve Wire Network)|
+|» sortCode|string|optional|Sort code used for account identification in some jurisdictions|
+|» chipNumber|string|optional|Number for the Clearing House Interbank Payments System|
+|» routingNumber|string|optional|International bank routing number|
+|» legalEntityIdentifier|[ExternalRef](#common-field-types)|optional|The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)|
+
+
+ResponseErrorListV2
+
+
+
+```json
+{
+ "errors": [
+ {
+ "code": "string",
+ "title": "string",
+ "detail": "string",
+ "meta": {
+ "urn": "string"
+ }
+ }
+ ]
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|errors|[object]|mandatory|none|
+|» code|string|mandatory|The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.|
+|» title|string|mandatory|A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.|
+|» detail|string|mandatory|A human-readable explanation specific to this occurrence of the problem.|
+|» meta|[MetaError](#schemacdr-banking-apimetaerror)|optional|Additional data for customised error codes|
+
+
+LinksPaginated
+
+
+
+```json
+{
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|self|[URIString](#common-field-types)|mandatory|Fully qualified link that generated the current response document|
+|first|[URIString](#common-field-types)|conditional|URI to the first page of this set. Mandatory if this response is not the first page|
+|prev|[URIString](#common-field-types)|conditional|URI to the previous page of this set. Mandatory if this response is not the first page|
+|next|[URIString](#common-field-types)|conditional|URI to the next page of this set. Mandatory if this response is not the last page|
+|last|[URIString](#common-field-types)|conditional|URI to the last page of this set. Mandatory if this response is not the last page|
+
+
+
+
+
+```json
+{
+ "totalRecords": 0,
+ "totalPages": 0
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|totalRecords|[NaturalNumber](#common-field-types)|mandatory|The total number of records in the full set. See [pagination](#pagination).|
+|totalPages|[NaturalNumber](#common-field-types)|mandatory|The total number of pages in the full set. See [pagination](#pagination).|
\ No newline at end of file
diff --git a/slate/source/includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html.md b/slate/source/includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html.md
new file mode 100644
index 00000000..83d1fa85
--- /dev/null
+++ b/slate/source/includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html.md
@@ -0,0 +1,1162 @@
+---
+title: Get Scheduled Payments For Specific Accounts v1
+
+#language_tabs: # must be one of https://git.io/vQNgJ
+# - shell
+# - javascript
+
+toc_footers:
+ - Consumer Data Standards
+
+search: false
+---
+
+# Get Scheduled Payments For Specific Accounts V1
+This page documents the obsolete version 1 of the Get Scheduled Payments For Specific Accounts endpoint.
+
+* Data Holder **MUST** implement Get Scheduled Payments For Specific Accounts v2 by **March 11th 2024**.
+
+This version is to be ceased to be called by data recipients by **September 9th 2024** and can be decommissioned by data holders as of that date.
+
+## Get Scheduled Payments For Specific Accounts
+
+
+
+> Code samples
+
+```http
+POST https://data.holder.com.au/cds-au/v1/banking/payments/scheduled HTTP/1.1
+Host: data.holder.com.au
+Content-Type: application/json
+Accept: application/json
+x-v: string
+x-min-v: string
+x-fapi-interaction-id: string
+x-fapi-auth-date: string
+x-fapi-customer-ip-address: string
+x-cds-client-headers: string
+
+```
+
+```javascript
+var headers = {
+ 'Content-Type':'application/json',
+ 'Accept':'application/json',
+ 'x-v':'string',
+ 'x-min-v':'string',
+ 'x-fapi-interaction-id':'string',
+ 'x-fapi-auth-date':'string',
+ 'x-fapi-customer-ip-address':'string',
+ 'x-cds-client-headers':'string'
+
+};
+
+$.ajax({
+ url: 'https://data.holder.com.au/cds-au/v1/banking/payments/scheduled',
+ method: 'post',
+
+ headers: headers,
+ success: function(data) {
+ console.log(JSON.stringify(data));
+ }
+})
+
+```
+
+`POST /banking/payments/scheduled`
+
+Obtain scheduled payments for a specified list of accounts
+
+> Body parameter
+
+```json
+{
+ "data": {
+ "accountIds": [
+ "string"
+ ]
+ },
+ "meta": {}
+}
+```
+
+###Endpoint Version
+| | |
+|---|--|
+|Version|**1**
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|page|query|[PositiveInteger](#common-field-types)|optional|Page of results to request (standard pagination)|
+|page-size|query|[PositiveInteger](#common-field-types)|optional|Page size to request. Default is 25 (standard pagination)|
+|x-v|header|string|mandatory|Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)|
+|x-min-v|header|string|optional|Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.|
+|x-fapi-interaction-id|header|string|optional|An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|x-fapi-auth-date|header|string|conditional|The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.|
+|x-fapi-customer-ip-address|header|string|optional|The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.|
+|x-cds-client-headers|header|[Base64](#common-field-types)|conditional|The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.|
+|body|body|[RequestAccountIds](#schemacdr-banking-apirequestaccountids)|mandatory|Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|[ResponseBankingScheduledPaymentsList](#schemacdr-banking-apiresponsebankingscheduledpaymentslist)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The following error codes MUST be supported:
- [400 - Invalid Field](#error-400-field-invalid)
- [400 - Invalid Page Size](#error-400-field-invalid-page-size)
- [400 - Invalid Version](#error-400-header-invalid-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|The following error codes MUST be supported:
- [406 - Unsupported Version](#error-406-header-unsupported-version)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The following error codes MUST be supported:
- [422 - Invalid Page](#error-422-field-invalid-page)
- [422 - Unavailable Banking Account](#error-422-authorisation-unavailable-banking-account)
- [422 - Invalid Banking Account](#error-422-authorisation-invalid-banking-account)
|[ResponseErrorListV2](#schemacdr-banking-apiresponseerrorlistv2)|
+
+### Response Headers
+
+|Status|Header|Type|Format|Description|
+|---|---|---|---|---|
+|200|x-v|string||The [version](#response-headers) of the API end point that the data holder has responded with.|
+|200|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|400|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|406|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+|422|x-fapi-interaction-id|string||An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.|
+
+
+
+
+
+RequestAccountIds
+
+
+
+```json
+{
+ "data": {
+ "accountIds": [
+ "string"
+ ]
+ },
+ "meta": {}
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|data|object|mandatory|none|
+|» accountIds|[string]|mandatory|none|
+|meta|[Meta](#schemacdr-banking-apimeta)|optional|none|
+
+ResponseBankingScheduledPaymentsList
+
+
+
+```json
+{
+ "data": {
+ "scheduledPayments": [
+ {
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+ }
+ ]
+ },
+ "links": {
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+ },
+ "meta": {
+ "totalRecords": 0,
+ "totalPages": 0
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|data|object|mandatory|none|
+|» scheduledPayments|[[BankingScheduledPayment](#schemacdr-banking-apibankingscheduledpayment)]|mandatory|The list of scheduled payments to return|
+|links|[LinksPaginated](#schemacdr-banking-apilinkspaginated)|mandatory|none|
+|meta|[MetaPaginated](#schemacdr-banking-apimetapaginated)|mandatory|none|
+
+BankingScheduledPayment
+
+
+
+```json
+{
+ "scheduledPaymentId": "string",
+ "nickname": "string",
+ "payerReference": "string",
+ "payeeReference": "string",
+ "status": "ACTIVE",
+ "from": {
+ "accountId": "string"
+ },
+ "paymentSet": [
+ {
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+ }
+ ],
+ "recurrence": {
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|scheduledPaymentId|[ASCIIString](#common-field-types)|mandatory|A unique ID of the scheduled payment adhering to the standards for ID permanence|
+|nickname|string|optional|The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels|
+|payerReference|string|mandatory|The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided|
+|status|string|mandatory|Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.|
+|from|[BankingScheduledPaymentFrom](#schemacdr-banking-apibankingscheduledpaymentfrom)|mandatory|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 consistency with the to object|
+|paymentSet|[[BankingScheduledPaymentSet](#schemacdr-banking-apibankingscheduledpaymentset)]|mandatory|[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]|
+|recurrence|[BankingScheduledPaymentRecurrence](#schemacdr-banking-apibankingscheduledpaymentrecurrence)|mandatory|Object containing the detail of the schedule for the payment|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|ACTIVE|
+|status|INACTIVE|
+|status|SKIP|
+
+BankingScheduledPaymentFrom
+
+
+
+```json
+{
+ "accountId": "string"
+}
+
+```
+
+*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 consistency with the to object*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountId|[ASCIIString](#common-field-types)|mandatory|ID of the account that is the source of funds for the payment|
+
+
+BankingScheduledPaymentRecurrence
+
+
+
+```json
+{
+ "nextPaymentDate": "string",
+ "recurrenceUType": "eventBased",
+ "onceOff": {
+ "paymentDate": "string"
+ },
+ "intervalSchedule": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+ },
+ "lastWeekDay": {
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+ },
+ "eventBased": {
+ "description": "string"
+ }
+}
+
+```
+
+*Object containing the detail of the schedule for the payment*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|nextPaymentDate|[DateString](#common-field-types)|optional|The date of the next payment under the recurrence schedule|
+|recurrenceUType|string|mandatory|The type of recurrence used to define the schedule|
+|onceOff|[BankingScheduledPaymentRecurrenceOnceOff](#schemacdr-banking-apibankingscheduledpaymentrecurrenceonceoff)|conditional|Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff|
+|intervalSchedule|[BankingScheduledPaymentRecurrenceIntervalSchedule](#schemacdr-banking-apibankingscheduledpaymentrecurrenceintervalschedule)|conditional|Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule|
+|lastWeekDay|[BankingScheduledPaymentRecurrenceLastWeekday](#schemacdr-banking-apibankingscheduledpaymentrecurrencelastweekday)|conditional|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 to lastWeekDay|
+|eventBased|[BankingScheduledPaymentRecurrenceEventBased](#schemacdr-banking-apibankingscheduledpaymentrecurrenceeventbased)|conditional|Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|recurrenceUType|eventBased|
+|recurrenceUType|intervalSchedule|
+|recurrenceUType|lastWeekDay|
+|recurrenceUType|onceOff|
+
+BankingScheduledPaymentRecurrenceOnceOff
+
+
+
+```json
+{
+ "paymentDate": "string"
+}
+
+```
+
+*Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|paymentDate|[DateString](#common-field-types)|mandatory|The scheduled date for the once off payment|
+
+BankingScheduledPaymentRecurrenceIntervalSchedule
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "nonBusinessDayTreatment": "AFTER",
+ "intervals": [
+ {
+ "interval": "string",
+ "dayInInterval": "string"
+ }
+ ]
+}
+
+```
+
+*Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+|intervals|[[BankingScheduledPaymentInterval](#schemacdr-banking-apibankingscheduledpaymentinterval)]|mandatory|An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentInterval
+
+
+
+```json
+{
+ "interval": "string",
+ "dayInInterval": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|interval|[ExternalRef](#common-field-types)|mandatory|An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|dayInInterval|[ExternalRef](#common-field-types)|optional|Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.|
+
+BankingScheduledPaymentRecurrenceLastWeekday
+
+
+
+```json
+{
+ "finalPaymentDate": "string",
+ "paymentsRemaining": 1,
+ "interval": "string",
+ "lastWeekDay": "FRI",
+ "nonBusinessDayTreatment": "AFTER"
+}
+
+```
+
+*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 to lastWeekDay*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|finalPaymentDate|[DateString](#common-field-types)|optional|The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|paymentsRemaining|[PositiveInteger](#common-field-types)|optional|Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely|
+|interval|[ExternalRef](#common-field-types)|mandatory|The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate|
+|lastWeekDay|string|mandatory|The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.|
+|nonBusinessDayTreatment|string|optional|Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|lastWeekDay|FRI|
+|lastWeekDay|MON|
+|lastWeekDay|SAT|
+|lastWeekDay|SUN|
+|lastWeekDay|THU|
+|lastWeekDay|TUE|
+|lastWeekDay|WED|
+|nonBusinessDayTreatment|AFTER|
+|nonBusinessDayTreatment|BEFORE|
+|nonBusinessDayTreatment|ON|
+|nonBusinessDayTreatment|ONLY|
+
+BankingScheduledPaymentRecurrenceEventBased
+
+
+
+```json
+{
+ "description": "string"
+}
+
+```
+
+*Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|description|string|mandatory|Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer|
+
+
+
+
+
+
+
+
+BankingScheduledPaymentSet
+
+
+
+```json
+{
+ "to": {
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+ },
+ "isAmountCalculated": true,
+ "amount": "string",
+ "currency": "string"
+}
+
+```
+
+*The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|to|[BankingScheduledPaymentTo](#schemacdr-banking-apibankingscheduledpaymentto)|mandatory|Object containing details of the destination of the payment. Used to specify a variety of payment destination types|
+|isAmountCalculated|[Boolean](#common-field-types)|optional|Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed|
+|amount|[AmountString](#common-field-types)|conditional|The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present|
+|currency|[CurrencyString](#common-field-types)|optional|The currency for the payment. AUD assumed if not present|
+
+BankingScheduledPaymentTo
+
+
+
+```json
+{
+ "toUType": "accountId",
+ "accountId": "string",
+ "payeeId": "string",
+ "nickname": "string",
+ "payeeReference": "string",
+ "domestic": {
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+ },
+ "biller": {
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+ },
+ "international": {
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+ }
+}
+
+```
+
+*Object containing details of the destination of the payment. Used to specify a variety of payment destination types*
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|toUType|string|mandatory|The type of object provided that specifies the destination of the funds for the payment.|
+|accountId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent|
+|payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead|
+|nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels|
+|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.|
+|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none|
+|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none|
+|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|toUType|accountId|
+|toUType|biller|
+|toUType|domestic|
+|toUType|international|
+|toUType|payeeId|
+
+BankingDomesticPayee
+
+
+
+```json
+{
+ "payeeAccountUType": "account",
+ "account": {
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+ },
+ "card": {
+ "cardNumber": "string"
+ },
+ "payId": {
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|payeeAccountUType|string|mandatory|Type of account object included. Valid values are: **account** A standard Australian account defined by BSB/Account Number. **card** A credit or charge card to pay to (note that PANs are masked). **payId** A PayID recognised by NPP|
+|account|[BankingDomesticPayeeAccount](#schemacdr-banking-apibankingdomesticpayeeaccount)|conditional|none|
+|card|[BankingDomesticPayeeCard](#schemacdr-banking-apibankingdomesticpayeecard)|conditional|none|
+|payId|[BankingDomesticPayeePayId](#schemacdr-banking-apibankingdomesticpayeepayid)|conditional|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|payeeAccountUType|account|
+|payeeAccountUType|card|
+|payeeAccountUType|payId|
+
+
+BankingDomesticPayeeAccount
+
+
+
+```json
+{
+ "accountName": "string",
+ "bsb": "string",
+ "accountNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|accountName|string|optional|Name of the account to pay to|
+|bsb|string|mandatory|BSB of the account to pay to|
+|accountNumber|string|mandatory|Number of the account to pay to|
+
+BankingDomesticPayeeCard
+
+
+
+```json
+{
+ "cardNumber": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|cardNumber|[MaskedPANString](#common-field-types)|mandatory|Name of the account to pay to|
+
+
+BankingDomesticPayeePayId
+
+
+
+```json
+{
+ "name": "string",
+ "identifier": "string",
+ "type": "ABN"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|name|string|optional|The name assigned to the PayID by the owner of the PayID|
+|identifier|string|mandatory|The identifier of the PayID (dependent on type)|
+|type|string|mandatory|The type of the PayID|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|type|ABN|
+|type|EMAIL|
+|type|ORG_IDENTIFIER|
+|type|TELEPHONE|
+
+
+BankingBillerPayee
+
+
+
+```json
+{
+ "billerCode": "string",
+ "crn": "string",
+ "billerName": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|billerCode|string|mandatory|BPAY Biller Code of the Biller|
+|crn|string|conditional|BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.|
+|billerName|string|mandatory|Name of the Biller|
+
+BankingInternationalPayee
+
+
+
+```json
+{
+ "beneficiaryDetails": {
+ "name": "string",
+ "country": "string",
+ "message": "string"
+ },
+ "bankDetails": {
+ "country": "string",
+ "accountNumber": "string",
+ "bankAddress": {
+ "name": "string",
+ "address": "string"
+ },
+ "beneficiaryBankBIC": "string",
+ "fedWireNumber": "string",
+ "sortCode": "string",
+ "chipNumber": "string",
+ "routingNumber": "string",
+ "legalEntityIdentifier": "string"
+ }
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|beneficiaryDetails|object|mandatory|none|
+|» name|string|optional|Name of the beneficiary|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» message|string|optional|Response message for the payment|
+|bankDetails|object|mandatory|none|
+|» country|[ExternalRef](#common-field-types)|mandatory|Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code|
+|» accountNumber|string|mandatory|Account Targeted for payment|
+|» bankAddress|object|optional|none|
+|»» name|string|mandatory|Name of the recipient Bank|
+|»» address|string|mandatory|Address of the recipient Bank|
+|» beneficiaryBankBIC|[ExternalRef](#common-field-types)|optional|Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)|
+|» fedWireNumber|string|optional|Number for Fedwire payment (Federal Reserve Wire Network)|
+|» sortCode|string|optional|Sort code used for account identification in some jurisdictions|
+|» chipNumber|string|optional|Number for the Clearing House Interbank Payments System|
+|» routingNumber|string|optional|International bank routing number|
+|» legalEntityIdentifier|[ExternalRef](#common-field-types)|optional|The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)|
+
+
+ResponseErrorListV2
+
+
+
+```json
+{
+ "errors": [
+ {
+ "code": "string",
+ "title": "string",
+ "detail": "string",
+ "meta": {
+ "urn": "string"
+ }
+ }
+ ]
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|errors|[object]|mandatory|none|
+|» code|string|mandatory|The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.|
+|» title|string|mandatory|A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.|
+|» detail|string|mandatory|A human-readable explanation specific to this occurrence of the problem.|
+|» meta|[MetaError](#schemacdr-banking-apimetaerror)|optional|Additional data for customised error codes|
+
+
+LinksPaginated
+
+
+
+```json
+{
+ "self": "string",
+ "first": "string",
+ "prev": "string",
+ "next": "string",
+ "last": "string"
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|self|[URIString](#common-field-types)|mandatory|Fully qualified link that generated the current response document|
+|first|[URIString](#common-field-types)|conditional|URI to the first page of this set. Mandatory if this response is not the first page|
+|prev|[URIString](#common-field-types)|conditional|URI to the previous page of this set. Mandatory if this response is not the first page|
+|next|[URIString](#common-field-types)|conditional|URI to the next page of this set. Mandatory if this response is not the last page|
+|last|[URIString](#common-field-types)|conditional|URI to the last page of this set. Mandatory if this response is not the last page|
+
+
+
+
+
+```json
+{
+ "totalRecords": 0,
+ "totalPages": 0
+}
+
+```
+
+### Properties
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|totalRecords|[NaturalNumber](#common-field-types)|mandatory|The total number of records in the full set. See [pagination](#pagination).|
+|totalPages|[NaturalNumber](#common-field-types)|mandatory|The total number of pages in the full set. See [pagination](#pagination).|
\ No newline at end of file
diff --git a/slate/source/includes/releasenotes/releasenotes.1.25.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.25.0.html.md
index 2187d7f4..4b9a01ce 100644
--- a/slate/source/includes/releasenotes/releasenotes.1.25.0.html.md
+++ b/slate/source/includes/releasenotes/releasenotes.1.25.0.html.md
@@ -21,6 +21,7 @@ This release addresses the following minor defects raised on [Standards Staging]
This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
+- [Standards Maintenance Issue 536 - Define new toUType value to relevant schemas](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/536)
- [Standards Maintenance Issue TBC - TBC](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/TBC)
- [Standards Maintenance Issue 592 - EnergyBillingDemandTransaction - timeOfUseType - New Value](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/592)
- [Standards Maintenance Issue 591 - Energy 'Get Agreed Payment Schedule' - BSB and Account Number Tokenisation/non-Tokenisation](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/591)
@@ -46,6 +47,7 @@ No Change
|Change|Description|Link|
|------|-----------|----|
+| Add `digitalWallet` to Scheduled Payments | [**Standards Maintenance #536**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/536): - Added `digitalWallet` object to `BankingScheduledPaymentToV2` structure.
- Incremented versions of Get Scheduled Payments For Account, Get Scheduled Payments Bulk and Get Scheduled Payments For Specific Accounts APIs.
- Updated description of `name` field in the `EnergyPaymentSchedule.digitalWallet` and `TelcoPaymentScheduleDigitalWallet` structures for consistency
| [Banking APIs](../../#banking-apis)[Energy APIs](../../#energy-apis)[Telco APIs](../../#telco-apis) |
| Energy APIs | [**Standards Maintenance #592**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/592): - Added `ALL_DAY` and `EXCESS` values to `EnergyBillingDemandTransaction.timeOfUseType` field. Added `ALL_DAY` value to `EnergyBillingUsageTransaction.timeOfUseType ` field.
- Incremented versions of Get Get Billing For Account, Get Bulk Billing and Get Billing For Specific Accounts APIs.
| [Energy APIs](../../#energy-apis) |
| Energy APIs | [**Standards Maintenance #591**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/591): Updated description of `EnergyPaymentSchedule.isTokenised` field to further clarify when it can be used | [Energy APIs](../../#energy-apis) |
diff --git a/slate/source/includes/swagger/cds_banking.json b/slate/source/includes/swagger/cds_banking.json
index fbbd92bc..9170ba32 100644
--- a/slate/source/includes/swagger/cds_banking.json
+++ b/slate/source/includes/swagger/cds_banking.json
@@ -5092,7 +5092,7 @@
"properties" : {
"toUType" : {
"description" : "The type of object provided that specifies the destination of the funds for the payment.",
- "enum" : [ "accountId", "biller", "domestic", "international", "payeeId" ],
+ "enum" : [ "accountId", "biller", "digitalWallet", "domestic", "international", "payeeId" ],
"type" : "string"
},
"accountId" : {
@@ -5113,6 +5113,9 @@
"description" : "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.",
"type" : "string"
},
+ "digitalWallet" : {
+ "$ref" : "#/components/schemas/BankingDigitalWalletPayee"
+ },
"domestic" : {
"$ref" : "#/components/schemas/BankingDomesticPayee"
},
@@ -5125,7 +5128,7 @@
},
"required" : [ "toUType" ],
"type" : "object",
- "x-conditional" : [ "accountId", "payeeId", "domestic", "biller", "international", "nickname", "payeeReference" ]
+ "x-conditional" : [ "accountId", "payeeId", "digitalWallet", "domestic", "biller", "international", "nickname", "payeeReference" ]
},
"BankingScheduledPaymentFrom" : {
"description" : "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 consistency with the to object",
diff --git a/slate/source/includes/swagger/cds_banking.yaml b/slate/source/includes/swagger/cds_banking.yaml
index 01833c72..8dd95765 100644
--- a/slate/source/includes/swagger/cds_banking.yaml
+++ b/slate/source/includes/swagger/cds_banking.yaml
@@ -5634,6 +5634,11 @@ components:
- beneficiaryDetails
type: object
BankingDigitalWalletPayee:
+ example:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
properties:
name:
description: The name assigned to the digital wallet by the owner of the
@@ -5818,6 +5823,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5860,6 +5870,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5932,6 +5947,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -5974,6 +5994,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6069,6 +6094,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6111,6 +6141,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6208,6 +6243,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6273,6 +6313,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -6301,6 +6346,7 @@ components:
enum:
- accountId
- biller
+ - digitalWallet
- domestic
- international
- payeeId
@@ -6329,6 +6375,8 @@ components:
not empty, it overrides the value provided at the BankingScheduledPayment
level.
type: string
+ digitalWallet:
+ $ref: '#/components/schemas/BankingDigitalWalletPayee'
domestic:
$ref: '#/components/schemas/BankingDomesticPayee'
biller:
@@ -6341,6 +6389,7 @@ components:
x-conditional:
- accountId
- payeeId
+ - digitalWallet
- domestic
- biller
- international
@@ -7494,6 +7543,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7536,6 +7590,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7608,6 +7667,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
@@ -7650,6 +7714,11 @@ components:
billerName: billerName
crn: crn
billerCode: billerCode
+ digitalWallet:
+ identifier: identifier
+ provider: PAYPAL_AU
+ name: name
+ type: EMAIL
payeeReference: payeeReference
toUType: accountId
nickname: nickname
diff --git a/swagger-gen/api/cds_banking.json b/swagger-gen/api/cds_banking.json
index 2ba10662..6d935e03 100644
--- a/swagger-gen/api/cds_banking.json
+++ b/swagger-gen/api/cds_banking.json
@@ -2009,7 +2009,7 @@
"Scheduled Payments"
],
"summary": "Get Scheduled Payments for Account",
- "description": "Obtain scheduled, outgoing payments for a specific account",
+ "description": "Obtain scheduled, outgoing payments for a specific account\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-account-v1.html)",
"operationId": "listScheduledPayments",
"parameters": [
{
@@ -2121,7 +2121,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsList"
+ "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsListV2"
}
}
}
@@ -2202,7 +2202,7 @@
"x-scopes": [
"bank:regular_payments:read"
],
- "x-version": "1"
+ "x-version": "2"
}
},
"/banking/payments/scheduled": {
@@ -2212,7 +2212,7 @@
"Scheduled Payments"
],
"summary": "Get Scheduled Payments Bulk",
- "description": "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments",
+ "description": "Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-bulk-v1.html)",
"operationId": "listScheduledPaymentsBulk",
"parameters": [
{
@@ -2359,7 +2359,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsList"
+ "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsListV2"
}
}
}
@@ -2422,7 +2422,7 @@
"x-scopes": [
"bank:regular_payments:read"
],
- "x-version": "1"
+ "x-version": "2"
},
"post": {
"tags": [
@@ -2430,7 +2430,7 @@
"Scheduled Payments"
],
"summary": "Get Scheduled Payments For Specific Accounts",
- "description": "Obtain scheduled payments for a specified list of accounts",
+ "description": "Obtain scheduled payments for a specified list of accounts\n\nObsolete versions: [v1](includes/obsolete/get-scheduled-payments-for-specific-accounts-v1.html)",
"operationId": "listScheduledPaymentsSpecificAccounts",
"parameters": [
{
@@ -2542,7 +2542,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsList"
+ "$ref": "#/components/schemas/ResponseBankingScheduledPaymentsListV2"
}
}
}
@@ -2605,7 +2605,7 @@
"x-scopes": [
"bank:regular_payments:read"
],
- "x-version": "1",
+ "x-version": "2",
"x-codegen-request-body-name": "accountIds"
}
},
@@ -5227,7 +5227,7 @@
"properties": {
"name": {
"type": "string",
- "description": "The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider"
+ "description": "The display name of the wallet as given by the customer, else a default value defined by the data holder"
},
"identifier": {
"type": "string",
@@ -5338,7 +5338,7 @@
"financialInstitution"
]
},
- "ResponseBankingScheduledPaymentsList": {
+ "ResponseBankingScheduledPaymentsListV2": {
"required": [
"data",
"links",
@@ -5356,7 +5356,7 @@
"type": "array",
"description": "The list of scheduled payments to return",
"items": {
- "$ref": "#/components/schemas/BankingScheduledPayment"
+ "$ref": "#/components/schemas/BankingScheduledPaymentV2"
}
}
}
@@ -5369,7 +5369,7 @@
}
}
},
- "BankingScheduledPayment": {
+ "BankingScheduledPaymentV2": {
"required": [
"from",
"payerReference",
@@ -5412,7 +5412,7 @@
"paymentSet": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/BankingScheduledPaymentSet"
+ "$ref": "#/components/schemas/BankingScheduledPaymentSetV2"
}
},
"recurrence": {
@@ -5423,14 +5423,14 @@
"payeeReference"
]
},
- "BankingScheduledPaymentSet": {
+ "BankingScheduledPaymentSetV2": {
"required": [
"to"
],
"type": "object",
"properties": {
"to": {
- "$ref": "#/components/schemas/BankingScheduledPaymentTo"
+ "$ref": "#/components/schemas/BankingScheduledPaymentToV2"
},
"isAmountCalculated": {
"type": "boolean",
@@ -5453,7 +5453,7 @@
"amount"
]
},
- "BankingScheduledPaymentTo": {
+ "BankingScheduledPaymentToV2": {
"required": [
"toUType"
],
@@ -5465,6 +5465,7 @@
"enum": [
"accountId",
"biller",
+ "digitalWallet",
"domestic",
"international",
"payeeId"
@@ -5488,6 +5489,9 @@
"type": "string",
"description": "The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level."
},
+ "digitalWallet": {
+ "$ref": "#/components/schemas/BankingDigitalWalletPayee"
+ },
"domestic": {
"$ref": "#/components/schemas/BankingDomesticPayee"
},
@@ -5502,6 +5506,7 @@
"x-conditional": [
"accountId",
"payeeId",
+ "digitalWallet",
"domestic",
"biller",
"international",
diff --git a/swagger-gen/api/cds_energy.json b/swagger-gen/api/cds_energy.json
index 9d6d483f..7023cbf7 100644
--- a/swagger-gen/api/cds_energy.json
+++ b/swagger-gen/api/cds_energy.json
@@ -2960,7 +2960,7 @@
"properties": {
"name": {
"type": "string",
- "description": "The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider"
+ "description": "The display name of the wallet as given by the customer, else a default value defined by the data holder"
},
"identifier": {
"type": "string",
diff --git a/swagger-gen/api/cds_telco.json b/swagger-gen/api/cds_telco.json
index af784038..42e31fae 100644
--- a/swagger-gen/api/cds_telco.json
+++ b/swagger-gen/api/cds_telco.json
@@ -3940,7 +3940,7 @@
"description": "Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet",
"properties": {
"name": {
- "description": "The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider",
+ "description": "The display name of the wallet as given by the customer, else a default value defined by the data holder",
"type": "string"
},
"identifier": {
diff --git a/swagger-gen/cds_banking.md b/swagger-gen/cds_banking.md
index 1560b220..baca122e 100644
--- a/swagger-gen/cds_banking.md
+++ b/swagger-gen/cds_banking.md
@@ -1696,6 +1696,12 @@ Obtain scheduled, outgoing payments for a specific account
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -1933,6 +1939,12 @@ Obtain scheduled payments for multiple, filtered accounts that are the source of
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -2161,6 +2173,12 @@ Obtain scheduled payments for a specified list of accounts
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -5940,6 +5958,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6065,6 +6089,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6178,6 +6208,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6250,6 +6286,12 @@ This operation does not require authentication
"payeeId": "string",
"nickname": "string",
"payeeReference": "string",
+ "digitalWallet": {
+ "name": "string",
+ "identifier": "string",
+ "type": "EMAIL",
+ "provider": "PAYPAL_AU"
+ },
"domestic": {
"payeeAccountUType": "account",
"account": {
@@ -6307,6 +6349,7 @@ This operation does not require authentication
|payeeId|[ASCIIString](#common-field-types)|conditional|Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead|
|nickname|string|conditional|The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels|
|payeeReference|string|conditional|The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.|
+|digitalWallet|[BankingDigitalWalletPayee](#schemacdr-banking-apibankingdigitalwalletpayee)|conditional|none|
|domestic|[BankingDomesticPayee](#schemacdr-banking-apibankingdomesticpayee)|conditional|none|
|biller|[BankingBillerPayee](#schemacdr-banking-apibankingbillerpayee)|conditional|none|
|international|[BankingInternationalPayee](#schemacdr-banking-apibankinginternationalpayee)|conditional|none|
@@ -6317,6 +6360,7 @@ This operation does not require authentication
|---|---|
|toUType|accountId|
|toUType|biller|
+|toUType|digitalWallet|
|toUType|domestic|
|toUType|international|
|toUType|payeeId|