openapi: 3.0.3
info:
contact:
email: contact@consumerdatastandards.gov.au
name: Consumer Data Standards
url: https://consumerdatastandards.gov.au
description: Consumer Data Standards APIs created by the Data Standards Body (DSB),
with the Data Standards Chair as the decision maker to meet the needs of the Consumer
Data Right
license:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Banking API
version: 1.23.0
servers:
- url: https://data.holder.com.au/cds-au/v1
paths:
/banking/accounts:
get:
description: |-
Obtain a list of accounts.
Obsolete versions: [v1](includes/obsolete/get-accounts-v1.html)
operationId: listAccounts
parameters:
- 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.)
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
- description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- 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
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
x-cds-type: Boolean
style: form
x-cds-type: Boolean
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountListV2'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Accounts
tags:
- Banking
- Accounts
x-scopes:
- bank:accounts.basic:read
x-version: "2"
/banking/accounts/balances:
get:
description: Obtain balances for multiple, filtered accounts
operationId: listBalancesBulk
parameters:
- 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.
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
- description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- 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
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
x-cds-type: Boolean
style: form
x-cds-type: Boolean
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Bulk Balances
tags:
- Banking
- Accounts
x-scopes:
- bank:accounts.basic:read
x-version: "1"
post:
description: Obtain balances for a specified list of accounts
operationId: listBalancesSpecificAccounts
parameters:
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestAccountIds'
description: The list of account IDs to obtain balances for
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountsBalanceList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Balances For Specific Accounts
tags:
- Banking
- Accounts
x-scopes:
- bank:accounts.basic:read
x-version: "1"
x-codegen-request-body-name: accountIds
/banking/accounts/{accountId}/balance:
get:
description: Obtain the balance for a single specified account
operationId: getBalance
parameters:
- description: ID of the specific account requested
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountsBalanceById'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Account Balance
tags:
- Banking
- Accounts
x-scopes:
- bank:accounts.basic:read
x-version: "1"
/banking/accounts/{accountId}:
get:
description: |-
Obtain detailed information on a single account.
Obsolete versions: [v1](includes/obsolete/get-account-detail-v1.html), [v2](includes/obsolete/get-account-detail-v2.html)
operationId: getAccountDetail
parameters:
- description: A tokenised identifier for the account which is unique but not
shareable
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountByIdV3'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Account Detail
tags:
- Banking
- Accounts
x-scopes:
- bank:accounts.detail:read
x-version: "3"
/banking/accounts/{accountId}/transactions:
get:
description: |-
Obtain transactions for a specific account.
Some general notes that apply to all end points that retrieve transactions:
- Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
- As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:
- Posted date/time if available, then
- Execution date/time if available, then
- A reasonable date/time nominated by the data holder using internal data structures
- For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
- For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information accross the subsidiary transactions as possible, is required to be shared
operationId: getTransactions
parameters:
- description: ID of the account to get transactions for. Must have previously
been returned by one of the account list end points.
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- description: Constrain the transaction history request to transactions with
effective time at or after this date/time. If absent defaults to newest-time
minus 90 days. Format is aligned to DateTimeString common type
explode: true
in: query
name: oldest-time
required: false
schema:
type: string
x-cds-type: DateTimeString
style: form
x-cds-type: DateTimeString
- description: Constrain the transaction history request to transactions with
effective time at or before this date/time. If absent defaults to today. Format
is aligned to DateTimeString common type
explode: true
in: query
name: newest-time
required: false
schema:
type: string
x-cds-type: DateTimeString
style: form
x-cds-type: DateTimeString
- description: Filter transactions to only transactions with amounts higher
or equal to than this amount
explode: true
in: query
name: min-amount
required: false
schema:
type: string
x-cds-type: AmountString
style: form
x-cds-type: AmountString
- description: Filter transactions to only transactions with amounts less than
or equal to than this amount
explode: true
in: query
name: max-amount
required: false
schema:
type: string
x-cds-type: AmountString
style: form
x-cds-type: AmountString
- description: Filter transactions to only transactions where this string value
is found as a substring of either the reference or description fields. Format
is arbitrary ASCII string. This parameter is optionally implemented by data
holders. If it is not implemented then a response should be provided as
normal without text filtering applied and an additional boolean field named
isQueryParamUnsupported should be included in the meta object and set to
true (whether the text parameter is supplied or not)
explode: true
in: query
name: text
required: false
schema:
type: string
style: form
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactionList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
- [400
- Invalid Date](#error-400-field-invalid-date-time)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Transactions For Account
tags:
- Banking
- Accounts
x-scopes:
- bank:transactions:read
x-version: "1"
/banking/accounts/{accountId}/transactions/{transactionId}:
get:
description: Obtain detailed information on a transaction for a specific account
operationId: getTransactionDetail
parameters:
- description: ID of the account to get transactions for. Must have previously
been returned by one of the account list end points
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- description: ID of the transaction obtained from a previous call to one of
the other transaction end points
explode: false
in: path
name: transactionId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingTransactionById'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
- [400
- Invalid Date](#error-400-field-invalid-date-time)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
- [404
- Unavailable Resource](#error-404-resource-unavailable)
- [404
- Invalid Resource](#error-404-resource-invalid)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Transaction Detail
tags:
- Banking
- Accounts
x-scopes:
- bank:transactions:read
x-version: "1"
/banking/accounts/{accountId}/direct-debits:
get:
description: Obtain direct debit authorisations for a specific account
operationId: listDirectDebits
parameters:
- description: ID of the account to get direct debit authorisations for. Must
have previously been returned by one of the account list end points.
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Direct Debits For Account
tags:
- Banking
- Direct Debits
x-scopes:
- bank:regular_payments:read
x-version: "1"
/banking/accounts/direct-debits:
get:
description: Obtain direct debit authorisations for multiple, filtered accounts
operationId: listDirectDebitsBulk
parameters:
- 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.
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
- description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- 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
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
x-cds-type: Boolean
style: form
x-cds-type: Boolean
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Bulk Direct Debits
tags:
- Banking
- Direct Debits
x-scopes:
- bank:regular_payments:read
x-version: "1"
post:
description: Obtain direct debit authorisations for a specified list of accounts
operationId: listDirectDebitsSpecificAccounts
parameters:
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestAccountIds'
description: Array of specific accountIds to obtain authorisations for
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Direct Debits For Specific Accounts
tags:
- Banking
- Direct Debits
x-scopes:
- bank:regular_payments:read
x-version: "1"
x-codegen-request-body-name: accountIds
/banking/accounts/{accountId}/payments/scheduled:
get:
description: Obtain scheduled, outgoing payments for a specific account
operationId: listScheduledPayments
parameters:
- 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
explode: false
in: path
name: accountId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Scheduled Payments for Account
tags:
- Banking
- Scheduled Payments
x-scopes:
- bank:regular_payments:read
x-version: "1"
/banking/payments/scheduled:
get:
description: Obtain scheduled payments for multiple, filtered accounts that
are the source of funds for the payments
operationId: listScheduledPaymentsBulk
parameters:
- 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.
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
- description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- 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
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
x-cds-type: Boolean
style: form
x-cds-type: Boolean
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Scheduled Payments Bulk
tags:
- Banking
- Scheduled Payments
x-scopes:
- bank:regular_payments:read
x-version: "1"
post:
description: Obtain scheduled payments for a specified list of accounts
operationId: listScheduledPaymentsSpecificAccounts
parameters:
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestAccountIds'
description: Array of specific accountIds to obtain scheduled payments for. The
accounts specified are the source of funds for the payments returned
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Scheduled Payments For Specific Accounts
tags:
- Banking
- Scheduled Payments
x-scopes:
- bank:regular_payments:read
x-version: "1"
x-codegen-request-body-name: accountIds
/banking/payees:
get:
description: |-
Obtain a list of pre-registered payees.
Obsolete versions: [v1](includes/obsolete/get-payees-v1.html)
operationId: listPayees
parameters:
- description: Filter on the payee type field. In addition to normal type field
values, ALL can be specified to retrieve all payees. If absent the assumed
value is ALL
explode: true
in: query
name: type
required: false
schema:
default: ALL
enum:
- ALL
- BILLER
- DIGITAL_WALLET
- DOMESTIC
- INTERNATIONAL
type: string
style: form
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingPayeeListV2'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Payees
tags:
- Banking
- Payees
x-scopes:
- bank:payees:read
x-version: "2"
/banking/payees/{payeeId}:
get:
description: |-
Obtain detailed information on a single payee.
Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient.
Obsolete versions: [v1](includes/obsolete/get-payee-detail-v1.html)
operationId: getPayeeDetail
parameters:
- description: The ID used to locate the details of a particular payee
explode: false
in: path
name: payeeId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
- description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingPayeeByIdV2'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: 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)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [404
- Unavailable Resource](#error-404-resource-unavailable)
- [404
- Invalid Resource](#error-404-resource-invalid)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
headers:
x-fapi-interaction-id:
description: 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.
explode: false
schema:
type: string
style: simple
summary: Get Payee Detail
tags:
- Banking
- Payees
x-scopes:
- bank:payees:read
x-version: "2"
/banking/products:
get:
description: |-
Obtain a list of products that are currently openly offered to the market
Note that the results returned by this end point are expected to be ordered in descending order according to ``lastUpdated``.
### Conventions
In the product reference payloads there are a number of recurring conventions that are explained here, in one place.
#### Arrays Of Features
In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:
- Each element in an array has the same structure so that clients can reliably interpret the payloads
- Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.
- Each element has a field name [additionalValue](#productfeaturetypedoc). This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the ADDITIONAL_CARDS feature is the number of cards allowed while the contents of this field for the MAX_LIMIT constraint would be the maximum credit limit allowed for the product.
- An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.
- An element in these arrays may contain an additionalInfo and additionalInfoUri field. The additionalInfo field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The additionalInfoUri provides a link to externally hosted information specifically relevant to that feature of the product.
- Depending on the type of data being represented there may be additional specific fields.
#### URIs To More Information
As the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.
These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use difference HTML anchors to focus on a specific topic such as eligibility or fees.
#### Linkage To Accounts
From the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge. Rates and features of the product may change and a discount may be negotiated for the account.
For this reason, while productCategory is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.
Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actual has been instantiated and created along with the associated decisions inherent in that process.
#### Dates
It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.
In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.
Obsolete versions: [v1](includes/obsolete/get-products-v1.html) [v2](includes/obsolete/get-products-v2.html)
operationId: listProducts
parameters:
- description: Allows for the filtering of products based on whether the current
time is within the period of time defined as effective by the effectiveFrom
and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’.
If absent defaults to 'CURRENT'
explode: true
in: query
name: effective
required: false
schema:
default: CURRENT
enum:
- ALL
- CURRENT
- FUTURE
type: string
style: form
- description: Only include products that have been updated after the specified
date and time. If absent defaults to include all products
explode: true
in: query
name: updated-since
required: false
schema:
type: string
x-cds-type: DateTimeString
style: form
x-cds-type: DateTimeString
- description: Filter results based on a specific brand
explode: true
in: query
name: brand
required: false
schema:
type: string
style: form
- 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.
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
- description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingProductListV2'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Invalid Date](#error-400-field-invalid-date-time)
- [400
- Invalid Page Size](#error-400-field-invalid-page-size)
- [400
- Invalid Version](#error-400-header-invalid-version)
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
"422":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [422
- Invalid Page](#error-422-field-invalid-page)
summary: Get Products
tags:
- Banking
- Products
x-version: "3"
/banking/products/{productId}:
get:
description: |-
Obtain detailed information on a single product offered openly to the market.
Obsolete versions: [v1](includes/obsolete/get-product-detail-v1.html) [v2](includes/obsolete/get-product-detail-v2.html) [v3](includes/obsolete/get-product-detail-v3.html)
operationId: getProductDetail
parameters:
- description: ID of the specific product requested
explode: false
in: path
name: productId
required: true
schema:
type: string
x-cds-type: ASCIIString
style: simple
x-cds-type: ASCIIString
- 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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingProductByIdV4'
description: Success
headers:
x-v:
description: The [version](#response-headers) of the API end point that
the data holder has responded with.
explode: false
schema:
type: string
style: simple
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [400
- Invalid Field](#error-400-field-invalid)
- [400 - Invalid Version](#error-400-header-invalid-version)
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [404
- Unavailable Resource](#error-404-resource-unavailable)
- [404
- Invalid Resource](#error-404-resource-invalid)
"406":
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
description: The following error codes MUST be supported:
- [406
- Unsupported Version](#error-406-header-unsupported-version)
summary: Get Product Detail
tags:
- Banking
- Products
x-version: "4"
components:
parameters:
RequestHeader_x-v:
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](#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)
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
RequestHeader_x-min-v:
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](#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.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
RequestHeader_x-fapi-interaction-id:
description: 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.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
RequestHeader_x-fapi-auth-date:
description: 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.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
x-conditional: true
style: simple
x-conditional: true
RequestHeader_x-fapi-customer-ip-address:
description: 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.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
RequestHeader_x-cds-client-headers:
description: 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.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
x-conditional: true
x-cds-type: Base64
style: simple
x-conditional: true
x-cds-type: Base64
ParamAccountOpenStatus:
description: Used to filter results according to open/closed status. Values
can be OPEN, CLOSED or ALL. If absent then ALL is assumed
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
ParamProductCategory:
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.
explode: true
in: query
name: product-category
required: false
schema:
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
style: form
ParamAccountIsOwned:
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
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
x-cds-type: Boolean
style: form
x-cds-type: Boolean
ParamPage:
description: Page of results to request (standard pagination)
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
ParamPageSize:
description: Page size to request. Default is 25 (standard pagination)
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
x-cds-type: PositiveInteger
style: form
x-cds-type: PositiveInteger
ParamTransactionNewestTime:
description: Constrain the transaction history request to transactions with
effective time at or before this date/time. If absent defaults to today. Format
is aligned to DateTimeString common type
explode: true
in: query
name: newest-time
required: false
schema:
type: string
x-cds-type: DateTimeString
style: form
x-cds-type: DateTimeString
ParamTransactionOldestTime:
description: Constrain the transaction history request to transactions with
effective time at or after this date/time. If absent defaults to newest-time
minus 90 days. Format is aligned to DateTimeString common type
explode: true
in: query
name: oldest-time
required: false
schema:
type: string
x-cds-type: DateTimeString
style: form
x-cds-type: DateTimeString
ParamTransactionMinAmount:
description: Filter transactions to only transactions with amounts higher or
equal to than this amount
explode: true
in: query
name: min-amount
required: false
schema:
type: string
x-cds-type: AmountString
style: form
x-cds-type: AmountString
ParamTransactionMaxAmount:
description: Filter transactions to only transactions with amounts less than
or equal to than this amount
explode: true
in: query
name: max-amount
required: false
schema:
type: string
x-cds-type: AmountString
style: form
x-cds-type: AmountString
ParamTransactionText:
description: Filter transactions to only transactions where this string value
is found as a substring of either the reference or description fields. Format
is arbitrary ASCII string. This parameter is optionally implemented by data
holders. If it is not implemented then a response should be provided as normal
without text filtering applied and an additional boolean field named isQueryParamUnsupported
should be included in the meta object and set to true (whether the text parameter
is supplied or not)
explode: true
in: query
name: text
required: false
schema:
type: string
style: form
schemas:
RequestAccountIds:
example:
data:
accountIds:
- accountIds
- accountIds
meta: '{}'
properties:
data:
$ref: '#/components/schemas/RequestAccountIds_data'
meta:
type: object
required:
- data
type: object
ResponseBankingProductListV2:
example:
data:
products:
- additionalInformation:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
brandName: brandName
productId: productId
description: description
effectiveTo: effectiveTo
cardArt:
- imageUri: imageUri
title: title
- imageUri: imageUri
title: title
lastUpdated: lastUpdated
isTailored: true
name: name
applicationUri: applicationUri
effectiveFrom: effectiveFrom
brand: brand
- additionalInformation:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
brandName: brandName
productId: productId
description: description
effectiveTo: effectiveTo
cardArt:
- imageUri: imageUri
title: title
- imageUri: imageUri
title: title
lastUpdated: lastUpdated
isTailored: true
name: name
applicationUri: applicationUri
effectiveFrom: effectiveFrom
brand: brand
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingProductListV2_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
BankingProductV4:
example:
additionalInformation:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
brandName: brandName
productId: productId
description: description
effectiveTo: effectiveTo
cardArt:
- imageUri: imageUri
title: title
- imageUri: imageUri
title: title
lastUpdated: lastUpdated
isTailored: true
name: name
applicationUri: applicationUri
effectiveFrom: effectiveFrom
brand: brand
properties:
productId:
description: A data holder specific unique identifier for this product.
This identifier must be unique to a product but does not otherwise need
to adhere to ID permanence guidelines.
type: string
x-cds-type: ASCIIString
effectiveFrom:
description: The date and time from which this product is effective (ie.
is available for origination). Used to enable the articulation of products
to the regime before they are available for customers to originate
type: string
x-cds-type: DateTimeString
effectiveTo:
description: The date and time at which this product will be retired and
will no longer be offered. Used to enable the managed deprecation of
products
type: string
x-cds-type: DateTimeString
lastUpdated:
description: The last date and time that the information for this product
was changed (or the creation date for the product if it has never been
altered)
type: string
x-cds-type: DateTimeString
productCategory:
$ref: '#/components/schemas/BankingProductCategory'
name:
description: The display name of the product
type: string
description:
description: A description of the product
type: string
brand:
description: A label of the brand for the product. Able to be used for filtering.
For data holders with single brands this value is still required
type: string
brandName:
description: An optional display name of the brand
type: string
applicationUri:
description: A link to an application web page where this product can be
applied for.
type: string
x-cds-type: URIString
isTailored:
description: Indicates whether the product is specifically tailored to a
circumstance. In this case fees and prices are significantly negotiated
depending on context. While all products are open to a degree of tailoring
this flag indicates that tailoring is expected and thus that the provision
of specific fees and rates is not applicable
type: boolean
x-cds-type: Boolean
additionalInformation:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2'
cardArt:
description: An array of card art images
items:
$ref: '#/components/schemas/BankingProductV4_cardArt'
type: array
required:
- brand
- description
- isTailored
- lastUpdated
- name
- productCategory
- productId
type: object
BankingProductAdditionalInformationV2:
description: Object that contains links to additional information on specific
topics
example:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
properties:
overviewUri:
description: General overview of the product. Mandatory if `additionalOverviewUris`
includes one or more supporting documents.
type: string
x-cds-type: URIString
termsUri:
description: Terms and conditions for the product. Mandatory if `additionalTermsUris`
includes one or more supporting documents.
type: string
x-cds-type: URIString
eligibilityUri:
description: Eligibility rules and criteria for the product. Mandatory if
`additionalEligibilityUris` includes one or more supporting documents.
type: string
x-cds-type: URIString
feesAndPricingUri:
description: Description of fees, pricing, discounts, exemptions and bonuses
for the product. Mandatory if `additionalFeesAndPricingUris` includes
one or more supporting documents.
type: string
x-cds-type: URIString
bundleUri:
description: Description of a bundle that this product can be part of. Mandatory
if `additionalBundleUris` includes one or more supporting documents.
type: string
x-cds-type: URIString
additionalOverviewUris:
description: An array of additional general overviews for the product or
features of the product, if applicable. To be treated as secondary documents
to the `overviewUri`. Only to be used if there is a primary `overviewUri`.
items:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris'
type: array
additionalTermsUris:
description: An array of additional terms and conditions for the product,
if applicable. To be treated as secondary documents to the `termsUri`.
Only to be used if there is a primary `termsUri`.
items:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris'
type: array
additionalEligibilityUris:
description: An array of additional eligibility rules and criteria for the
product, if applicable. To be treated as secondary documents to the `eligibilityUri`.
Only to be used if there is a primary `eligibilityUri`.
items:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris'
type: array
additionalFeesAndPricingUris:
description: An array of additional fees, pricing, discounts, exemptions
and bonuses for the product, if applicable. To be treated as secondary
documents to the `feesAndPricingUri`. Only to be used if there is a primary
`feesAndPricingUri`.
items:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris'
type: array
additionalBundleUris:
description: An array of additional bundles for the product, if applicable.
To be treated as secondary documents to the `bundleUri`. Only to be used
if there is a primary `bundleUri`.
items:
$ref: '#/components/schemas/BankingProductAdditionalInformationV2_additionalInformationUris'
type: array
type: object
x-conditional:
- overviewUri
- termsUri
- eligibilityUri
- feesAndPricingUri
- bundleUri
BankingProductAdditionalInformationV2_additionalInformationUris:
example:
additionalInfoUri: additionalInfoUri
description: description
properties:
description:
description: Display text providing more information about the document
URI
type: string
additionalInfoUri:
description: The URI describing the additional information
type: string
x-cds-type: URIString
required:
- additionalInfoUri
type: object
ResponseBankingProductByIdV4:
example:
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/BankingProductDetailV4'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
BankingProductDetailV4:
allOf:
- $ref: '#/components/schemas/BankingProductV4'
- $ref: '#/components/schemas/BankingProductDetailV4_allOf'
BankingProductBundle:
properties:
name:
description: Name of the bundle
type: string
description:
description: Description of the bundle
type: string
additionalInfo:
description: Display text providing more information on the bundle
type: string
additionalInfoUri:
description: Link to a web page with more information on the bundle criteria
and benefits
type: string
x-cds-type: URIString
productIds:
description: Array of product IDs for products included in the bundle that
are available via the product end points. Note that this array is not
intended to represent a comprehensive model of the products included in
the bundle and some products available for the bundle may not be available
via the product reference end points
items:
type: string
x-cds-type: ASCIIString
type: array
required:
- description
- name
type: object
BankingProductFeatureV2:
properties:
featureType:
description: The type of feature described
enum:
- ADDITIONAL_CARDS
- BALANCE_TRANSFERS
- BILL_PAYMENT
- BONUS_REWARDS
- CARD_ACCESS
- CASHBACK_OFFER
- COMPLEMENTARY_PRODUCT_DISCOUNTS
- DIGITAL_BANKING
- DIGITAL_WALLET
- DONATE_INTEREST
- EXTRA_REPAYMENTS
- FRAUD_PROTECTION
- FREE_TXNS
- FREE_TXNS_ALLOWANCE
- GUARANTOR
- INSURANCE
- INSTALMENT_PLAN
- INTEREST_FREE
- INTEREST_FREE_TRANSFERS
- LOYALTY_PROGRAM
- NOTIFICATIONS
- NPP_ENABLED
- NPP_PAYID
- OFFSET
- OTHER
- OVERDRAFT
- REDRAW
- RELATIONSHIP_MANAGEMENT
- UNLIMITED_TXNS
type: string
additionalValue:
description: Generic field containing additional information relevant to
the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory
or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc)
type: string
additionalInfo:
description: Display text providing more information on the feature. Mandatory
if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER
type: string
additionalInfoUri:
description: Link to a web page with more information on this feature
type: string
x-cds-type: URIString
required:
- featureType
type: object
x-conditional:
- additionalValue
- additionalInfo
BankingProductConstraint:
properties:
constraintType:
description: The type of constraint described. See the next section for
an overview of valid values and their meaning
enum:
- MAX_BALANCE
- MAX_LIMIT
- MIN_BALANCE
- MIN_LIMIT
- OPENING_BALANCE
type: string
additionalValue:
description: Generic field containing additional information relevant to
the [constraintType](#tocSproductconstrainttypedoc) specified. Whether
mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc)
type: string
additionalInfo:
description: Display text providing more information the constraint
type: string
additionalInfoUri:
description: Link to a web page with more information on the constraint
type: string
x-cds-type: URIString
required:
- constraintType
type: object
x-conditional:
- additionalValue
BankingProductEligibility:
properties:
eligibilityType:
description: The type of eligibility criteria described. See the next section
for an overview of valid values and their meaning
enum:
- BUSINESS
- EMPLOYMENT_STATUS
- MAX_AGE
- MIN_AGE
- MIN_INCOME
- MIN_TURNOVER
- NATURAL_PERSON
- OTHER
- PENSION_RECIPIENT
- RESIDENCY_STATUS
- STAFF
- STUDENT
type: string
additionalValue:
description: Generic field containing additional information relevant to
the [eligibilityType](#tocSproducteligibilitytypedoc) specified. Whether
mandatory or not is dependent on the value of [eligibilityType](#tocSproducteligibilitytypedoc)
type: string
additionalInfo:
description: Display text providing more information on the [eligibility](#tocSproducteligibilitytypedoc)
criteria. Mandatory if the field is set to OTHER
type: string
additionalInfoUri:
description: Link to a web page with more information on this eligibility
criteria
type: string
x-cds-type: URIString
required:
- eligibilityType
type: object
x-conditional:
- additionalValue
- additionalInfo
BankingProductFee:
properties:
name:
description: Name of the fee
type: string
feeType:
description: The type of fee
enum:
- DEPOSIT
- EVENT
- EXIT
- PAYMENT
- PERIODIC
- PURCHASE
- TRANSACTION
- UPFRONT
- VARIABLE
- WITHDRAWAL
type: string
amount:
description: The amount charged for the fee. One of amount, balanceRate,
transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE"
is supplied
type: string
x-cds-type: AmountString
balanceRate:
description: A fee rate calculated based on a proportion of the balance.
One of amount, balanceRate, transactionRate and accruedRate is mandatory
unless the *feeType* "VARIABLE" is supplied.
type: string
x-cds-type: RateString
transactionRate:
description: A fee rate calculated based on a proportion of a transaction.
One of amount, balanceRate, transactionRate and accruedRate is mandatory
unless the *feeType* "VARIABLE" is supplied
type: string
x-cds-type: RateString
accruedRate:
description: A fee rate calculated based on a proportion of the calculated
interest accrued on the account. One of amount, balanceRate, transactionRate
and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied
type: string
x-cds-type: RateString
accrualFrequency:
description: The indicative frequency with which the fee is calculated on
the account. Only applies if balanceRate or accruedRate is also present.
Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
currency:
description: The currency the fee will be charged in. Assumes AUD if absent
type: string
x-cds-type: CurrencyString
additionalValue:
description: Generic field containing additional information relevant to
the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or
not is dependent on the value of [feeType](#tocSproductfeetypedoc)
type: string
additionalInfo:
description: Display text providing more information on the fee
type: string
additionalInfoUri:
description: Link to a web page with more information on this fee
type: string
x-cds-type: URIString
discounts:
description: An optional list of discounts to this fee that may be available
items:
$ref: '#/components/schemas/BankingProductDiscount'
type: array
required:
- feeType
- name
type: object
x-conditional:
- additionalValue
- amount
- balanceRate
- transactionRate
- accruedRate
BankingProductDiscount:
properties:
description:
description: Description of the discount
type: string
discountType:
description: The type of discount. See the next section for an overview
of valid values and their meaning
enum:
- BALANCE
- DEPOSITS
- ELIGIBILITY_ONLY
- FEE_CAP
- PAYMENTS
type: string
amount:
description: Dollar value of the discount. One of amount, balanceRate, transactionRate,
accruedRate and feeRate is mandatory.
type: string
x-cds-type: AmountString
balanceRate:
description: A discount rate calculated based on a proportion of the balance.
Note that the currency of the fee discount is expected to be the same
as the currency of the fee itself. One of amount, balanceRate, transactionRate,
accruedRate and feeRate is mandatory. Unless noted in additionalInfo,
assumes the application and calculation frequency are the same as the
corresponding fee
type: string
x-cds-type: RateString
transactionRate:
description: A discount rate calculated based on a proportion of a transaction.
Note that the currency of the fee discount is expected to be the same
as the currency of the fee itself. One of amount, balanceRate, transactionRate,
accruedRate and feeRate is mandatory
type: string
x-cds-type: RateString
accruedRate:
description: A discount rate calculated based on a proportion of the calculated
interest accrued on the account. Note that the currency of the fee discount
is expected to be the same as the currency of the fee itself. One of amount,
balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless
noted in additionalInfo, assumes the application and calculation frequency
are the same as the corresponding fee
type: string
x-cds-type: RateString
feeRate:
description: A discount rate calculated based on a proportion of the fee
to which this discount is attached. Note that the currency of the fee
discount is expected to be the same as the currency of the fee itself.
One of amount, balanceRate, transactionRate, accruedRate and feeRate is
mandatory. Unless noted in additionalInfo, assumes the application and
calculation frequency are the same as the corresponding fee
type: string
x-cds-type: RateString
additionalValue:
description: Generic field containing additional information relevant to
the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory
or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc)
type: string
additionalInfo:
description: Display text providing more information on the discount
type: string
additionalInfoUri:
description: Link to a web page with more information on this discount
type: string
x-cds-type: URIString
eligibility:
description: Eligibility constraints that apply to this discount. Mandatory
if ``discountType`` is ``ELIGIBILITY_ONLY``.
items:
$ref: '#/components/schemas/BankingProductDiscountEligibility'
type: array
required:
- description
- discountType
type: object
x-conditional:
- accruedRate
- additionalValue
- amount
- balanceRate
- eligibility
- feeRate
- transactionRate
BankingProductDiscountEligibility:
properties:
discountEligibilityType:
description: The type of the specific eligibility constraint for a discount
enum:
- BUSINESS
- EMPLOYMENT_STATUS
- INTRODUCTORY
- MAX_AGE
- MIN_AGE
- MIN_INCOME
- MIN_TURNOVER
- NATURAL_PERSON
- OTHER
- PENSION_RECIPIENT
- RESIDENCY_STATUS
- STAFF
- STUDENT
type: string
additionalValue:
description: Generic field containing additional information relevant to
the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified.
Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)
type: string
additionalInfo:
description: Display text providing more information on this eligibility
constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc)
type: string
additionalInfoUri:
description: Link to a web page with more information on this eligibility
constraint
type: string
x-cds-type: URIString
required:
- discountEligibilityType
type: object
x-conditional:
- additionalInfo
- additionalValue
BankingProductDepositRate:
properties:
depositRateType:
description: The type of rate (base, bonus, etc). See the next section for
an overview of valid values and their meaning
enum:
- BONUS
- BUNDLE_BONUS
- FIXED
- FLOATING
- INTRODUCTORY
- MARKET_LINKED
- VARIABLE
type: string
rate:
description: The rate to be applied
type: string
x-cds-type: RateString
calculationFrequency:
description: The period after which the rate is applied to the balance to
calculate the amount due for the period. Calculation of the amount is
often daily (as balances may change) but accumulated until the total amount
is 'applied' to the account (see applicationFrequency). Formatted according
to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
applicationFrequency:
description: The period after which the calculated amount(s) (see calculationFrequency)
are 'applied' (i.e. debited or credited) to the account. Formatted according
to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
tiers:
description: Rate tiers applicable for this rate
items:
$ref: '#/components/schemas/BankingProductRateTierV3'
type: array
additionalValue:
description: Generic field containing additional information relevant to
the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether
mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc)
type: string
additionalInfo:
description: Display text providing more information on the rate
type: string
additionalInfoUri:
description: Link to a web page with more information on this rate
type: string
x-cds-type: URIString
required:
- depositRateType
- rate
type: object
x-conditional:
- additionalValue
BankingProductLendingRateV2:
properties:
lendingRateType:
description: The type of rate (fixed, variable, etc). See the next section
for an overview of valid values and their meaning
enum:
- BUNDLE_DISCOUNT_FIXED
- BUNDLE_DISCOUNT_VARIABLE
- CASH_ADVANCE
- DISCOUNT
- FIXED
- FLOATING
- INTRODUCTORY
- MARKET_LINKED
- PENALTY
- PURCHASE
- VARIABLE
type: string
rate:
description: The rate to be applied
type: string
x-cds-type: RateString
comparisonRate:
description: A comparison rate equivalent for this rate
type: string
x-cds-type: RateString
calculationFrequency:
description: The period after which the rate is applied to the balance to
calculate the amount due for the period. Calculation of the amount is
often daily (as balances may change) but accumulated until the total amount
is 'applied' to the account (see applicationFrequency). Formatted according
to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
applicationFrequency:
description: The period after which the calculated amount(s) (see calculationFrequency)
are 'applied' (i.e. debited or credited) to the account. Formatted according
to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
interestPaymentDue:
description: When loan payments are due to be paid within each period. The
investment benefit of earlier payments affect the rate that can be offered
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
repaymentType:
description: Options in place for repayments. If absent, the lending rate
is applicable to all repayment types
enum:
- INTEREST_ONLY
- PRINCIPAL_AND_INTEREST
type: string
loanPurpose:
description: The reason for taking out the loan. If absent, the lending
rate is applicable to all loan purposes
enum:
- INVESTMENT
- OWNER_OCCUPIED
type: string
tiers:
description: Rate tiers applicable for this rate
items:
$ref: '#/components/schemas/BankingProductRateTierV3'
type: array
additionalValue:
description: Generic field containing additional information relevant to
the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether
mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc)
type: string
additionalInfo:
description: Display text providing more information on the rate.
type: string
additionalInfoUri:
description: Link to a web page with more information on this rate
type: string
x-cds-type: URIString
required:
- lendingRateType
- rate
type: object
x-conditional:
- additionalValue
BankingProductRateTierV3:
description: Defines the criteria and conditions for which a rate applies
properties:
name:
description: A display name for the tier
type: string
unitOfMeasure:
description: The unit of measure that applies to the tierValueMinimum and
tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the
case of loan-to-value ratio or LVR). Tier term period representing a discrete
number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers)
enum:
- DAY
- DOLLAR
- MONTH
- PERCENT
type: string
minimumValue:
description: The number of tierUnitOfMeasure units that form the lower bound
of the tier. The tier should be inclusive of this value
type: number
x-cds-type: Number
maximumValue:
description: 'The number of tierUnitOfMeasure units that form the upper
bound of the tier or band. For a tier with a discrete value (as opposed
to a range of values e.g. 1 month) this must be the same as tierValueMinimum.
Where this is the same as the tierValueMinimum value of the next-higher
tier the referenced tier should be exclusive of this value. For example
a term deposit of 2 months falls into the upper tier of the following
tiers: (1 – 2 months, 2 – 3 months). If absent the tier''s range has no
upper bound.'
type: number
x-cds-type: Number
rateApplicationMethod:
description: The method used to calculate the amount to be applied using
one or more tiers. A single rate may be applied to the entire balance
or each applicable tier rate is applied to the portion of the balance
that falls into that tier (referred to as 'bands' or 'steps')
enum:
- PER_TIER
- WHOLE_BALANCE
type: string
applicabilityConditions:
$ref: '#/components/schemas/BankingProductRateCondition'
additionalInfo:
description: Display text providing more information on the rate tier.
type: string
additionalInfoUri:
description: Link to a web page with more information on this rate tier
type: string
x-cds-type: URIString
required:
- minimumValue
- name
- unitOfMeasure
type: object
BankingProductRateCondition:
description: Defines a condition for the applicability of a tiered rate
properties:
additionalInfo:
description: Display text providing more information on the condition
type: string
additionalInfoUri:
description: Link to a web page with more information on this condition
type: string
x-cds-type: URIString
type: object
ResponseBankingAccountListV2:
example:
data:
accounts:
- accountId: accountId
maskedNumber: maskedNumber
openStatus: OPEN
displayName: displayName
isOwned: true
nickname: nickname
creationDate: creationDate
productName: productName
accountOwnership: UNKNOWN
- accountId: accountId
maskedNumber: maskedNumber
openStatus: OPEN
displayName: displayName
isOwned: true
nickname: nickname
creationDate: creationDate
productName: productName
accountOwnership: UNKNOWN
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingAccountListV2_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
BankingAccountV2:
example:
accountId: accountId
maskedNumber: maskedNumber
openStatus: OPEN
displayName: displayName
isOwned: true
nickname: nickname
creationDate: creationDate
productName: productName
accountOwnership: UNKNOWN
properties:
accountId:
description: A unique ID of the account adhering to the standards for ID
permanence
type: string
x-cds-type: ASCIIString
creationDate:
description: Date that the account was created (if known)
type: string
x-cds-type: DateString
displayName:
description: The display name of the account as defined by the bank. This
should not incorporate account numbers or PANs. If it does the values
should be masked according to the rules of the MaskedAccountString common
type.
type: string
nickname:
description: A customer supplied nick name for the account
type: string
openStatus:
default: OPEN
description: Open or closed status for the account. If not present then
OPEN is assumed
enum:
- CLOSED
- OPEN
type: string
isOwned:
default: true
description: Flag indicating that the customer associated with the authorisation
is an owner of the account. Does not indicate sole ownership, however.
If not present then 'true' is assumed
type: boolean
x-cds-type: Boolean
accountOwnership:
description: Value indicating the number of customers that have ownership
of the account, according to the data holder's definition of account ownership.
Does not indicate that all account owners are eligible consumers
enum:
- UNKNOWN
- ONE_PARTY
- TWO_PARTY
- MANY_PARTY
- OTHER
type: string
maskedNumber:
description: A masked version of the account. Whether BSB/Account Number,
Credit Card PAN or another number
type: string
x-cds-type: MaskedAccountString
productCategory:
$ref: '#/components/schemas/BankingProductCategory'
productName:
description: The unique identifier of the account as defined by the data
holder (akin to model number for the account)
type: string
required:
- accountId
- accountOwnership
- displayName
- maskedNumber
- productCategory
- productName
type: object
ResponseBankingAccountByIdV3:
example:
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/BankingAccountDetailV3'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
BankingAccountDetailV3:
allOf:
- $ref: '#/components/schemas/BankingAccountV2'
- $ref: '#/components/schemas/BankingAccountDetailV3_allOf'
BankingTermDepositAccount:
properties:
lodgementDate:
description: The lodgement date of the original deposit
type: string
x-cds-type: DateString
maturityDate:
description: Maturity date for the term deposit
type: string
x-cds-type: DateString
maturityAmount:
description: Amount to be paid upon maturity. If absent it implies the amount
to paid is variable and cannot currently be calculated
type: string
x-cds-type: AmountString
maturityCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
maturityInstructions:
description: Current instructions on action to be taken at maturity. This
includes default actions that may be specified in the terms and conditions
for the product e.g. roll-over to the same term and frequency of interest
payments
enum:
- HOLD_ON_MATURITY
- PAID_OUT_AT_MATURITY
- ROLLED_OVER
type: string
required:
- lodgementDate
- maturityDate
- maturityInstructions
type: object
BankingCreditCardAccount:
properties:
minPaymentAmount:
description: The minimum payment amount due for the next card payment
type: string
x-cds-type: AmountString
paymentDueAmount:
description: The amount due for the next card payment
type: string
x-cds-type: AmountString
paymentCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
paymentDueDate:
description: Date that the next payment for the card is due
type: string
x-cds-type: DateString
required:
- minPaymentAmount
- paymentDueAmount
- paymentDueDate
type: object
BankingLoanAccountV2:
properties:
originalStartDate:
description: Optional original start date for the loan
type: string
x-cds-type: DateString
originalLoanAmount:
description: Optional original loan value
type: string
x-cds-type: AmountString
originalLoanCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
loanEndDate:
description: Date that the loan is due to be repaid in full
type: string
x-cds-type: DateString
nextInstalmentDate:
description: Next date that an instalment is required
type: string
x-cds-type: DateString
minInstalmentAmount:
description: Minimum amount of next instalment
type: string
x-cds-type: AmountString
minInstalmentCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
maxRedraw:
description: Maximum amount of funds that can be redrawn. If not present
redraw is not available even if the feature exists for the account
type: string
x-cds-type: AmountString
maxRedrawCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
minRedraw:
description: Minimum redraw amount
type: string
x-cds-type: AmountString
minRedrawCurrency:
description: If absent assumes AUD
type: string
x-cds-type: CurrencyString
offsetAccountEnabled:
description: Set to true if one or more offset accounts are configured for
this loan account
type: boolean
x-cds-type: Boolean
offsetAccountIds:
description: The accountIDs of the configured offset accounts attached to
this loan. Only offset accounts that can be accessed under the current
authorisation should be included. It is expected behaviour that offsetAccountEnabled
is set to true but the offsetAccountIds field is absent or empty. This
represents a situation where an offset account exists but details can
not be accessed under the current authorisation
items:
type: string
x-cds-type: ASCIIString
type: array
repaymentType:
default: PRINCIPAL_AND_INTEREST
description: Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
enum:
- INTEREST_ONLY
- PRINCIPAL_AND_INTEREST
type: string
repaymentFrequency:
description: The expected or required repayment frequency. Formatted according
to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations)
(excludes recurrence syntax)
type: string
x-cds-type: ExternalRef
type: object
ResponseBankingTransactionList:
example:
data:
transactions:
- postingDateTime: postingDateTime
amount: amount
apcaNumber: apcaNumber
isDetailAvailable: true
description: description
type: DIRECT_DEBIT
billerName: billerName
executionDateTime: executionDateTime
transactionId: transactionId
merchantName: merchantName
billerCode: billerCode
reference: reference
accountId: accountId
merchantCategoryCode: merchantCategoryCode
valueDateTime: valueDateTime
currency: currency
crn: crn
status: PENDING
- postingDateTime: postingDateTime
amount: amount
apcaNumber: apcaNumber
isDetailAvailable: true
description: description
type: DIRECT_DEBIT
billerName: billerName
executionDateTime: executionDateTime
transactionId: transactionId
merchantName: merchantName
billerCode: billerCode
reference: reference
accountId: accountId
merchantCategoryCode: merchantCategoryCode
valueDateTime: valueDateTime
currency: currency
crn: crn
status: PENDING
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingTransactionList_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
BankingTransaction:
example:
postingDateTime: postingDateTime
amount: amount
apcaNumber: apcaNumber
isDetailAvailable: true
description: description
type: DIRECT_DEBIT
billerName: billerName
executionDateTime: executionDateTime
transactionId: transactionId
merchantName: merchantName
billerCode: billerCode
reference: reference
accountId: accountId
merchantCategoryCode: merchantCategoryCode
valueDateTime: valueDateTime
currency: currency
crn: crn
status: PENDING
properties:
accountId:
description: ID of the account for which transactions are provided
type: string
x-cds-type: ASCIIString
transactionId:
description: A unique ID of the transaction adhering to the standards for
ID permanence. This is mandatory (through hashing if necessary) unless
there are specific and justifiable technical reasons why a transaction
cannot be uniquely identified for a particular account type. It is mandatory
if `isDetailAvailable` is set to true.
type: string
x-cds-type: ASCIIString
isDetailAvailable:
description: True if extended information is available using the transaction
detail end point. False if extended data is not available
type: boolean
x-cds-type: Boolean
type:
description: The type of the transaction
enum:
- DIRECT_DEBIT
- FEE
- INTEREST_CHARGED
- INTEREST_PAID
- OTHER
- PAYMENT
- TRANSFER_INCOMING
- TRANSFER_OUTGOING
type: string
status:
description: Status of the transaction whether pending or posted. Note that
there is currently no provision in the standards to guarantee the ability
to correlate a pending transaction with an associated posted transaction
enum:
- PENDING
- POSTED
type: string
description:
description: The transaction description as applied by the financial institution
type: string
postingDateTime:
description: The time the transaction was posted. This field is Mandatory
if the transaction has status POSTED. This is the time that appears on
a standard statement
type: string
x-cds-type: DateTimeString
valueDateTime:
description: Date and time at which assets become available to the account
owner in case of a credit entry, or cease to be available to the account
owner in case of a debit transaction entry
type: string
x-cds-type: DateTimeString
executionDateTime:
description: The time the transaction was executed by the originating customer,
if available
type: string
x-cds-type: DateTimeString
amount:
description: The value of the transaction. Negative values mean money was
outgoing from the account
type: string
x-cds-type: AmountString
currency:
description: The currency for the transaction amount. AUD assumed if not
present
type: string
x-cds-type: CurrencyString
reference:
description: The reference for the transaction provided by the originating
institution. Empty string if no data provided
type: string
merchantName:
description: Name of the merchant for an outgoing payment to a merchant
type: string
merchantCategoryCode:
description: The merchant category code (or MCC) for an outgoing payment
to a merchant
type: string
billerCode:
description: BPAY Biller Code for the transaction (if available)
type: string
billerName:
description: Name of the BPAY biller for the transaction (if available)
type: string
crn:
description: BPAY CRN for the transaction (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 are otherwise sensitive, then
it should be masked using the rules applicable for the MaskedAccountString
common type.
type: string
apcaNumber:
description: 6 Digit APCA number for the initiating institution. The field
is fixed-width and padded with leading zeros if applicable.
type: string
required:
- accountId
- amount
- description
- isDetailAvailable
- reference
- status
- type
type: object
x-conditional:
- transactionId
- postingDateTime
- crn
ResponseBankingTransactionById:
example:
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/BankingTransactionDetail'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
BankingTransactionDetail:
allOf:
- $ref: '#/components/schemas/BankingTransaction'
- $ref: '#/components/schemas/BankingTransactionDetail_allOf'
ResponseBankingAccountsBalanceList:
example:
data:
balances:
- accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
- accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingAccountsBalanceList_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
ResponseBankingAccountsBalanceById:
example:
data:
accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/BankingBalance'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
BankingBalance:
example:
accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
properties:
accountId:
description: A unique ID of the account adhering to the standards for ID
permanence
type: string
x-cds-type: ASCIIString
currentBalance:
description: The balance of the account at this time. Should align to the
balance available via other channels such as Internet Banking. Assumed
to be negative if the customer has money owing
type: string
x-cds-type: AmountString
availableBalance:
description: Balance representing the amount of funds available for transfer.
Assumed to be zero or positive
type: string
x-cds-type: AmountString
creditLimit:
description: Object representing the maximum amount of credit that is available
for this account. Assumed to be zero if absent
type: string
x-cds-type: AmountString
amortisedLimit:
description: Object representing the available limit amortised according
to payment schedule. Assumed to be zero if absent
type: string
x-cds-type: AmountString
currency:
description: The currency for the balance amounts. If absent assumed to
be AUD
type: string
x-cds-type: CurrencyString
purses:
description: Optional array of balances for the account in other currencies.
Included to support accounts that support multi-currency purses such as
Travel Cards
items:
$ref: '#/components/schemas/BankingBalancePurse'
type: array
required:
- accountId
- availableBalance
- currentBalance
type: object
BankingBalancePurse:
example:
amount: amount
currency: currency
properties:
amount:
description: The balance available for this additional currency purse
type: string
x-cds-type: AmountString
currency:
description: The currency for the purse
type: string
x-cds-type: CurrencyString
required:
- amount
type: object
ResponseBankingPayeeListV2:
example:
data:
payees:
- nickname: nickname
description: description
payeeId: payeeId
type: BILLER
creationDate: creationDate
- nickname: nickname
description: description
payeeId: payeeId
type: BILLER
creationDate: creationDate
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingPayeeListV2_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
ResponseBankingPayeeByIdV2:
example:
meta: '{}'
links:
self: self
properties:
data:
$ref: '#/components/schemas/BankingPayeeDetailV2'
links:
$ref: '#/components/schemas/Links'
meta:
type: object
required:
- data
- links
type: object
BankingPayeeV2:
example:
nickname: nickname
description: description
payeeId: payeeId
type: BILLER
creationDate: creationDate
properties:
payeeId:
description: ID of the payee adhering to the rules of ID permanence
type: string
x-cds-type: ASCIIString
nickname:
description: The short display name of the payee as provided by the customer.
Where a customer has not provided a nickname, a display name derived by
the bank for the payee consistent with existing digital banking channels
type: string
description:
description: A description of the payee provided by the customer
type: string
type:
description: The type of payee.
DOMESTIC means a registered payee for
domestic payments including NPP.
INTERNATIONAL means a registered
payee for international payments.
BILLER means a registered payee
for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital
wallet
enum:
- BILLER
- DIGITAL_WALLET
- DOMESTIC
- INTERNATIONAL
type: string
creationDate:
description: The date the payee was created by the customer
type: string
x-cds-type: DateString
required:
- nickname
- payeeId
- type
type: object
BankingPayeeDetailV2:
allOf:
- $ref: '#/components/schemas/BankingPayeeV2'
- $ref: '#/components/schemas/BankingPayeeDetailV2_allOf'
BankingDomesticPayee:
example:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
properties:
payeeAccountUType:
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
type: string
account:
$ref: '#/components/schemas/BankingDomesticPayeeAccount'
card:
$ref: '#/components/schemas/BankingDomesticPayeeCard'
payId:
$ref: '#/components/schemas/BankingDomesticPayeePayId'
required:
- payeeAccountUType
type: object
x-conditional:
- account
- card
- payId
BankingDomesticPayeeAccount:
example:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
properties:
accountName:
description: Name of the account to pay to
type: string
bsb:
description: BSB of the account to pay to
type: string
accountNumber:
description: Number of the account to pay to
type: string
required:
- accountNumber
- bsb
type: object
BankingDomesticPayeeCard:
example:
cardNumber: cardNumber
properties:
cardNumber:
description: Name of the account to pay to
type: string
x-cds-type: MaskedPANString
required:
- cardNumber
type: object
BankingDomesticPayeePayId:
example:
identifier: identifier
name: name
type: ABN
properties:
name:
description: The name assigned to the PayID by the owner of the PayID
type: string
identifier:
description: The identifier of the PayID (dependent on type)
type: string
type:
description: The type of the PayID
enum:
- ABN
- EMAIL
- ORG_IDENTIFIER
- TELEPHONE
type: string
required:
- identifier
- type
type: object
BankingBillerPayee:
example:
billerName: billerName
crn: crn
billerCode: billerCode
properties:
billerCode:
description: BPAY Biller Code of the Biller
type: string
crn:
description: 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 are otherwise sensitive, then it should be masked
using the rules applicable for the MaskedAccountString common type.
type: string
billerName:
description: Name of the Biller
type: string
required:
- billerCode
- billerName
type: object
x-conditional:
- crn
BankingInternationalPayee:
example:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
properties:
beneficiaryDetails:
$ref: '#/components/schemas/BankingInternationalPayee_beneficiaryDetails'
bankDetails:
$ref: '#/components/schemas/BankingInternationalPayee_bankDetails'
required:
- bankDetails
- beneficiaryDetails
type: object
BankingDigitalWalletPayee:
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
type: string
identifier:
description: The identifier of the digital wallet (dependent on type)
type: string
type:
description: The type of the digital wallet identifier
enum:
- EMAIL
- CONTACT_NAME
- TELEPHONE
type: string
provider:
description: The provider of the digital wallet
enum:
- PAYPAL_AU
- OTHER
type: string
required:
- identifier
- name
- provider
- type
type: object
ResponseBankingDirectDebitAuthorisationList:
example:
data:
directDebitAuthorisations:
- lastDebitAmount: lastDebitAmount
accountId: accountId
lastDebitDateTime: lastDebitDateTime
authorisedEntity:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
- lastDebitAmount: lastDebitAmount
accountId: accountId
lastDebitDateTime: lastDebitDateTime
authorisedEntity:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingDirectDebitAuthorisationList_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
BankingDirectDebit:
example:
lastDebitAmount: lastDebitAmount
accountId: accountId
lastDebitDateTime: lastDebitDateTime
authorisedEntity:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
properties:
accountId:
description: A unique ID of the account adhering to the standards for ID
permanence.
type: string
x-cds-type: ASCIIString
authorisedEntity:
$ref: '#/components/schemas/BankingAuthorisedEntity'
lastDebitDateTime:
description: The date and time of the last debit executed under this authorisation
type: string
x-cds-type: DateTimeString
lastDebitAmount:
description: The amount of the last debit executed under this authorisation
type: string
x-cds-type: AmountString
required:
- accountId
- authorisedEntity
type: object
BankingAuthorisedEntity:
example:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
properties:
description:
description: Description of the authorised entity derived from previously
executed direct debits
type: string
financialInstitution:
description: Name of the financial institution through which the direct
debit will be executed. Is required unless the payment is made via a credit
card scheme
type: string
abn:
description: Australian Business Number for the authorised entity
type: string
acn:
description: Australian Company Number for the authorised entity
type: string
arbn:
description: Australian Registered Body Number for the authorised entity
type: string
type: object
x-conditional:
- financialInstitution
ResponseBankingScheduledPaymentsList:
example:
data:
scheduledPayments:
- recurrence:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
scheduledPaymentId: scheduledPaymentId
payeeReference: payeeReference
payerReference: payerReference
nickname: nickname
from:
accountId: accountId
paymentSet:
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
status: ACTIVE
- recurrence:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
scheduledPaymentId: scheduledPaymentId
payeeReference: payeeReference
payerReference: payerReference
nickname: nickname
from:
accountId: accountId
paymentSet:
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
status: ACTIVE
meta:
totalRecords: 0
totalPages: 6
links:
next: next
last: last
prev: prev
self: self
first: first
properties:
data:
$ref: '#/components/schemas/ResponseBankingScheduledPaymentsList_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
BankingScheduledPayment:
example:
recurrence:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
scheduledPaymentId: scheduledPaymentId
payeeReference: payeeReference
payerReference: payerReference
nickname: nickname
from:
accountId: accountId
paymentSet:
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
status: ACTIVE
properties:
scheduledPaymentId:
description: A unique ID of the scheduled payment adhering to the standards
for ID permanence
type: string
x-cds-type: ASCIIString
nickname:
description: 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
type: string
payerReference:
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’s account. Empty string if no data provided
type: string
payeeReference:
description: 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
type: string
status:
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
- INACTIVE
- SKIP
type: string
from:
$ref: '#/components/schemas/BankingScheduledPaymentFrom'
paymentSet:
items:
$ref: '#/components/schemas/BankingScheduledPaymentSet'
type: array
recurrence:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrence'
required:
- from
- payerReference
- paymentSet
- recurrence
- scheduledPaymentId
- status
type: object
x-conditional:
- payeeReference
BankingScheduledPaymentSet:
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
example:
isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
properties:
to:
$ref: '#/components/schemas/BankingScheduledPaymentTo'
isAmountCalculated:
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
type: boolean
x-cds-type: Boolean
amount:
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
type: string
x-cds-type: AmountString
currency:
description: The currency for the payment. AUD assumed if not present
type: string
x-cds-type: CurrencyString
required:
- to
type: object
x-conditional:
- amount
BankingScheduledPaymentTo:
description: Object containing details of the destination of the payment. Used
to specify a variety of payment destination types
example:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
properties:
toUType:
description: The type of object provided that specifies the destination
of the funds for the payment.
enum:
- accountId
- biller
- domestic
- international
- payeeId
type: string
accountId:
description: Present if toUType is set to accountId. Indicates that the
payment is to another account that is accessible under the current consent
type: string
x-cds-type: ASCIIString
payeeId:
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
type: string
x-cds-type: ASCIIString
nickname:
description: 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
type: string
payeeReference:
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
domestic:
$ref: '#/components/schemas/BankingDomesticPayee'
biller:
$ref: '#/components/schemas/BankingBillerPayee'
international:
$ref: '#/components/schemas/BankingInternationalPayee'
required:
- toUType
type: object
x-conditional:
- accountId
- payeeId
- 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
example:
accountId: accountId
properties:
accountId:
description: ID of the account that is the source of funds for the payment
type: string
x-cds-type: ASCIIString
required:
- accountId
type: object
BankingScheduledPaymentRecurrence:
description: Object containing the detail of the schedule for the payment
example:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
properties:
nextPaymentDate:
description: The date of the next payment under the recurrence schedule
type: string
x-cds-type: DateString
recurrenceUType:
description: The type of recurrence used to define the schedule
enum:
- eventBased
- intervalSchedule
- lastWeekDay
- onceOff
type: string
onceOff:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceOnceOff'
intervalSchedule:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceIntervalSchedule'
lastWeekDay:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceLastWeekday'
eventBased:
$ref: '#/components/schemas/BankingScheduledPaymentRecurrenceEventBased'
required:
- recurrenceUType
type: object
x-conditional:
- onceOff
- intervalSchedule
- lastWeekDay
- eventBased
BankingScheduledPaymentRecurrenceOnceOff:
description: Indicates that the payment is a once off payment on a specific
future date. Mandatory if recurrenceUType is set to onceOff
example:
paymentDate: paymentDate
properties:
paymentDate:
description: The scheduled date for the once off payment
type: string
x-cds-type: DateString
required:
- paymentDate
type: object
BankingScheduledPaymentRecurrenceIntervalSchedule:
description: Indicates that the schedule of payments is defined by a series
of intervals. Mandatory if recurrenceUType is set to intervalSchedule
example:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
properties:
finalPaymentDate:
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
type: string
x-cds-type: DateString
paymentsRemaining:
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
example: 1
type: integer
x-cds-type: PositiveInteger
nonBusinessDayTreatment:
default: "ON"
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
enum:
- AFTER
- BEFORE
- "ON"
- ONLY
type: string
intervals:
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'
type: array
required:
- intervals
type: object
BankingScheduledPaymentInterval:
example:
interval: interval
dayInInterval: dayInInterval
properties:
interval:
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
type: string
x-cds-type: ExternalRef
dayInInterval:
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.
type: string
x-cds-type: ExternalRef
required:
- interval
type: object
BankingScheduledPaymentRecurrenceLastWeekday:
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
example:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
properties:
finalPaymentDate:
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
type: string
x-cds-type: DateString
paymentsRemaining:
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
example: 1
type: integer
x-cds-type: PositiveInteger
interval:
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
type: string
x-cds-type: ExternalRef
lastWeekDay:
description: The weekDay specified. The payment will occur on the last occurrence
of this weekday in the interval.
enum:
- FRI
- MON
- SAT
- SUN
- THU
- TUE
- WED
type: string
nonBusinessDayTreatment:
default: "ON"
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
enum:
- AFTER
- BEFORE
- "ON"
- ONLY
type: string
required:
- interval
- lastWeekDay
type: object
BankingScheduledPaymentRecurrenceEventBased:
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
example:
description: description
properties:
description:
description: Description of the event and conditions that will result in
the payment. Expected to be formatted for display to a customer
type: string
required:
- description
type: object
CommonPhysicalAddress:
properties:
addressUType:
description: The type of address object present
enum:
- paf
- simple
type: string
simple:
$ref: '#/components/schemas/CommonSimpleAddress'
paf:
$ref: '#/components/schemas/CommonPAFAddress'
required:
- addressUType
type: object
x-conditional:
- simple
- paf
CommonSimpleAddress:
properties:
mailingName:
description: Name of the individual or business formatted for inclusion
in an address used for physical mail
type: string
addressLine1:
description: First line of the standard address object
type: string
addressLine2:
description: Second line of the standard address object
type: string
addressLine3:
description: Third line of the standard address object
type: string
postcode:
description: Mandatory for Australian addresses
type: string
city:
description: Name of the city or locality
type: string
state:
description: Free text if the country is not Australia. If country is Australia
then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)
in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
type: string
country:
default: AUS
description: A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html)
country code. Australia (AUS) is assumed if country is not present.
type: string
x-cds-type: ExternalRef
required:
- addressLine1
- city
- state
type: object
x-conditional:
- postcode
CommonPAFAddress:
description: Australian address formatted according to the file format defined
by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)
properties:
dpid:
description: Unique identifier for an address as defined by Australia Post. Also
known as Delivery Point Identifier
type: string
thoroughfareNumber1:
description: Thoroughfare number for a property (first number in a property
ranged address)
type: integer
x-cds-type: PositiveInteger
thoroughfareNumber1Suffix:
description: Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1
is populated
type: string
thoroughfareNumber2:
description: Second thoroughfare number (only used if the property has a
ranged address eg 23-25)
type: integer
x-cds-type: PositiveInteger
thoroughfareNumber2Suffix:
description: Suffix for the second thoroughfare number. Only relevant is
thoroughfareNumber2 is populated
type: string
flatUnitType:
description: Type of flat or unit for the address
type: string
flatUnitNumber:
description: Unit number (including suffix, if applicable)
type: string
floorLevelType:
description: Type of floor or level for the address
type: string
floorLevelNumber:
description: Floor or level number (including alpha characters)
type: string
lotNumber:
description: Allotment number for the address
type: string
buildingName1:
description: Building/Property name 1
type: string
buildingName2:
description: Building/Property name 2
type: string
streetName:
description: The name of the street
type: string
streetType:
description: The street type. Valid enumeration defined by Australia Post
PAF code file
type: string
streetSuffix:
description: The street type suffix. Valid enumeration defined by Australia
Post PAF code file
type: string
postalDeliveryType:
description: Postal delivery type. (eg. PO BOX). Valid enumeration defined
by Australia Post PAF code file
type: string
postalDeliveryNumber:
description: Postal delivery number if the address is a postal delivery
type
type: integer
x-cds-type: PositiveInteger
postalDeliveryNumberPrefix:
description: Postal delivery number prefix related to the postal delivery
number
type: string
postalDeliveryNumberSuffix:
description: Postal delivery number suffix related to the postal delivery
number
type: string
localityName:
description: Full name of locality
type: string
postcode:
description: Postcode for the locality
type: string
state:
description: State in which the address belongs. Valid enumeration defined
by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf).
NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
type: string
required:
- localityName
- postcode
- state
type: object
Links:
example:
self: self
properties:
self:
description: Fully qualified link that generated the current response document
type: string
x-cds-type: URIString
required:
- self
type: object
Meta:
type: object
LinksPaginated:
example:
next: next
last: last
prev: prev
self: self
first: first
properties:
self:
description: Fully qualified link that generated the current response document
type: string
x-cds-type: URIString
first:
description: URI to the first page of this set. Mandatory if this response
is not the first page
type: string
x-cds-type: URIString
prev:
description: URI to the previous page of this set. Mandatory if this response
is not the first page
type: string
x-cds-type: URIString
next:
description: URI to the next page of this set. Mandatory if this response
is not the last page
type: string
x-cds-type: URIString
last:
description: URI to the last page of this set. Mandatory if this response
is not the last page
type: string
x-cds-type: URIString
required:
- self
type: object
x-conditional:
- prev
- next
- first
- last
MetaPaginated:
example:
totalRecords: 0
totalPages: 6
properties:
totalRecords:
description: The total number of records in the full set. See [pagination](#pagination).
type: integer
x-cds-type: NaturalNumber
totalPages:
description: The total number of pages in the full set. See [pagination](#pagination).
type: integer
x-cds-type: NaturalNumber
required:
- totalPages
- totalRecords
type: object
MetaError:
description: Additional data for customised error codes
properties:
urn:
description: The CDR error code URN which the application-specific error
code extends. Mandatory if the error `code` is an application-specific
error rather than a standardised error code.
type: string
type: object
x-conditional:
- urn
ResponseErrorListV2:
properties:
errors:
items:
$ref: '#/components/schemas/ResponseErrorListV2_errors'
type: array
required:
- errors
type: object
x-conditional:
- meta
BankingProductCategory:
description: The category to which a product or account belongs. See [here](#product-categories)
for more details
enum:
- BUSINESS_LOANS
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
type: string
RequestAccountIds_data:
example:
accountIds:
- accountIds
- accountIds
properties:
accountIds:
items:
description: Array of specific accountIds to obtain authorisations for
type: string
x-cds-type: ASCIIString
type: array
required:
- accountIds
type: object
ResponseBankingProductListV2_data:
example:
products:
- additionalInformation:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
brandName: brandName
productId: productId
description: description
effectiveTo: effectiveTo
cardArt:
- imageUri: imageUri
title: title
- imageUri: imageUri
title: title
lastUpdated: lastUpdated
isTailored: true
name: name
applicationUri: applicationUri
effectiveFrom: effectiveFrom
brand: brand
- additionalInformation:
eligibilityUri: eligibilityUri
additionalFeesAndPricingUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalTermsUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
bundleUri: bundleUri
feesAndPricingUri: feesAndPricingUri
additionalBundleUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalEligibilityUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
additionalOverviewUris:
- additionalInfoUri: additionalInfoUri
description: description
- additionalInfoUri: additionalInfoUri
description: description
termsUri: termsUri
overviewUri: overviewUri
brandName: brandName
productId: productId
description: description
effectiveTo: effectiveTo
cardArt:
- imageUri: imageUri
title: title
- imageUri: imageUri
title: title
lastUpdated: lastUpdated
isTailored: true
name: name
applicationUri: applicationUri
effectiveFrom: effectiveFrom
brand: brand
properties:
products:
description: The list of products returned. If the filter results in an
empty set then this array may have no records
items:
$ref: '#/components/schemas/BankingProductV4'
type: array
required:
- products
type: object
BankingProductV4_cardArt:
example:
imageUri: imageUri
title: title
properties:
title:
description: Display label for the specific image
type: string
imageUri:
description: URI reference to a PNG, JPG or GIF image with proportions defined
by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference
may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**
type: string
x-cds-type: URIString
required:
- imageUri
type: object
BankingProductDetailV4_allOf:
properties:
bundles:
description: An array of bundles that this product participates in. Each
bundle is described by free form information but also by a list of product
IDs of the other products that are included in the bundle. It is assumed
that the current product is included in the bundle also
items:
$ref: '#/components/schemas/BankingProductBundle'
type: array
features:
description: Array of features available for the product
items:
$ref: '#/components/schemas/BankingProductFeatureV2'
type: array
constraints:
description: Constraints on the application for or operation of the product
such as minimum balances or limit thresholds
items:
$ref: '#/components/schemas/BankingProductConstraint'
type: array
eligibility:
description: Eligibility criteria for the product
items:
$ref: '#/components/schemas/BankingProductEligibility'
type: array
fees:
description: Fees applicable for the product
items:
$ref: '#/components/schemas/BankingProductFee'
type: array
depositRates:
description: Interest rates available for deposits
items:
$ref: '#/components/schemas/BankingProductDepositRate'
type: array
lendingRates:
description: Interest rates charged against lending balances
items:
$ref: '#/components/schemas/BankingProductLendingRateV2'
type: array
type: object
ResponseBankingAccountListV2_data:
example:
accounts:
- accountId: accountId
maskedNumber: maskedNumber
openStatus: OPEN
displayName: displayName
isOwned: true
nickname: nickname
creationDate: creationDate
productName: productName
accountOwnership: UNKNOWN
- accountId: accountId
maskedNumber: maskedNumber
openStatus: OPEN
displayName: displayName
isOwned: true
nickname: nickname
creationDate: creationDate
productName: productName
accountOwnership: UNKNOWN
properties:
accounts:
description: The list of accounts returned. If the filter results in an
empty set then this array may have no records
items:
$ref: '#/components/schemas/BankingAccountV2'
type: array
required:
- accounts
type: object
BankingAccountDetailV3_allOf:
properties:
bsb:
description: The unmasked BSB for the account. Is expected to be formatted
as digits only with leading zeros included and no punctuation or spaces
type: string
accountNumber:
description: The unmasked account number for the account. Should not be
supplied if the account number is a PAN requiring PCI compliance. Is expected
to be formatted as digits only with leading zeros included and no punctuation
or spaces
type: string
bundleName:
description: Optional field to indicate if this account is part of a bundle
that is providing additional benefit for to the customer
type: string
specificAccountUType:
description: The type of structure to present account specific fields.
enum:
- creditCard
- loan
- termDeposit
type: string
termDeposit:
items:
$ref: '#/components/schemas/BankingTermDepositAccount'
type: array
creditCard:
$ref: '#/components/schemas/BankingCreditCardAccount'
loan:
$ref: '#/components/schemas/BankingLoanAccountV2'
depositRate:
description: current rate to calculate interest earned being applied to
deposit balances as it stands at the time of the API call
type: string
x-cds-type: RateString
lendingRate:
description: The current rate to calculate interest payable being applied
to lending balances as it stands at the time of the API call
type: string
x-cds-type: RateString
depositRates:
description: Fully described deposit rates for this account based on the
equivalent structure in Product Reference
items:
$ref: '#/components/schemas/BankingProductDepositRate'
type: array
lendingRates:
description: Fully described deposit rates for this account based on the
equivalent structure in Product Reference
items:
$ref: '#/components/schemas/BankingProductLendingRateV2'
type: array
features:
description: Array of features of the account based on the equivalent structure
in Product Reference with the following additional field
items:
allOf:
- $ref: '#/components/schemas/BankingProductFeatureV2'
- properties:
isActivated:
default: true
description: True if the feature is already activated and false
if the feature is available for activation. Defaults to true if
absent. (note this is an additional field appended to the feature
object defined in the Product Reference payload)
type: boolean
x-cds-type: Boolean
type: object
type: object
type: array
fees:
description: Fees and charges applicable to the account based on the equivalent
structure in Product Reference
items:
$ref: '#/components/schemas/BankingProductFee'
type: array
addresses:
description: The addresses for the account to be used for correspondence
items:
$ref: '#/components/schemas/CommonPhysicalAddress'
type: array
type: object
x-conditional:
- termDeposit
- creditCard
- loan
ResponseBankingTransactionList_data:
example:
transactions:
- postingDateTime: postingDateTime
amount: amount
apcaNumber: apcaNumber
isDetailAvailable: true
description: description
type: DIRECT_DEBIT
billerName: billerName
executionDateTime: executionDateTime
transactionId: transactionId
merchantName: merchantName
billerCode: billerCode
reference: reference
accountId: accountId
merchantCategoryCode: merchantCategoryCode
valueDateTime: valueDateTime
currency: currency
crn: crn
status: PENDING
- postingDateTime: postingDateTime
amount: amount
apcaNumber: apcaNumber
isDetailAvailable: true
description: description
type: DIRECT_DEBIT
billerName: billerName
executionDateTime: executionDateTime
transactionId: transactionId
merchantName: merchantName
billerCode: billerCode
reference: reference
accountId: accountId
merchantCategoryCode: merchantCategoryCode
valueDateTime: valueDateTime
currency: currency
crn: crn
status: PENDING
properties:
transactions:
items:
$ref: '#/components/schemas/BankingTransaction'
type: array
required:
- transactions
type: object
BankingTransactionDetail_allOf_extendedData_x2p101Payload:
properties:
extendedDescription:
description: An extended string description. Required if the extensionUType
field is `x2p101Payload`
type: string
endToEndId:
description: An end to end ID for the payment created at initiation
type: string
purposeCode:
description: Purpose of the payment. Format is defined by NPP standards
for the x2p1.01 overlay service
type: string
type: object
x-conditional:
- extendedDescription
BankingTransactionDetail_allOf_extendedData:
properties:
payer:
description: Label of the originating payer. Mandatory for inbound payment
type: string
payee:
description: Label of the target PayID. Mandatory for an outbound payment.
The name assigned to the BSB/Account Number or PayID (by the owner of
the PayID)
type: string
extensionUType:
description: Optional extended data specific to transactions originated
via NPP
enum:
- x2p101Payload
type: string
x2p101Payload:
$ref: '#/components/schemas/BankingTransactionDetail_allOf_extendedData_x2p101Payload'
service:
description: 'Identifier of the applicable overlay service. Valid values
are: X2P1.01'
enum:
- X2P1.01
type: string
required:
- service
type: object
x-conditional:
- payer
- payee
- x2p101Payload
BankingTransactionDetail_allOf:
properties:
extendedData:
$ref: '#/components/schemas/BankingTransactionDetail_allOf_extendedData'
required:
- extendedData
type: object
ResponseBankingAccountsBalanceList_data:
example:
balances:
- accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
- accountId: accountId
purses:
- amount: amount
currency: currency
- amount: amount
currency: currency
amortisedLimit: amortisedLimit
currentBalance: currentBalance
creditLimit: creditLimit
currency: currency
availableBalance: availableBalance
properties:
balances:
description: The list of balances returned
items:
$ref: '#/components/schemas/BankingBalance'
type: array
required:
- balances
type: object
ResponseBankingPayeeListV2_data:
example:
payees:
- nickname: nickname
description: description
payeeId: payeeId
type: BILLER
creationDate: creationDate
- nickname: nickname
description: description
payeeId: payeeId
type: BILLER
creationDate: creationDate
properties:
payees:
description: The list of payees returned
items:
$ref: '#/components/schemas/BankingPayeeV2'
type: array
required:
- payees
type: object
BankingPayeeDetailV2_allOf:
properties:
payeeUType:
description: Type of object included that describes the payee in detail
enum:
- biller
- digitalWallet
- domestic
- international
type: string
biller:
$ref: '#/components/schemas/BankingBillerPayee'
domestic:
$ref: '#/components/schemas/BankingDomesticPayee'
digitalWallet:
$ref: '#/components/schemas/BankingDigitalWalletPayee'
international:
$ref: '#/components/schemas/BankingInternationalPayee'
required:
- payeeUType
type: object
x-conditional:
- biller
- digitalWallet
- domestic
- international
BankingInternationalPayee_beneficiaryDetails:
example:
country: country
name: name
message: message
properties:
name:
description: Name of the beneficiary
type: string
country:
description: Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html)
country code
type: string
x-cds-type: ExternalRef
message:
description: Response message for the payment
type: string
required:
- country
type: object
BankingInternationalPayee_bankDetails_bankAddress:
example:
address: address
name: name
properties:
name:
description: Name of the recipient Bank
type: string
address:
description: Address of the recipient Bank
type: string
required:
- address
- name
type: object
BankingInternationalPayee_bankDetails:
example:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
properties:
country:
description: Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html)
country code
type: string
x-cds-type: ExternalRef
accountNumber:
description: Account Targeted for payment
type: string
bankAddress:
$ref: '#/components/schemas/BankingInternationalPayee_bankDetails_bankAddress'
beneficiaryBankBIC:
description: Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html)
type: string
x-cds-type: ExternalRef
fedWireNumber:
description: Number for Fedwire payment (Federal Reserve Wire Network)
type: string
sortCode:
description: Sort code used for account identification in some jurisdictions
type: string
chipNumber:
description: Number for the Clearing House Interbank Payments System
type: string
routingNumber:
description: International bank routing number
type: string
legalEntityIdentifier:
description: The legal entity identifier (LEI) for the beneficiary. Aligns
with [ISO 17442](https://www.iso.org/standard/59771.html)
type: string
x-cds-type: ExternalRef
required:
- accountNumber
- country
type: object
ResponseBankingDirectDebitAuthorisationList_data:
example:
directDebitAuthorisations:
- lastDebitAmount: lastDebitAmount
accountId: accountId
lastDebitDateTime: lastDebitDateTime
authorisedEntity:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
- lastDebitAmount: lastDebitAmount
accountId: accountId
lastDebitDateTime: lastDebitDateTime
authorisedEntity:
arbn: arbn
description: description
financialInstitution: financialInstitution
abn: abn
acn: acn
properties:
directDebitAuthorisations:
description: The list of authorisations returned
items:
$ref: '#/components/schemas/BankingDirectDebit'
type: array
required:
- directDebitAuthorisations
type: object
ResponseBankingScheduledPaymentsList_data:
example:
scheduledPayments:
- recurrence:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
scheduledPaymentId: scheduledPaymentId
payeeReference: payeeReference
payerReference: payerReference
nickname: nickname
from:
accountId: accountId
paymentSet:
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
status: ACTIVE
- recurrence:
nextPaymentDate: nextPaymentDate
eventBased:
description: description
onceOff:
paymentDate: paymentDate
recurrenceUType: eventBased
intervalSchedule:
intervals:
- interval: interval
dayInInterval: dayInInterval
- interval: interval
dayInInterval: dayInInterval
paymentsRemaining: 1
finalPaymentDate: finalPaymentDate
nonBusinessDayTreatment: "ON"
lastWeekDay:
paymentsRemaining: 1
interval: interval
finalPaymentDate: finalPaymentDate
lastWeekDay: FRI
nonBusinessDayTreatment: "ON"
scheduledPaymentId: scheduledPaymentId
payeeReference: payeeReference
payerReference: payerReference
nickname: nickname
from:
accountId: accountId
paymentSet:
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
- isAmountCalculated: true
amount: amount
currency: currency
to:
domestic:
payeeAccountUType: account
payId:
identifier: identifier
name: name
type: ABN
account:
bsb: bsb
accountName: accountName
accountNumber: accountNumber
card:
cardNumber: cardNumber
accountId: accountId
biller:
billerName: billerName
crn: crn
billerCode: billerCode
payeeReference: payeeReference
toUType: accountId
nickname: nickname
payeeId: payeeId
international:
bankDetails:
country: country
routingNumber: routingNumber
fedWireNumber: fedWireNumber
chipNumber: chipNumber
legalEntityIdentifier: legalEntityIdentifier
accountNumber: accountNumber
bankAddress:
address: address
name: name
sortCode: sortCode
beneficiaryBankBIC: beneficiaryBankBIC
beneficiaryDetails:
country: country
name: name
message: message
status: ACTIVE
properties:
scheduledPayments:
description: The list of scheduled payments to return
items:
$ref: '#/components/schemas/BankingScheduledPayment'
type: array
required:
- scheduledPayments
type: object
ResponseErrorListV2_errors:
properties:
code:
description: 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.
type: string
title:
description: A short, human-readable summary of the problem that MUST NOT
change from occurrence to occurrence of the problem represented by the
error code.
type: string
detail:
description: A human-readable explanation specific to this occurrence of
the problem.
type: string
meta:
$ref: '#/components/schemas/MetaError'
required:
- code
- detail
- title
type: object