openapi: 3.0.3
info:
contact:
email: contact@dsb.gov.au
name: Data Standards Body
url: https://dsb.gov.au/
description: Specifications for resource endpoints applicable to data holders in the Banking sector.
license:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Banking Accounts Scheduled Payments API
version: 1.36.0
servers:
- description: MTLS
url: https://mtls.dh.example.com/cds-au/v1
tags:
- name: Scheduled Payments
paths:
/banking/accounts/{accountId}/payments/scheduled:
get:
tags:
- Scheduled Payments
summary: Get Scheduled Payments for Account
description: Obtain scheduled, outgoing payments for a specific account
operationId: listScheduledPayments
parameters:
- name: accountId
in: path
description: 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
required: true
schema:
type: string
x-cds-type: ASCIIString
x-cds-type: ASCIIString
- name: page
in: query
description: Page of results to request (standard pagination)
schema:
type: integer
default: 1
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: page-size
in: query
description: Page size to request. Default is 25 (standard pagination)
schema:
type: integer
default: 25
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: x-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers)
required: true
schema:
type: string
default: '2'
- name: x-min-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
schema:
type: string
- name: x-fapi-interaction-id
in: header
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
format: uuid
- name: x-fapi-auth-date
in: header
description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
schema:
type: string
- name: x-fapi-customer-ip-address
in: header
description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
schema:
type: string
- name: x-cds-client-headers
in: header
description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
schema:
pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
type: string
x-cds-type: Base64
x-cds-type: Base64
responses:
'200':
description: Success
headers:
x-v:
description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
schema:
type: string
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
'400':
description: Bad Request
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'404':
description: Not Found
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'422':
description: Unprocessable Entity
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
security:
- PSUOAuth2Security:
- bank:regular_payments:read
- default:
- bank:regular_payments:read
x-version: '1'
x-auth-type: Application User
x-throttling-tier: Unlimited
/banking/payments/scheduled:
get:
tags:
- Scheduled Payments
summary: Get Scheduled Payments Bulk
description: Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
operationId: listScheduledPaymentsBulk
parameters:
- name: product-category
in: query
description: 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.
schema:
type: string
enum:
- TRANS_AND_SAVINGS_ACCOUNTS
- TERM_DEPOSITS
- TRAVEL_CARDS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- CRED_AND_CHRG_CARDS
- PERS_LOANS
- MARGIN_LOANS
- LEASES
- TRADE_FINANCE
- OVERDRAFTS
- BUSINESS_LOANS
- name: open-status
in: query
description: Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
schema:
type: string
default: ALL
enum:
- OPEN
- CLOSED
- ALL
- name: is-owned
in: query
description: 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
schema:
type: boolean
x-cds-type: Boolean
x-cds-type: Boolean
- name: page
in: query
description: Page of results to request (standard pagination)
schema:
type: integer
default: 1
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: page-size
in: query
description: Page size to request. Default is 25 (standard pagination)
schema:
type: integer
default: 25
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: x-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
required: true
schema:
type: string
default: '2'
- name: x-min-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
schema:
type: string
- name: x-fapi-interaction-id
in: header
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
format: uuid
- name: x-fapi-auth-date
in: header
description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
schema:
type: string
- name: x-fapi-customer-ip-address
in: header
description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
schema:
type: string
- name: x-cds-client-headers
in: header
description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
schema:
pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
type: string
x-cds-type: Base64
x-cds-type: Base64
responses:
'200':
description: Success
headers:
x-v:
description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
schema:
type: string
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
'400':
description: Bad Request
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'422':
description: Unprocessable Entity
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
security:
- PSUOAuth2Security:
- bank:regular_payments:read
- default:
- bank:regular_payments:read
x-version: '1'
x-auth-type: Application User
x-throttling-tier: Unlimited
post:
tags:
- Scheduled Payments
summary: Get Scheduled Payments For Specific Accounts
description: Obtain scheduled payments for a specified list of accounts
operationId: listScheduledPaymentsSpecificAccounts
parameters:
- name: page
in: query
description: Page of results to request (standard pagination)
schema:
type: integer
default: 1
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: page-size
in: query
description: Page size to request. Default is 25 (standard pagination)
schema:
type: integer
default: 25
x-cds-type: PositiveInteger
x-cds-type: PositiveInteger
- name: x-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If the value of [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) is equal to or higher than the value of [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) then the [x-min-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](https://consumerdatastandardsaustralia.github.io/standards/#http-headers )
required: true
schema:
type: string
default: '2'
- name: x-min-v
in: header
description: 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](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ) and [x-v](https://consumerdatastandardsaustralia.github.io/standards/#http-headers ). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.
schema:
type: string
- name: x-fapi-interaction-id
in: header
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
format: uuid
- name: x-fapi-auth-date
in: header
description: The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.
schema:
type: string
- name: x-fapi-customer-ip-address
in: header
description: The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
schema:
type: string
- name: x-cds-client-headers
in: header
description: The customer's original standard http headers [Base64](https://consumerdatastandardsaustralia.github.io/standards/#common-field-types) encoded, including the original User Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
schema:
pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
type: string
x-cds-type: Base64
x-cds-type: Base64
requestBody:
description: Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequestAccountIds'
required: true
responses:
'200':
description: Success
headers:
x-v:
description: The [version](https://consumerdatastandardsaustralia.github.io/standards/#http-headers) of the API end point that the data holder has responded with.
schema:
type: string
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
'400':
description: Bad Request
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
'422':
description: Unprocessable Entity
headers:
x-fapi-interaction-id:
description: An [RFC4122](https://tools.ietf.org/html/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] UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
security:
- PSUOAuth2Security:
- bank:regular_payments:read
- default:
- bank:regular_payments:read
x-version: '1'
x-auth-type: Application User
x-throttling-tier: Unlimited
x-codegen-request-body-name: accountIds
components:
schemas:
ResponseErrorList:
required:
- errors
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/ResponseErrorList_errors'
BankingInternationalPayee_bankDetails:
required:
- accountNumber
- country
type: object
properties:
country:
type: string
description: Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code
x-cds-type: ExternalRef
accountNumber:
type: string
description: Account Targeted for payment
bankAddress:
$ref: '#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress'
beneficiaryBankBIC:
type: string
description: Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)
x-cds-type: ExternalRef
fedWireNumber:
type: string
description: Number for Fedwire payment (Federal Reserve Wire Network)
sortCode:
type: string
description: Sort code used for account identification in some jurisdictions
chipNumber:
type: string
description: Number for the Clearing House Interbank Payments System
routingNumber:
type: string
description: International bank routing number
legalEntityIdentifier:
type: string
description: The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html)
x-cds-type: ExternalRef
BankingInternationalPayee_bankDetails_bankAddress:
required:
- address
- name
type: object
properties:
name:
type: string
description: Name of the recipient Bank
address:
type: string
description: Address of the recipient Bank
ResponseBankingScheduledPaymentsList_data:
required:
- scheduledPayments
type: object
properties:
scheduledPayments:
type: array
description: The list of scheduled payments to return
items:
$ref: '#/components/schemas/BankingScheduledPayment'
BankingDomesticPayeeCard:
required:
- cardNumber
type: object
properties:
cardNumber:
type: string
description: Name of the account to pay to
x-cds-type: MaskedPANString
BankingScheduledPaymentRecurrenceOnceOff:
required:
- paymentDate
type: object
properties:
paymentDate:
type: string
description: The scheduled date for the once off payment
x-cds-type: DateString
description: Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
BankingScheduledPaymentRecurrenceEventBased:
required:
- description
type: object
properties:
description:
type: string
description: Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
description: Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
LinksPaginated:
required:
- self
type: object
properties:
self:
type: string
description: Fully qualified link that generated the current response document
x-cds-type: URIString
first:
type: string
description: URI to the first page of this set. Mandatory if this response is not the first page
x-cds-type: URIString
prev:
type: string
description: URI to the previous page of this set. Mandatory if this response is not the first page
x-cds-type: URIString
next:
type: string
description: URI to the next page of this set. Mandatory if this response is not the last page
x-cds-type: URIString
last:
type: string
description: URI to the last page of this set. Mandatory if this response is not the last page
x-cds-type: URIString
x-conditional:
- prev
- next
- first
- last
BankingScheduledPaymentFrom:
required:
- accountId
type: object
properties:
accountId:
type: string
description: ID of the account that is the source of funds for the payment
x-cds-type: ASCIIString
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
BankingScheduledPaymentSet:
required:
- to
type: object
properties:
to:
$ref: '#/components/schemas/BankingScheduledPaymentTo'
isAmountCalculated:
type: boolean
description: 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
x-cds-type: Boolean
amount:
type: string
description: The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
x-cds-type: AmountString
currency:
type: string
description: The currency for the payment. AUD assumed if not present
x-cds-type: CurrencyString
description: 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
x-conditional:
- amount
BankingScheduledPaymentRecurrenceIntervalSchedule:
required:
- intervals
type: object
properties:
finalPaymentDate:
type: string
description: 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
x-cds-type: DateString
paymentsRemaining:
type: integer
description: 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
x-cds-type: PositiveInteger
nonBusinessDayTreatment:
type: string
description: 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
default: 'ON'
enum:
- AFTER
- BEFORE
- 'ON'
- ONLY
intervals:
type: array
description: 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
items:
$ref: '#/components/schemas/BankingScheduledPaymentInterval'
description: Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
RequestAccountIds:
required:
- data
type: object
properties:
data:
$ref: '#/components/schemas/RequestAccountIds_data'
meta:
$ref: '#/components/schemas/Meta'
Meta:
type: object
BankingScheduledPaymentRecurrenceLastWeekday:
required:
- interval
- lastWeekDay
type: object
properties:
finalPaymentDate:
type: string
description: 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
x-cds-type: DateString
paymentsRemaining:
type: integer
description: 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
x-cds-type: PositiveInteger
interval:
type: string
description: 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
x-cds-type: ExternalRef
lastWeekDay:
type: string
description: The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
enum:
- MON
- TUE
- WED
- THU
- FRI
- SAT
- SUN
nonBusinessDayTreatment:
type: string
description: 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
default: 'ON'
enum:
- AFTER
- BEFORE
- 'ON'
- ONLY
description: 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
BankingScheduledPaymentInterval:
required:
- interval
type: object
properties:
interval:
type: string
description: 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
x-cds-type: ExternalRef
dayInInterval:
type: string
description: 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.
x-cds-type: ExternalRef
BankingScheduledPayment:
required:
- from
- payeeReference
- payerReference
- paymentSet
- recurrence
- scheduledPaymentId
- status
type: object
properties:
scheduledPaymentId:
type: string
description: A unique ID of the scheduled payment adhering to the standards for ID permanence
x-cds-type: ASCIIString
nickname:
type: string
description: The short display name of the payee as provided by the customer
payerReference:
type: string
description: The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer account. Empty string if no data provided
payeeReference:
type: string
description: The reference for the transaction that will be provided by the originating institution. Empty string if no data provided
status:
type: string
description: 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.
enum:
- ACTIVE
- SKIP
- INACTIVE
from:
$ref: '#/components/schemas/BankingScheduledPaymentFrom'
paymentSet:
type: array
items:
$ref: '#/components/schemas/BankingScheduledPaymentSet'
recurrence:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrence'
ResponseBankingScheduledPaymentsList:
required:
- data
- links
- meta
type: object
properties:
data:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
BankingDomesticPayeeAccount:
required:
- accountNumber
- bsb
type: object
properties:
accountName:
type: string
description: Name of the account to pay to
bsb:
type: string
description: BSB of the account to pay to
accountNumber:
type: string
description: Number of the account to pay to
MetaPaginated:
required:
- totalPages
- totalRecords
type: object
properties:
totalRecords:
type: integer
description: The total number of records in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
x-cds-type: NaturalNumber
totalPages:
type: integer
description: The total number of pages in the full set. See [pagination](https://consumerdatastandardsaustralia.github.io/standards/#pagination).
x-cds-type: NaturalNumber
ResponseErrorList_errors:
required:
- code
- detail
- title
type: object
properties:
code:
type: string
description: Error code
title:
type: string
description: Error title
detail:
type: string
description: Error details
meta:
type: object
properties: {}
description: Optional additional data for specific error types
BankingBillerPayee:
required:
- billerCode
- billerName
type: object
properties:
billerCode:
type: string
description: BPAY Biller Code of the Biller
crn:
type: string
description: BPAY CRN of the Biller. If the contents of the CRN match the format of a Credit Card PAN then it should be masked using the rules applicable for the MaskedPANString common type
billerName:
type: string
description: Name of the Biller
x-conditional:
- crn
BankingScheduledPaymentRecurrence:
required:
- recurrenceUType
type: object
properties:
nextPaymentDate:
type: string
description: The date of the next payment under the recurrence schedule
x-cds-type: DateString
recurrenceUType:
type: string
description: The type of recurrence used to define the schedule
enum:
- onceOff
- intervalSchedule
- lastWeekDay
- eventBased
onceOff:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff'
intervalSchedule:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule'
lastWeekDay:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday'
eventBased:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceEventBased'
description: Object containing the detail of the schedule for the payment
x-conditional:
- onceOff
- intervalSchedule
- lastWeekDay
- eventBased
BankingInternationalPayee_beneficiaryDetails:
required:
- country
type: object
properties:
name:
type: string
description: Name of the beneficiary
country:
type: string
description: Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code
x-cds-type: ExternalRef
message:
type: string
description: Response message for the payment
BankingDomesticPayeePayId:
required:
- identifier
- type
type: object
properties:
name:
type: string
description: The name assigned to the PayID by the owner of the PayID
identifier:
type: string
description: The identifier of the PayID (dependent on type)
type:
type: string
description: The type of the PayID
enum:
- EMAIL
- TELEPHONE
- ABN
- ORG_IDENTIFIER
BankingDomesticPayee:
required:
- payeeAccountUType
type: object
properties:
payeeAccountUType:
type: string
description: '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'
enum:
- account
- card
- payId
account:
$ref: '#/components/schemas/BankingDomesticPayeeAccount'
card:
$ref: '#/components/schemas/BankingDomesticPayeeCard'
payId:
$ref: '#/components/schemas/BankingDomesticPayeePayId'
x-conditional:
- account
- card
- payId
RequestAccountIds_data:
required:
- accountIds
type: object
properties:
accountIds:
type: array
items:
type: string
description: Array of specific accountIds to obtain authorisations for
x-cds-type: ASCIIString
BankingScheduledPaymentTo:
required:
- toUType
type: object
properties:
toUType:
type: string
description: The type of object provided that specifies the destination of the funds for the payment.
enum:
- accountId
- payeeId
- domestic
- biller
- international
accountId:
type: string
description: Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
x-cds-type: ASCIIString
payeeId:
type: string
description: 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
x-cds-type: ASCIIString
domestic:
$ref: '#/components/schemas/BankingDomesticPayee'
biller:
$ref: '#/components/schemas/BankingBillerPayee'
international:
$ref: '#/components/schemas/BankingInternationalPayee'
description: Object containing details of the destination of the payment. Used to specify a variety of payment destination types
x-conditional:
- accountId
- payeeId
- domestic
- biller
- international
BankingInternationalPayee:
required:
- bankDetails
- beneficiaryDetails
type: object
properties:
beneficiaryDetails:
$ref: '#/components/schemas/BankingInternationalPayee_beneficiaryDetails'
bankDetails:
$ref: '#/components/schemas/BankingInternationalPayee_bankDetails'