Obtain scheduled, outgoing payments for a specific account.
-Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
+Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments.
-Obtain scheduled payments for a specified list of accounts.
-
Body parameter
@@ -4756,42 +4757,42 @@ query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -4805,14 +4806,14 @@ header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body
body
RequestAccountIds mandatory
-Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned
+Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.
@@ -4995,25 +4996,25 @@ [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] An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -5069,7 +5070,7 @@ Get Payees
Obtain a list of pre-registered payees.
-Obsolete versions: v1
+Obsolete versions: v1 .
Endpoint Version
@@ -5101,49 +5102,49 @@ Parameters
query
Enum optional
-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
+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.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -5157,7 +5158,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -5277,25 +5278,25 @@
200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -5353,7 +5354,7 @@ Get Payee Detail
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
+Obsolete versions: v1 .
Endpoint Version
@@ -5385,35 +5386,35 @@ Parameters
path
ASCIIString mandatory
-The ID used to locate the details of a particular payee
+The ID used to locate the details of a particular payee.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -5427,7 +5428,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -5561,31 +5562,31 @@
200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
404
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -5631,9 +5632,9 @@ Get Products
GET /banking/products
-Obtain a list of products that are currently openly offered to the market
+Obtain a list of products that are currently openly offered to the market.
-Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.
+Note that the results returned by this endpoint 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
@@ -5642,9 +5643,9 @@ Arrays Of Features
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 . 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.
+Each element has a field name additionalValue 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.
+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.
@@ -5652,17 +5653,17 @@
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.
+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.
+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 actually 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.
+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.
+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 , v2 , v3
+Obsolete versions: v1 , v2 , v3 .
Endpoint Version
@@ -5694,56 +5695,56 @@ Parameters
query
Enum optional
-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
+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.
updated-since
query
DateTimeString optional
-Only include products that have been updated after the specified date and time. If absent defaults to include all products
+Only include products that have been updated after the specified date and time. If absent defaults to include all products.
brand
query
string
optional
-Filter results based on a specific brand
+Filter results based on a specific brand.
product-category
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
+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.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
@@ -6001,7 +6002,7 @@ Get Product Detail
Obtain detailed information on a single product offered openly to the market.
-Obsolete versions: v1 , v2 , v3 , v4
+Obsolete versions: v1 , v2 , v3 , v4 .
Endpoint Version
@@ -6033,21 +6034,21 @@ Parameters
path
ASCIIString mandatory
-ID of the specific product requested
+ID of the specific product requested.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
@@ -6372,7 +6373,10 @@ Reques
-
+
+
{
"data" : {
"accountIds" : [
@@ -6417,7 +6421,10 @@
-
+
+
{
"data" : {
"products" : [
@@ -6517,7 +6524,7 @@ Properties
» products
[BankingProductV5 ]
mandatory
-The list of products returned. If the filter results in an empty set then this array may have no records
+The list of products returned. If the filter results in an empty set then this array may have no records.
links
@@ -6537,7 +6544,10 @@ Banking
-
+
+
{
"productId" : "string" ,
"effectiveFrom" : "string" ,
@@ -6620,49 +6630,49 @@ Properties
effectiveFrom
DateTimeString optional
-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
+The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate.
effectiveTo
DateTimeString optional
-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
+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.
lastUpdated
DateTimeString mandatory
-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)
+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).
productCategory
BankingProductCategoryV2 mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
name
string
mandatory
-The display name of the product
+The display name of the product.
description
string
mandatory
-A description of the product
+A description of the product.
brand
string
mandatory
-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
+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.
brandName
string
optional
-An optional display name of the brand
+An optional display name of the brand.
applicationUri
@@ -6674,19 +6684,19 @@ Properties
isTailored
Boolean mandatory
-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
+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.
additionalInformation
BankingProductAdditionalInformationV2 optional
-Object that contains links to additional information on specific topics
+Object that contains links to additional information on specific topics.
cardOption
BankingProductCardOption optional
-Information about the type of card available with the account
+Information about the type of card available with the account.
@@ -6694,7 +6704,10 @@
-
+
+
{
"cardScheme" : "AMEX" ,
"cardType" : "CHARGE" ,
@@ -6707,7 +6720,7 @@ }
Information about the type of card available with the account
+Information about the type of card available with the account.
Properties
@@ -6723,19 +6736,19 @@ Properties
cardScheme
Enum mandatory
-Card scheme available with the account
+Card scheme available with the account.
cardType
Enum mandatory
-Card type available with the account
+Card type available with the account.
cardImages
[BankingProductCardOption_cardImages ]
optional
-An array of card art images
+An array of card art images.
@@ -6789,7 +6802,10 @@
-
+
+
{
"title" : "string" ,
"imageUri" : "string"
@@ -6810,13 +6826,13 @@ Properti
title
string
optional
-Display label for the specific image
+Display label for the specific image.
imageUri
URIString mandatory
-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]
+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]
@@ -6824,7 +6840,10 @@
-
+
+
{
"overviewUri" : "string" ,
"termsUri" : "string" ,
@@ -6864,7 +6883,7 @@ }
Object that contains links to additional information on specific topics
+Object that contains links to additional information on specific topics.
@@ -6880,61 +6899,61 @@
+
+
{
"description" : "string" ,
"additionalInfoUri" : "string"
@@ -6963,13 +6985,13 @@ URIString
mandatory
-The URI describing the additional information
+The URI describing the additional information.
@@ -6977,7 +6999,10 @@
-
+
+
{
"data" : {
"productId" : "string" ,
@@ -7265,7 +7290,10 @@ B
-
+
+
{
"productId" : "string" ,
"effectiveFrom" : "string" ,
@@ -7553,49 +7581,49 @@ Properties
» bundles
[BankingProductBundle ]
optional
-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
+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.
» features
[BankingProductFeatureV3 ]
optional
-Array of features and limitations of the product
+Array of features and limitations of the product.
» constraints
[BankingProductConstraintV2 ]
optional
-Constraints on the application for the product such as minimum balances or limit thresholds
+Constraints on the application for the product such as minimum balances or limit thresholds.
» eligibility
[BankingProductEligibility ]
optional
-Eligibility criteria for the product
+Eligibility criteria for the product.
» fees
[BankingProductFeeV2 ]
optional
-Fees applicable to the product
+Fees applicable to the product.
» depositRates
[BankingProductDepositRateV2 ]
optional
-Interest rates available for deposits
+Interest rates available for deposits.
» lendingRates
[BankingProductLendingRateV3 ]
optional
-Interest rates charged against lending balances
+Interest rates charged against lending balances.
» instalments
BankingProductInstalments optional
-Details of instalment features on the account
+Details of instalment features on the account.
@@ -7603,7 +7631,10 @@ Ban
-
+
+
{
"name" : "string" ,
"description" : "string" ,
@@ -7629,31 +7660,31 @@ Properties
name
string
mandatory
-Name of the bundle
+Name of the bundle.
description
string
mandatory
-Description of the bundle
+Description of the bundle.
additionalInfo
string
optional
-Display text providing more information on the bundle
+Display text providing more information on the bundle.
additionalInfoUri
URIString optional
-Link to a web page with more information on the bundle criteria and benefits
+Link to a web page with more information on the bundle criteria and benefits.
productIds
[ASCIIString] optional
-Array of product IDs for products included in the bundle that are available via the product endpoints. 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 endpoints
+Array of product IDs for products included in the bundle that are available via the product endpoints. 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 endpoints.
@@ -7661,7 +7692,10 @@
-
+
+
{
"featureType" : "ADDITIONAL_CARDS" ,
"additionalValue" : "string" ,
@@ -7670,7 +7704,7 @@
}
Array of features and limitations of the product
+Array of features and limitations of the product.
Properties
@@ -7686,25 +7720,25 @@ Properties
featureType
Enum mandatory
-The type of feature described. For further details, refer to Product Feature Types
+The type of feature described. For further details, refer to Product Feature Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
+Generic field containing additional information relevant to the featureType featureType
additionalInfo
string
conditional
-Display text providing more information on the feature. Mandatory if the feature type is set to OTHER
+Display text providing more information on the feature. Mandatory if featureType OTHER.
additionalInfoUri
URIString optional
-Link to a web page with more information on this feature
+Link to a web page with more information on this feature.
@@ -7866,7 +7900,10 @@
-
+
+
{
"constraintType" : "MAX_BALANCE" ,
"additionalValue" : "string" ,
@@ -7889,25 +7926,25 @@ Properties
constraintType
Enum mandatory
-The type of constraint described. For further details, refer to Product Constraint Types
+The type of constraint described. For further details, refer to Product Constraint Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
+Generic field containing additional information relevant to the constraintType constraintType
additionalInfo
string
conditional
-Display text providing more information on the constraint. Mandatory if the constraint type is set to OTHER
+Display text providing more information on the constraint. Mandatory if the constraint type is set to OTHER.
additionalInfoUri
URIString optional
-Link to a web page with more information on the constraint
+Link to a web page with more information on the constraint.
@@ -7949,7 +7986,10 @@
-
+
+
{
"eligibilityType" : "BUSINESS" ,
"additionalValue" : "string" ,
@@ -7972,25 +8012,25 @@ Properties
eligibilityType
Enum mandatory
-The type of eligibility criteria described. For further details, refer to Product Eligibility Types
+The type of eligibility criteria described. For further details, refer to Product Eligibility Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
+Generic field containing additional information relevant to the eligibilityType eligibilityType
additionalInfo
string
conditional
-Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
+Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER.
additionalInfoUri
URIString optional
-Link to a web page with more information on this eligibility criteria
+Link to a web page with more information on this eligibility criteria.
@@ -8056,7 +8096,10 @@ Bank
-
+
+
{
"name" : "string" ,
"feeCategory" : "CARD" ,
@@ -8124,13 +8167,13 @@ Properties
name
string
mandatory
-Name of the fee
+Name of the fee.
feeCategory
Enum mandatory
-The category of fee, used to group feeType values. For further details, refer to Product Fee Categories .
+The category of fee, used to group feeType values. For further details, refer to Product Fee Categories .
feeType
@@ -8142,67 +8185,67 @@ Properties
feeMethodUType
Enum mandatory
-The fee charge method
+The fee charge method.
fixedAmount
BankingFeeAmount conditional
-Present if feeMethodUType is set to fixedAmount. Where the fee is a specific amount
+Present if feeMethodUType is set to fixedAmount. Where the fee is a specific amount.
rateBased
BankingFeeRate conditional
-Present if feeMethodUType is set to rateBased. Where the fee is based on a type of rate
+Present if feeMethodUType is set to rateBased. Where the fee is based on a type of rate.
variable
BankingFeeRange conditional
-Present if feeMethodUType is set to variable. Where the amount or rate may not be known until the fee is incurred
+Present if feeMethodUType is set to variable. Where the amount or rate may not be known until the fee is incurred.
feeCap
AmountString optional
-The cap amount if multiple occurrences of the fee are capped to a limit
+The cap amount if multiple occurrences of the fee are capped to a limit.
feeCapPeriod
ExternalRef optional
-Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
currency
CurrencyString optional
-The currency the fee will be charged in. Assumes AUD if absent
+The currency the fee will be charged in. Assumes AUD if absent.
additionalValue
string
conditional
-Generic field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
+Generic field containing additional information relevant to the feeType feeType
additionalInfo
string
conditional
-Display text providing more information on the fee
+Display text providing more information on the fee.
additionalInfoUri
URIString optional
-Link to a web page with more information on this fee
+Link to a web page with more information on this fee.
discounts
[BankingProductDiscount ]
optional
-An optional list of discounts to this fee that may be available
+An optional list of discounts to this fee that may be available.
@@ -8368,7 +8411,10 @@ Banking
-
+
+
{
"amount" : "string"
}
@@ -8388,7 +8434,7 @@ Properties
amount
AmountString mandatory
-The specific amount charged for the fee each time it is incurred
+The specific amount charged for the fee each time it is incurred.
@@ -8396,7 +8442,10 @@ BankingFe
-
+
+
{
"balanceRate" : "string" ,
"transactionRate" : "string" ,
@@ -8423,31 +8472,31 @@ Properties
balanceRate
RateString conditional
-A fee rate calculated based on a proportion of the balance. One of balanceRate, transactionRate and accruedRate is mandatory
+A fee rate calculated based on a proportion of the balance. One of balanceRate , transactionRate and accruedRate is mandatory.
transactionRate
RateString conditional
-A fee rate calculated based on a proportion of a transaction. One of balanceRate, transactionRate and accruedRate is mandatory
+A fee rate calculated based on a proportion of a transaction. One of balanceRate , transactionRate and accruedRate is mandatory.
accruedRate
RateString conditional
-A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of balanceRate, transactionRate and accruedRate is mandatory
+A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of balanceRate , transactionRate and accruedRate is mandatory.
accrualFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
amountRange
BankingFeeRange optional
-A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred
+A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.
@@ -8455,14 +8504,17 @@ BankingF
-
+
+
{
"feeMinimum" : "string" ,
"feeMaximum" : "string"
}
A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred
+A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.
Properties
@@ -8478,13 +8530,13 @@ Properties
feeMinimum
AmountString optional
-The minimum fee that will be charged per occurrence
+The minimum fee that will be charged per occurrence.
feeMaximum
AmountString optional
-The maximum fee that will be charged per occurrence
+The maximum fee that will be charged per occurrence.
@@ -8492,7 +8544,10 @@ B
-
+
+
{
"description" : "string" ,
"discountType" : "BALANCE" ,
@@ -8529,67 +8584,67 @@ Properties
description
string
mandatory
-Description of the discount
+Description of the discount.
discountType
Enum mandatory
-The type of discount. For further details, refer to Product Discount Types
+The type of discount. For further details, refer to Product Discount Types .
amount
AmountString conditional
-Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
+Dollar value of the discount. One of amount , balanceRate , transactionRate , accruedRate and feeRate is mandatory.
balanceRate
RateString conditional
-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
+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.
transactionRate
RateString conditional
-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.
+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.
accruedRate
RateString conditional
-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
+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.
feeRate
RateString conditional
-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
+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.
additionalValue
string
conditional
-Generic field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
+Generic field containing additional information relevant to the discountType discountType
additionalInfo
string
optional
-Display text providing more information on the discount
+Display text providing more information on the discount.
additionalInfoUri
URIString optional
-Link to a web page with more information on this discount
+Link to a web page with more information on this discount.
eligibility
[BankingProductDiscountEligibility ]
conditional
-Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
@@ -8627,7 +8682,10 @@
-
+
+
{
"discountEligibilityType" : "BUSINESS" ,
"additionalValue" : "string" ,
@@ -8650,25 +8708,25 @@ Properties
discountEligibilityType
Enum mandatory
-The type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types
+The type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
+Generic field containing additional information relevant to the discountEligibilityType discountEligibilityType
additionalInfo
string
conditional
-Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
+Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUri
URIString optional
-Link to a web page with more information on this eligibility constraint
+Link to a web page with more information on this eligibility constraint.
@@ -8738,7 +8796,10 @@
-
+
+
{
"depositRateType" : "VARIABLE" ,
"rate" : "string" ,
@@ -8794,73 +8855,73 @@ Properties
depositRateType
Enum mandatory
-The type of rate (FIXED, VARIABLE, BONUS, etc). For further details, refer to Product Deposit Rate Types
+The type of rate (FIXED, VARIABLE, BONUS, etc.) For further details, refer to Product Deposit Rate Types .
rate
RateString mandatory
-The rate to be applied
+The rate to be applied.
adjustmentToBase
Enum optional
-For an adjustment depositRateType, the base rate that the adjustment value will apply to. The value of the additionalValue field may be used to further qualify the corresponding base.
+For an adjustment depositRateType , the base rate that the adjustment value will apply to. The value of the additionalValue field may be used to further qualify the corresponding base.
adjustmentBundle
string
optional
-The name of the bundle that makes the adjustment rate applicable
+The name of the bundle that makes the adjustment rate applicable.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationType
Enum optional
-The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
+The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC.
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
tiers
[BankingProductRateTierV4 ]
optional
-Rate tiers applicable for this rate
+Rate tiers applicable for this rate.
applicabilityConditions
[BankingProductRateConditionV2 ]
optional
-Array of applicability conditions for a rate
+Array of applicability conditions for a rate.
additionalValue
string
conditional
-Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
+Generic field containing additional information relevant to the depositRateType depositRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -8926,7 +8987,10 @@
-
+
+
{
"lendingRateType" : "DISCOUNT" ,
"rate" : "string" ,
@@ -8989,25 +9053,25 @@ Properties
lendingRateType
Enum mandatory
-The type of rate (fixed, variable, etc). For further details, refer to Product Lending Rate Types
+The type of rate (FIXED, VARIABLE, etc.) For further details, refer to Product Lending Rate Types .
rate
RateString conditional
-The rate to be applied. Mandatory unless the lendingRateType FEE is supplied
+The rate to be applied. Mandatory unless the lendingRateType FEE is supplied.
referenceRate
RateString optional
-The reference or index rate for this account option, or variant
+The reference or index rate for this account option, or variant.
comparisonRate
RateString optional
-A comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' lendingRateType is the full comparison rate assuming the adjusted rate is available for origination.
+A comparison rate equivalent for this rate. The comparison rate associated with an 'adjustment' lendingRateType
revertRate
@@ -9019,85 +9083,85 @@ Properties
revertProductId
string
optional
-A reference to a productId that the associated product will revert to after the respective rate terms expire. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.
+A reference to a productId that the associated product will revert to after the respective rate terms expire. For example, FIXED, or INTEREST_ONLY rates may revert to a different rate when those terms expire. Expected if the product will change when the rate reverts to different terms.
adjustmentToBase
Enum optional
-For an adjustment lendingRateType, the base rate that the adjustment value will apply to. The values of the repaymentType, loanPurpose and additionalValue fields may be used to further qualify the corresponding base.
+For an adjustment lendingRateType , the base rate that the adjustment value will apply to. The values of the repaymentType , loanPurpose and additionalValue fields may be used to further qualify the corresponding base.
adjustmentBundle
string
optional
-The name of the bundle that makes the adjustment rate applicable
+The name of the bundle that makes the adjustment rate applicable.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationType
Enum optional
-The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
+The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC.
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
interestPaymentDue
Enum optional
-When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
+When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.
repaymentType
Enum optional
-Options in place for repayments. If absent, the lending rate is applicable to all repayment types
+Options in place for repayments. If absent, the lending rate is applicable to all repayment types.
loanPurpose
Enum optional
-The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
+The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes.
tiers
[BankingProductRateTierV4 ]
optional
-Rate tiers applicable for this rate
+Rate tiers applicable for this rate.
applicabilityConditions
[BankingProductRateConditionV2 ]
optional
-Array of applicability conditions for a rate
+Array of applicability conditions for a rate.
additionalValue
string
conditional
-Generic field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
+Generic field containing additional information relevant to the lendingRateType lendingRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -9227,7 +9291,10 @@
-
+
+
{
"name" : "string" ,
"unitOfMeasure" : "DAY" ,
@@ -9247,7 +9314,7 @@ }
Defines the criteria and conditions for which a rate applies
+Defines the criteria and conditions for which a rate applies.
Properties
@@ -9263,49 +9330,49 @@ Properties
name
string
mandatory
-A display name for the tier
+A display name for the tier.
unitOfMeasure
Enum mandatory
-The unit of measure that applies to the minimumValue and maximumValue values, e.g.:DOLLAR for a dollar amount (with values in AmountString format)PERCENT for Loan-to-Value Ratio or LVR (with values in RateString format)MONTH or DAY for a period representing a discrete number of months or days for a fixed-term deposit or loan (with values as a string containing a positive integer)
+The unit of measure that applies to the minimumValue and maximumValue values, e.g.,DOLLAR for a dollar amount (with values in AmountString format)PERCENT for Loan-to-Value Ratio or LVR (with values in RateString format)MONTH or DAY for a period representing a discrete number of months or days for a fixed-term deposit or loan (with values as a string containing a positive integer).
minimumValue
string
mandatory
-The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
+The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value.
maximumValue
string
optional
-The number of unitOfMeasure 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 minimumValue. Where this is the same as the minimumValue 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.
+The number of unitOfMeasure 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 minimumValue . Where this is the same as the minimumValue 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.
rateApplicationMethod
Enum optional
-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')
+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').
applicabilityConditions
[BankingProductRateConditionV2 ]
optional
-Array of applicability conditions for a tier
+Array of applicability conditions for a tier.
additionalInfo
string
optional
-Display text providing more information on the rate tier
+Display text providing more information on the rate tier.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate tier
+Link to a web page with more information on this rate tier.
@@ -9347,7 +9414,10 @@
-
+
+
{
"rateApplicabilityType" : "NEW_CUSTOMER" ,
"additionalValue" : "string" ,
@@ -9356,7 +9426,7 @@ }
Defines a condition for the applicability of a tiered rate
+Defines a condition for the applicability of a tiered rate.
Properties
@@ -9372,25 +9442,25 @@ Properties rateApplicabilityType
Enum optional
-Category of applicability condition associated with the rate. For more information refer to Rate and Tier Applicability Types
+Category of applicability condition associated with the rate. For more information refer to Rate and Tier Applicability Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the rateApplicabilityType specified. Whether mandatory or not is dependent on the value of rateApplicabilityType
+Generic field containing additional information relevant to the rateApplicabilityType specified. Whether mandatory or not is dependent on the value of rateApplicabilityType
additionalInfo
string
conditional
-Display text providing more information on the condition
+Display text providing more information on the condition.
additionalInfoUri
URIString optional
-Link to a web page with more information on this condition
+Link to a web page with more information on this condition.
@@ -9456,7 +9526,10 @@
-
+
+
{
"maximumPlanCount" : 1 ,
"instalmentsLimit" : "string" ,
@@ -9481,37 +9554,37 @@ Properties
maximumPlanCount
PositiveInteger mandatory
-Total number of plans that may be created
+Total number of plans that may be created.
instalmentsLimit
AmountString mandatory
-Maximum combined limit of all instalment plans that may be created
+Maximum combined limit of all instalment plans that may be created.
minimumPlanValue
AmountString mandatory
-Minimum value that can be opened as an instalment plan
+Minimum value that can be opened as an instalment plan.
maximumPlanValue
AmountString mandatory
-Maximum value that can be opened as an instalment plan
+Maximum value that can be opened as an instalment plan.
minimumSplit
PositiveInteger mandatory
-Minimum number of instalment payments a plan can be created with
+Minimum number of instalment payments a plan can be created with.
maximumSplit
PositiveInteger mandatory
-Maximum number of instalment payments a plan can be created with
+Maximum number of instalment payments a plan can be created with.
@@ -9519,7 +9592,10 @@
-
+
+
{
"data" : {
"accounts" : [
@@ -9571,7 +9647,7 @@ Properties
» accounts
[BankingAccountV3 ]
mandatory
-The list of accounts returned. If the filter results in an empty set then this array may have no records
+The list of accounts returned. If the filter results in an empty set then this array may have no records.
links
@@ -9591,7 +9667,10 @@ Banking
-
+
+
{
"accountId" : "string" ,
"creationDate" : "string" ,
@@ -9620,13 +9699,13 @@ Properties
accountId
ASCIIString mandatory
-A unique ID of the account adhering to the standards for ID permanence
+A unique ID of the account adhering to the standards for ID permanence.
creationDate
DateString optional
-Date that the account was created (if known)
+Date that the account was created (if known).
displayName
@@ -9638,43 +9717,43 @@ Properties
nickname
string
optional
-A customer supplied nick name for the account
+A customer supplied nick name for the account.
openStatus
Enum optional
-Open or closed status for the account. If not present then OPEN is assumed
+Open or closed status for the account. If not present then OPEN is assumed.
isOwned
Boolean optional
-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
+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.
accountOwnership
Enum mandatory
-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
+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.
maskedNumber
MaskedAccountString mandatory
-A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
+A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number.
productCategory
BankingProductCategoryV2 mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
productName
string
mandatory
-The unique identifier of the account as defined by the data holder (akin to model number for the account)
+The unique identifier of the account as defined by the data holder (akin to model number for the account).
@@ -9720,7 +9799,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -10157,7 +10239,10 @@ B
-
+
+
{
"accountId" : "string" ,
"creationDate" : "string" ,
@@ -10594,61 +10679,61 @@ Properties
» bsb
string
optional
-The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
+The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
» accountNumber
string
optional
-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
+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.
» bundleName
string
optional
-Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
+Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.
» cardOption
BankingProductCardOption optional
-Information about the type of card available with the account
+Information about the type of card available with the account.
» instalments
BankingAccountInstalments optional
-Details of instalment features on the account
+Details of instalment features on the account.
» termDeposit
[BankingTermDepositAccountV2 ]
optional
-A structure suited to accounts that have term deposit-like features
+A structure suited to accounts that have term deposit-like features.
» creditCard
BankingCreditCardAccountV2 optional
-A structure suited to accounts that have credit card-like features
+A structure suited to accounts that have credit card-like features.
» loan
BankingLoanAccountV3 optional
-A structure suited to accounts that have loan-like features
+A structure suited to accounts that have loan-like features.
» deposit
BankingDepositAccount optional
-A structure suited to accounts that have deposit-like features without term deposit maturity detail
+A structure suited to accounts that have deposit-like features without term deposit maturity detail.
» features
[allOf]
optional
-Array of features of the account based on the equivalent structure in Product Reference with the following additional field
+Array of features of the account based on the equivalent structure in Product Reference with the following additional field.
@@ -10666,7 +10751,7 @@ Properties
»» anonymous
BankingProductFeatureV3 mandatory
-Array of features and limitations of the product
+Array of features and limitations of the product.
@@ -10690,7 +10775,7 @@ Properties
»»» isActivated
Boolean optional
-true if the feature has been activated by the customer or is a standard feature of the product.false if the feature is not activated but is available for activation.null or absent if the activation state is unknown.true if the feature has been activated by the customer or is a standard feature of the product.false if the feature is not activated but is available for activation.null or absent if the activation state is unknown.Properties
» fees
[BankingProductFeeV2 ]
optional
-Fees and charges applicable to the account based on the equivalent structure in Product Reference
+Fees and charges applicable to the account based on the equivalent structure in Product Reference.
» addresses
[CommonPhysicalAddress ]
optional
-The addresses for the account to be used for correspondence
+The addresses for the account to be used for correspondence.
@@ -10722,7 +10807,10 @@
-
+
+
{
"maximumPlanCount" : 1 ,
"instalmentsLimit" : "string" ,
@@ -10748,7 +10836,7 @@ }
Details of instalment features on the account
+Details of instalment features on the account.
Properties
@@ -10790,7 +10878,7 @@ Properties
» plans
[BankingInstalmentPlans ]
optional
-Array of instalment plans
+Array of instalment plans.
@@ -10798,7 +10886,10 @@ B
-
+
+
{
"planNickname" : "string" ,
"creationDate" : "string" ,
@@ -10828,37 +10919,37 @@ Properties
planNickname
string
mandatory
-The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels
+The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels.
creationDate
DateString mandatory
-The date the plan was created
+The date the plan was created.
amount
AmountString mandatory
-The total amount of the plan
+The total amount of the plan.
duration
ExternalRef mandatory
-The original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
instalmentInterval
ExternalRef mandatory
-The expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
schedule
[BankingInstalmentPlanSchedule ]
mandatory
-Array of expected repayment amounts and dates
+Array of expected repayment amounts and dates.
@@ -10866,7 +10957,10 @@
-
+
+
{
"amountDue" : "string" ,
"dueDate" : "string"
@@ -10887,13 +10981,13 @@ Properties amountDue
AmountString mandatory
-Amount due with this repayment
+Amount due with this repayment.
dueDate
DateString mandatory
-Date this repayment is due
+Date this repayment is due.
@@ -10901,7 +10995,10 @@
-
+
+
{
"lodgementDate" : "string" ,
"maturityDate" : "string" ,
@@ -10977,37 +11074,37 @@ Properties
lodgementDate
DateString mandatory
-The lodgement date of the original deposit
+The lodgement date of the original deposit.
maturityDate
DateString mandatory
-Maturity date for the term deposit
+Maturity date for the term deposit.
maturityAmount
AmountString optional
-Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
+Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated.
maturityCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
maturityInstructions
Enum mandatory
-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
+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.
depositRateDetail
BankingDepositRateDetail optional
-Detail about deposit rates and adjustments
+Detail about deposit rates and adjustments.
@@ -11037,7 +11134,10 @@
-
+
+
{
"depositRateType" : "FIXED" ,
"referenceRate" : "string" ,
@@ -11092,7 +11192,7 @@ }
Detail about deposit rates and adjustments
+Detail about deposit rates and adjustments.
Properties
@@ -11108,73 +11208,73 @@ Properties
depositRateType
Enum mandatory
-The type of rate
+The type of rate.
referenceRate
RateString mandatory
-Reference rate for this account type and terms
+Reference rate for this account type and terms.
effectiveRate
RateString mandatory
-Rate being paid for this deposit
+Rate being paid for this deposit.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationType
Enum optional
-The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
+The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC.
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
tiers
[BankingProductRateTierV4 ]
optional
-Rate tiers applicable for this rate
+Rate tiers applicable for this rate.
applicabilityConditions
[BankingProductRateConditionV2 ]
optional
-Array of applicability conditions for a rate
+Array of applicability conditions for a rate.
additionalValue
string
conditional
-Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
+Generic field containing additional information relevant to the depositRateType depositRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
adjustments
[BankingRateAdjustments ]
optional
-Adjustments applicable to the rate
+Adjustments applicable to the rate.
@@ -11220,7 +11320,10 @@ B
-
+
+
{
"adjustmentType" : "BONUS" ,
"amount" : "string" ,
@@ -11235,7 +11338,7 @@ B
}
Information about adjustments to an associated rate
+Information about adjustments to an associated rate.
Properties
@@ -11251,61 +11354,61 @@ Properties
adjustmentType
Enum mandatory
-The type of adjustment. For further details, refer to Deposit Adjustment Rate Types and Lending Adjustment Rate Types
+The type of adjustment. For further details, refer to Deposit Adjustment Rate Types and Lending Adjustment Rate Types .
amount
AmountString optional
-Adjustment amount if not a rate
+Adjustment amount if not a rate.
currency
CurrencyString optional
-Adjustment amount currency. If absent assumes AUD
+Adjustment amount currency. If absent assumes AUD.
rate
RateString optional
-Adjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the adjustmentType (bonus, discount or penalty)
+Adjustment to an associated base rate. The impact to the base rate depends on the type of base (deposit or loan) and the adjustmentType (BONUS, DISCOUNT or PENALTY).
adjustmentBundle
string
optional
-The name of the bundle that makes the adjustment rate applicable
+The name of the bundle that makes the adjustment rate applicable.
adjustmentPeriod
ExternalRef optional
-The original or standard adjustment period after which the adjustment ends. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The original or standard adjustment period after which the adjustment ends. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
adjustmentEndDate
DateString optional
-Date the adjustment will cease to apply
+Date the adjustment will cease to apply.
additionalValue
string
conditional
-Generic field containing additional information relevant to the adjustmentType specified. Whether mandatory or not is dependent on the value of adjustmentType
+Generic field containing additional information relevant to the adjustmentType specified. Whether mandatory or not is dependent on the value of adjustmentType .
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -11335,7 +11438,10 @@
-
+
+
{
"minPaymentAmount" : "string" ,
"paymentDueAmount" : "string" ,
@@ -11406,25 +11512,25 @@ Properties
minPaymentAmount
AmountString mandatory
-The minimum payment amount due for the next card payment
+The minimum payment amount due for the next card payment.
paymentDueAmount
AmountString mandatory
-The amount due for the next card payment
+The amount due for the next card payment.
paymentCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
paymentDueDate
DateString mandatory
-Date that the next payment for the card is due
+Date that the next payment for the card is due.
cardPlans
@@ -11438,7 +11544,10 @@ Ba
-
+
+
{
"nickname" : "string" ,
"planType" : "PURCHASE_PLAN" ,
@@ -11501,85 +11610,85 @@ Properties
nickname
string
optional
-A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
+A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided.
planType
BankingCardPlanTypes mandatory
-The credit card plan type
+The credit card plan type.
atExpiryBalanceTransfersTo
BankingCardPlanTypes optional
-A reference to the plan type that any balance will be transferred to at the expiry of this plan
+A reference to the plan type that any balance will be transferred to at the expiry of this plan.
planCreationDate
DateString optional
-Date this plan was created
+Date this plan was created.
planPeriod
ExternalRef optional
-Original duration for this plan. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+Original duration for this plan. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
planEndDate
DateString optional
-Date this plan is expected to end
+Date this plan is expected to end.
planReferenceRate
RateString mandatory
-Reference rate for this plan type
+Reference rate for this plan type.
planEffectiveRate
RateString mandatory
-Effective rate for this plan
+Effective rate for this plan.
minPaymentAmount
AmountString optional
-The minimum payment amount due for this plan
+The minimum payment amount due for this plan.
paymentDueAmount
AmountString optional
-The amount due for this plan
+The amount due for this plan.
paymentCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
paymentDueDate
DateString optional
-Date that the next payment for this plan is due
+Date that the next payment for this plan is due.
additionalInfo
string
optional
-Display text providing more information on the plan
+Display text providing more information on the plan.
additionalInfoUri
URIString optional
-Link to a web page with more information on this plan
+Link to a web page with more information on this plan.
interestFreePeriods
@@ -11591,25 +11700,25 @@ Properties
» from
DateString optional
-The date any associated interest-free period will be available for the plan
+The date any associated interest-free period will be available for the plan.
» to
DateString mandatory
-The date any associated interest-free period will no longer be available
+The date any associated interest-free period will no longer be available.
adjustments
[BankingRateAdjustments ]
optional
-Adjustments applicable to the plan rate
+Adjustments applicable to the plan rate.
planFeatures
[BankingCardPlanFeatures ]
optional
-Array of features available or applicable to this plan
+Array of features available or applicable to this plan.
@@ -11617,7 +11726,10 @@ Ban
-
+
+
"PURCHASE_PLAN"
-
+
+
{
"planFeatureType" : "BALANCE_TRANSFER_ENDS_INTEREST_FREE" ,
"period" : "string" ,
@@ -11680,7 +11795,7 @@
}
Features and limitations available or applicable to the associated plan
+Features and limitations available or applicable to the associated plan.
Properties
@@ -11702,31 +11817,31 @@ Properties
period
ExternalRef optional
-Original duration of the feature or limitation. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+Original duration of the feature or limitation. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
endDate
DateString optional
-Date that the feature or limitation will cease to apply
+Date that the feature or limitation will cease to apply.
additionalValue
string
conditional
-Detail associated with the planFeatureType. For details refer to Plan Feature Types .
+Detail associated with the planFeatureType . For details refer to Plan Feature Types .
additionalInfo
string
optional
-Display text providing more information on the plan feature
+Display text providing more information on the plan feature.
additionalInfoUri
URIString optional
-Link to a web page with more information on this plan feature
+Link to a web page with more information on this plan feature.
@@ -11756,7 +11871,10 @@ Ba
-
+
+
{
"lodgementDate" : "string" ,
"nickname" : "string" ,
@@ -11829,19 +11947,19 @@ Properties
lodgementDate
DateString optional
-The lodgement date of the deposit
+The lodgement date of the deposit.
nickname
DateString optional
-A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided
+A short display name of the deposit amount if provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank consistent with existing digital banking channels may be provided.
depositRateDetail
BankingDepositRateDetail optional
-Detail about deposit rates and adjustments
+Detail about deposit rates and adjustments.
@@ -11849,7 +11967,10 @@ Ban
-
+
+
{
"originalStartDate" : "string" ,
"originalLoanAmount" : "string" ,
@@ -11940,85 +12061,85 @@ Properties
originalStartDate
DateString optional
-Optional original start date for the loan
+Optional original start date for the loan.
originalLoanAmount
AmountString optional
-Optional original loan value
+Optional original loan value.
originalLoanCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
loanEndDate
DateString optional
-Date that the loan is due to be repaid in full
+Date that the loan is due to be repaid in full.
nextInstalmentDate
DateString optional
-Next date that an instalment is required
+Next date that an instalment is required.
minInstalmentAmount
AmountString optional
-Minimum amount of next instalment
+Minimum amount of next instalment.
minInstalmentCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
maxRedraw
AmountString optional
-Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
+Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account.
maxRedrawCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
minRedraw
AmountString optional
-Minimum redraw amount
+Minimum redraw amount.
minRedrawCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
offsetAccountEnabled
Boolean optional
-Set to true if one or more offset accounts are configured for this loan account
+Set to true if one or more offset accounts are configured for this loan account.
offsetAccountIds
[ASCIIString] optional
-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
+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.
lendingRateDetail
[BankingLendingRateDetail ]
optional
-Information about lending rates and adjustments
+Information about lending rates and adjustments.
@@ -12026,7 +12147,10 @@
-
+
+
{
"loanPurpose" : "OWNER_OCCUPIED" ,
"repaymentType" : "PRINCIPAL_AND_INTEREST" ,
@@ -12100,13 +12224,13 @@ Properties
loanPurpose
Enum optional
-The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
+The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes.
repaymentType
Enum optional
-Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
+Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST.
rateStartDate
@@ -12124,13 +12248,13 @@ Properties
revertProductId
string
optional
-The productId of the product that this account will revert to at the specified rateEndDate
+The productId of the product that this account will revert to at the specified rateEndDate .
repaymentUType
Enum mandatory
-The type of structure to present account specific fields
+The type of structure to present account specific fields.
fixedRate
@@ -12154,7 +12278,7 @@ Properties
adjustments
[BankingRateAdjustments ]
optional
-Adjustments applicable to the rate or fee
+Adjustments applicable to the rate or fee.
@@ -12204,7 +12328,10 @@
-
+
+
{
"fixedPeriod" : "string" ,
"referenceRate" : "string" ,
@@ -12233,61 +12360,61 @@ Properties
fixedPeriod
ExternalRef optional
-The period of time for the fixed rate. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The period of time for the fixed rate. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
referenceRate
RateString mandatory
-Reference rate for this account type and terms
+Reference rate for this account type and terms.
effectiveRate
RateString mandatory
-The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
+The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationType
Enum optional
-The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
+The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC.
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
interestPaymentDue
Enum optional
-When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
+When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.
repaymentFrequency
ExternalRef optional
-The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -12325,7 +12452,10 @@
-
+
+
{
"variableRateType" : "FLOATING" ,
"referenceRate" : "string" ,
@@ -12355,67 +12485,67 @@ Properties
variableRateType
Enum mandatory
-The type of variable rate
+The type of variable rate.
referenceRate
RateString mandatory
-Reference rate for this account type and terms
+Reference rate for this account type and terms.
effectiveRate
RateString mandatory
-The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
+The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationType
Enum optional
-The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC
+The type of approach used to apply the rate to the account. An applicationFrequency value is only expected when the approach is PERIODIC.
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
interestPaymentDue
Enum optional
-When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
+When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.
repaymentFrequency
ExternalRef optional
-The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
additionalValue
string
conditional
-Generic field containing additional information relevant to the variableRateType specified. Whether mandatory or not is dependent on the value of variableRateType
+Generic field containing additional information relevant to the variableRateType variableRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -12465,7 +12595,10 @@ Bankin
-
+
+
{
"amount" : "string" ,
"currency" : "string" ,
@@ -12490,37 +12623,37 @@ Properties
amount
AmountString mandatory
-Minimum payment due at specified repaymentFrequency
+Minimum payment due at specified repaymentFrequency .
currency
CurrencyString optional
-Currency of the fee. AUD assumed if not present
+Currency of the fee. AUD assumed if not present.
repaymentDue
Enum optional
-When loan payments are due to be paid within each period
+When loan payments are due to be paid within each period.
repaymentFrequency
ExternalRef optional
-The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
additionalInfo
string
optional
-Display text providing more information on the fee
+Display text providing more information on the fee.
additionalInfoUri
URIString optional
-Link to a web page with more information on this fee
+Link to a web page with more information on this fee.
@@ -12546,7 +12679,10 @@
-
+
+
{
"data" : {
"transactions" : [
@@ -12627,7 +12763,10 @@ Banki
-
+
+
{
"accountId" : "string" ,
"transactionId" : "string" ,
@@ -12664,97 +12803,97 @@ Properties
accountId
ASCIIString mandatory
-ID of the account for which transactions are provided
+ID of the account for which transactions are provided.
transactionId
ASCIIString conditional
-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.
+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.
isDetailAvailable
Boolean mandatory
-true if extended information is available using the transaction detail endpoint. false if extended data is not availabletrue if extended information is available using the transaction detail endpoint. false if extended data is not available.
type
Enum mandatory
-The type of the transaction
+The type of the transaction.
status
Enum mandatory
-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
+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.
description
string
mandatory
-The transaction description as applied by the financial institution
+The transaction description as applied by the financial institution.
postingDateTime
DateTimeString conditional
-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
+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.
valueDateTime
DateTimeString optional
-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
+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.
executionDateTime
DateTimeString optional
-The time the transaction was executed by the originating customer, if available
+The time the transaction was executed by the originating customer, if available.
amount
AmountString mandatory
-The value of the transaction. Negative values mean money was outgoing from the account
+The value of the transaction. Negative values mean money was outgoing from the account.
currency
CurrencyString optional
-The currency for the transaction amount. AUD assumed if not present
+The currency for the transaction amount. AUD assumed if not present.
reference
string
mandatory
-The reference for the transaction provided by the originating institution. Empty string if no data provided
+The reference for the transaction provided by the originating institution. Empty string if no data provided.
merchantName
string
optional
-Name of the merchant for an outgoing payment to a merchant
+Name of the merchant for an outgoing payment to a merchant.
merchantCategoryCode
string
optional
-The merchant category code (or MCC) for an outgoing payment to a merchant
+The merchant category code (or MCC) for an outgoing payment to a merchant.
billerCode
string
optional
-BPAY Biller Code for the transaction (if available)
+BPAY Biller Code for the transaction (if available).
billerName
string
optional
-Name of the BPAY biller for the transaction (if available)
+Name of the BPAY biller for the transaction (if available).
crn
@@ -12824,7 +12963,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -12898,7 +13040,10 @@
-
+
+
{
"accountId" : "string" ,
"transactionId" : "string" ,
@@ -12978,19 +13123,19 @@ Properties
»» payer
string
conditional
-Label of the originating payer. Mandatory for inbound payment
+Label of the originating payer. Mandatory for inbound payment.
»» payee
string
conditional
-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)
+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).
»» extensionUType
Enum optional
-Optional extended data specific to transactions originated via NPP
+Optional extended data specific to transactions originated via NPP.
»» x2p101Payload
@@ -13002,25 +13147,25 @@ Properties
»»» extendedDescription
string
conditional
-An extended string description. Required if the extensionUType field is x2p101Payload
+An extended string description. Required if the extensionUType field is x2p101Payload.
»»» endToEndId
string
optional
-An end to end ID for the payment created at initiation
+An end to end ID for the payment created at initiation.
»»» purposeCode
string
optional
-Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service
+Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service.
»» service
Enum mandatory
-Identifier of the applicable overlay service. Valid values are: X2P1.01
+Identifier of the applicable overlay service. Valid values are: X2P1.01.
@@ -13046,7 +13191,10 @@
-
+
+
{
"data" : {
"balances" : [
@@ -13100,7 +13248,7 @@ Propertie
» balances
[BankingBalance ]
mandatory
-The list of balances returned
+The list of balances returned.
links
@@ -13120,7 +13268,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -13177,7 +13328,10 @@ BankingBa
-
+
+
{
"accountId" : "string" ,
"currentBalance" : "string" ,
@@ -13208,43 +13362,43 @@ Properties
accountId
ASCIIString mandatory
-A unique ID of the account adhering to the standards for ID permanence
+A unique ID of the account adhering to the standards for ID permanence.
currentBalance
AmountString mandatory
-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
+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.
availableBalance
AmountString mandatory
-Balance representing the amount of funds available for transfer. Assumed to be zero or positive
+Balance representing the amount of funds available for transfer. Assumed to be zero or positive.
creditLimit
AmountString optional
-Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
+Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent.
amortisedLimit
AmountString optional
-Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent
+Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent.
currency
CurrencyString optional
-The currency for the balance amounts. If absent assumed to be AUD
+The currency for the balance amounts. If absent assumed to be AUD.
purses
[BankingBalancePurse ]
optional
-Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
+Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards.
@@ -13252,7 +13406,10 @@ Bank
-
+
+
{
"amount" : "string" ,
"currency" : "string"
@@ -13273,13 +13430,13 @@ Properties
amount
AmountString mandatory
-The balance available for this additional currency purse
+The balance available for this additional currency purse.
currency
CurrencyString optional
-The currency for the purse
+The currency for the purse.
@@ -13287,7 +13444,10 @@
-
+
+
{
"data" : {
"payees" : [
@@ -13334,7 +13494,7 @@ Properties
» payees
[BankingPayeeV2 ]
mandatory
-The list of payees returned
+The list of payees returned.
links
@@ -13354,7 +13514,10 @@
-
+
+
{
"data" : {
"payeeId" : "string" ,
@@ -13453,7 +13616,10 @@ BankingPa
-
+
+
{
"payeeId" : "string" ,
"nickname" : "string" ,
@@ -13477,31 +13643,31 @@ Properties
payeeId
ASCIIString mandatory
-ID of the payee adhering to the rules of ID permanence
+ID of the payee adhering to the rules of ID permanence.
nickname
string
mandatory
-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
+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.
description
string
optional
-A description of the payee provided by the customer
+A description of the payee provided by the customer.
type
Enum mandatory
-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
+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.
creationDate
DateString optional
-The date the payee was created by the customer
+The date the payee was created by the customer.
@@ -13535,7 +13701,10 @@ Ban
-
+
+
{
"payeeId" : "string" ,
"nickname" : "string" ,
@@ -13634,7 +13803,7 @@ Properties
» payeeUType
Enum mandatory
-Type of object included that describes the payee in detail
+Type of object included that describes the payee in detail.
» biller
@@ -13692,7 +13861,10 @@ Ban
-
+
+
{
"payeeAccountUType" : "account" ,
"account" : {
@@ -13725,7 +13897,7 @@ Properties
payeeAccountUType
Enum mandatory
-Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number.card A credit or charge card to pay to (note that PANs are masked).payId A PayID recognised by NPP
+Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number.card A credit or charge card to pay to (note that PANs are masked).payId A PayID recognised by NPP.
account
@@ -13773,7 +13945,10 @@
-
+
+
{
"accountName" : "string" ,
"bsb" : "string" ,
@@ -13795,19 +13970,19 @@ Properties
accountName
string
optional
-Name of the account to pay to
+Name of the account to pay to.
bsb
string
mandatory
-BSB of the account to pay to
+BSB of the account to pay to.
accountNumber
string
mandatory
-Number of the account to pay to
+Number of the account to pay to.
@@ -13815,7 +13990,10 @@
-
+
+
{
"cardNumber" : "string"
}
@@ -13835,7 +14013,7 @@ Properties
cardNumber
MaskedPANString mandatory
-Name of the account to pay to
+Name of the account to pay to.
@@ -13843,7 +14021,10 @@
-
+
+
{
"name" : "string" ,
"identifier" : "string" ,
@@ -13865,19 +14046,19 @@ Properties
name
string
optional
-The name assigned to the PayID by the owner of the PayID
+The name assigned to the PayID by the owner of the PayID.
identifier
string
mandatory
-The identifier of the PayID (dependent on type)
+The identifier of the PayID (dependent on type).
type
Enum mandatory
-The type of the PayID
+The type of the PayID.
@@ -13911,7 +14092,10 @@ Banki
-
+
+
{
"billerCode" : "string" ,
"crn" : "string" ,
@@ -13933,7 +14117,7 @@ Properties
billerCode
string
mandatory
-BPAY Biller Code of the Biller
+BPAY Biller Code of the Biller.
crn
@@ -13945,7 +14129,7 @@ Properties
billerName
string
mandatory
-Name of the Biller
+Name of the Biller.
@@ -13953,7 +14137,10 @@
-
+
+
{
"beneficiaryDetails" : {
"name" : "string" ,
@@ -13997,19 +14184,19 @@ Properties
» name
string
optional
-Name of the beneficiary
+Name of the beneficiary.
» country
ExternalRef mandatory
-Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code
+Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code.
» message
string
optional
-Response message for the payment
+Response message for the payment.
bankDetails
@@ -14021,13 +14208,13 @@ Properties
» country
ExternalRef mandatory
-Country of the recipient institution. A valid ISO 3166 Alpha-3 country code
+Country of the recipient institution. A valid ISO 3166 Alpha-3 country code.
» accountNumber
string
mandatory
-Account Targeted for payment
+Account Targeted for payment.
» bankAddress
@@ -14039,49 +14226,49 @@ Properties
»» name
string
mandatory
-Name of the recipient Bank
+Name of the recipient Bank.
»» address
string
mandatory
-Address of the recipient Bank
+Address of the recipient Bank.
» beneficiaryBankBIC
ExternalRef optional
-Swift bank code. Aligns with standard ISO 9362
+Swift bank code. Aligns with standard ISO 9362 .
» fedWireNumber
string
optional
-Number for Fedwire payment (Federal Reserve Wire Network)
+Number for Fedwire payment (Federal Reserve Wire Network).
» sortCode
string
optional
-Sort code used for account identification in some jurisdictions
+Sort code used for account identification in some jurisdictions.
» chipNumber
string
optional
-Number for the Clearing House Interbank Payments System
+Number for the Clearing House Interbank Payments System.
» routingNumber
string
optional
-International bank routing number
+International bank routing number.
» legalEntityIdentifier
ExternalRef optional
-The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442
+The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442 .
@@ -14089,7 +14276,10 @@
-
+
+
{
"name" : "string" ,
"identifier" : "string" ,
@@ -14112,25 +14302,25 @@ Properties
name
string
mandatory
-The display name of the wallet as given by the customer, else a default value defined by the data holder
+The display name of the wallet as given by the customer, else a default value defined by the data holder.
identifier
string
mandatory
-The identifier of the digital wallet (dependent on type)
+The identifier of the digital wallet (dependent on type).
type
Enum mandatory
-The type of the digital wallet identifier
+The type of the digital wallet identifier.
provider
Enum mandatory
-The provider of the digital wallet
+The provider of the digital wallet.
@@ -14168,7 +14358,10 @@
-
+
+
{
"data" : {
"directDebitAuthorisations" : [
@@ -14220,7 +14413,7 @@
» directDebitAuthorisations
[BankingDirectDebit ]
mandatory
-The list of authorisations returned
+The list of authorisations returned.
links
@@ -14240,7 +14433,10 @@ Banki
-
+
+
{
"accountId" : "string" ,
"authorisedEntity" : {
@@ -14281,13 +14477,13 @@ Properties
lastDebitDateTime
DateTimeString optional
-The date and time of the last debit executed under this authorisation
+The date and time of the last debit executed under this authorisation.
lastDebitAmount
AmountString optional
-The amount of the last debit executed under this authorisation
+The amount of the last debit executed under this authorisation.
@@ -14295,7 +14491,10 @@
-
+
+
{
"description" : "string" ,
"financialInstitution" : "string" ,
@@ -14319,31 +14518,31 @@ Properties
description
string
optional
-Description of the authorised entity derived from previously executed direct debits
+Description of the authorised entity derived from previously executed direct debits.
financialInstitution
string
conditional
-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
+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.
abn
string
optional
-Australian Business Number for the authorised entity
+Australian Business Number for the authorised entity.
acn
string
optional
-Australian Company Number for the authorised entity
+Australian Company Number for the authorised entity.
arbn
string
optional
-Australian Registered Body Number for the authorised entity
+Australian Registered Body Number for the authorised entity.
@@ -14351,7 +14550,10 @@
-
+
+
{
"data" : {
"scheduledPayments" : [
@@ -14491,7 +14693,7 @@ Prope
» scheduledPayments
[BankingScheduledPaymentV2 ]
mandatory
-The list of scheduled payments to return
+The list of scheduled payments to return.
links
@@ -14511,7 +14713,10 @@
-
+
+
{
"scheduledPaymentId" : "string" ,
"nickname" : "string" ,
@@ -14628,25 +14833,25 @@ Properties
scheduledPaymentId
ASCIIString mandatory
-A unique ID of the scheduled payment adhering to the standards for ID permanence
+A unique ID of the scheduled payment adhering to the standards for ID permanence.
nickname
string
optional
-The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels
+The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.
payerReference
string
mandatory
-The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided
+The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided.
payeeReference
string
conditional
-The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided
+The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.
status
@@ -14658,19 +14863,19 @@ Properties
from
BankingScheduledPaymentFrom mandatory
-Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
+Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object.
paymentSet
[BankingScheduledPaymentSetV2 ]
mandatory
-[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]
+[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.]
recurrence
BankingScheduledPaymentRecurrence mandatory
-Object containing the detail of the schedule for the payment
+Object containing the detail of the schedule for the payment.
@@ -14700,7 +14905,10 @@
-
+
+
{
"to" : {
"toUType" : "accountId" ,
@@ -14763,7 +14971,7 @@ }
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
+The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.
Properties
@@ -14779,25 +14987,25 @@ Properties
to
BankingScheduledPaymentToV2 mandatory
-Object containing details of the destination of the payment. Used to specify a variety of payment destination types
+Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
isAmountCalculated
Boolean optional
-Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
+Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed.
amount
AmountString conditional
-The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
+The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present.
currency
CurrencyString optional
-The currency for the payment. AUD assumed if not present
+The currency for the payment. AUD assumed if not present.
@@ -14805,7 +15013,10 @@
-
+
+
{
"toUType" : "accountId" ,
"accountId" : "string" ,
@@ -14863,7 +15074,7 @@ }
Object containing details of the destination of the payment. Used to specify a variety of payment destination types
+Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
Properties
@@ -14885,19 +15096,19 @@ Properties
accountId
ASCIIString conditional
-Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
+Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent.
payeeId
ASCIIString conditional
-Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. 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
+Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead.
nickname
string
conditional
-The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
+The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.
payeeReference
@@ -14969,13 +15180,16 @@
-
+
+
{
"accountId" : "string"
}
Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
+Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object.
Properties
@@ -14991,7 +15205,7 @@ Properties
accountId
ASCIIString mandatory
-ID of the account that is the source of funds for the payment
+ID of the account that is the source of funds for the payment.
@@ -14999,7 +15213,10 @@
-
+
+
{
"nextPaymentDate" : "string" ,
"recurrenceUType" : "eventBased" ,
@@ -15030,7 +15247,7 @@ }
Object containing the detail of the schedule for the payment
+Object containing the detail of the schedule for the payment.
Properties
@@ -15046,37 +15263,37 @@ Properties
nextPaymentDate
DateString optional
-The date of the next payment under the recurrence schedule
+The date of the next payment under the recurrence schedule.
recurrenceUType
Enum mandatory
-The type of recurrence used to define the schedule
+The type of recurrence used to define the schedule.
onceOff
BankingScheduledPaymentRecurrenceOnceOff conditional
-Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
+Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.
intervalSchedule
BankingScheduledPaymentRecurrenceIntervalSchedule conditional
-Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
+Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.
lastWeekDay
BankingScheduledPaymentRecurrenceLastWeekday conditional
-Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
+Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.
eventBased
BankingScheduledPaymentRecurrenceEventBased conditional
-Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.
@@ -15110,13 +15327,16 @@
-
+
+
{
"paymentDate" : "string"
}
Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
+Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.
Properties
@@ -15132,7 +15352,7 @@ Pro
paymentDate
DateString mandatory
-The scheduled date for the once off payment
+The scheduled date for the once off payment.
@@ -15140,7 +15360,10 @@
-
+
+
{
"finalPaymentDate" : "string" ,
"paymentsRemaining" : 1 ,
@@ -15154,7 +15377,7 @@ }
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
+Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.
Properties
@@ -15170,25 +15393,25 @@ DateString
optional
-The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
paymentsRemaining
PositiveInteger optional
-Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
+Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely.
nonBusinessDayTreatment
Enum optional
-Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
intervals
[BankingScheduledPaymentInterval ]
mandatory
-An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
+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.
@@ -15222,7 +15445,10 @@
-
+
+
{
"interval" : "string" ,
"dayInInterval" : "string"
@@ -15243,13 +15469,13 @@ Propertiesinterval
ExternalRef mandatory
-An interval for the payment. Formatted according to 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
+An interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate .
dayInInterval
ExternalRef optional
-Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
+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 (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
@@ -15257,7 +15483,10 @@
-
+
+
{
"finalPaymentDate" : "string" ,
"paymentsRemaining" : 1 ,
@@ -15267,7 +15496,7 @@ }
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
+Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.
Properties
@@ -15283,19 +15512,19 @@ finalPaymentDate
DateString optional
-The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
paymentsRemaining
PositiveInteger optional
-Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
interval
ExternalRef mandatory
-The interval for the payment. Formatted according to 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
+The interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate .
lastWeekDay
@@ -15307,7 +15536,7 @@ nonBusinessDayTreatment
Enum optional
-Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+Enumerated 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.
@@ -15369,13 +15598,16 @@
-
+
+
{
"description" : "string"
}
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.
Properties
@@ -15391,7 +15623,7 @@
description
string
mandatory
-Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
+Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer.
@@ -15399,7 +15631,10 @@ Co
-
+
+
{
"addressUType" : "paf" ,
"simple" : {
@@ -15453,7 +15688,7 @@ Properties
addressUType
Enum mandatory
-The type of address object present
+The type of address object present.
simple
@@ -15465,7 +15700,7 @@ Properties
paf
CommonPAFAddress conditional
-Australian address formatted according to the file format defined by the PAF file format
+Australian address formatted according to the file format defined by the PAF file format .
@@ -15491,7 +15726,10 @@ Comm
-
+
+
{
"mailingName" : "string" ,
"addressLine1" : "string" ,
@@ -15518,49 +15756,49 @@ Properties
mailingName
string
optional
-Name of the individual or business formatted for inclusion in an address used for physical mail
+Name of the individual or business formatted for inclusion in an address used for physical mail.
addressLine1
string
mandatory
-First line of the standard address object
+First line of the standard address object.
addressLine2
string
optional
-Second line of the standard address object
+Second line of the standard address object.
addressLine3
string
optional
-Third line of the standard address object
+Third line of the standard address object.
postcode
string
conditional
-Mandatory for Australian addresses
+Mandatory for Australian addresses.
city
string
mandatory
-Name of the city or locality
+Name of the city or locality.
state
string
mandatory
-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 in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+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 in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
country
ExternalRef optional
-A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
+A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
@@ -15568,7 +15806,10 @@ CommonP
-
+
+
{
"dpid" : "string" ,
"thoroughfareNumber1" : 0 ,
@@ -15595,7 +15836,7 @@ CommonP
}
Australian address formatted according to the file format defined by the PAF file format
+Australian address formatted according to the file format defined by the PAF file format .
Properties
@@ -15611,133 +15852,133 @@ Properties
dpid
string
optional
-Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
+Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.
thoroughfareNumber1
PositiveInteger optional
-Thoroughfare number for a property (first number in a property ranged address)
+Thoroughfare number for a property (first number in a property ranged address).
thoroughfareNumber1Suffix
string
optional
-Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
+Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated.
thoroughfareNumber2
PositiveInteger optional
-Second thoroughfare number (only used if the property has a ranged address eg 23-25)
+Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25).
thoroughfareNumber2Suffix
string
optional
-Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
+Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated.
flatUnitType
string
optional
-Type of flat or unit for the address
+Type of flat or unit for the address.
flatUnitNumber
string
optional
-Unit number (including suffix, if applicable)
+Unit number (including suffix, if applicable).
floorLevelType
string
optional
-Type of floor or level for the address
+Type of floor or level for the address.
floorLevelNumber
string
optional
-Floor or level number (including alpha characters)
+Floor or level number (including alpha characters).
lotNumber
string
optional
-Allotment number for the address
+Allotment number for the address.
buildingName1
string
optional
-Building/Property name 1
+Building/Property name 1.
buildingName2
string
optional
-Building/Property name 2
+Building/Property name 2.
streetName
string
optional
-The name of the street
+The name of the street.
streetType
string
optional
-The street type. Valid enumeration defined by Australia Post PAF code file
+The street type. Valid enumeration defined by Australia Post PAF code file.
streetSuffix
string
optional
-The street type suffix. Valid enumeration defined by Australia Post PAF code file
+The street type suffix. Valid enumeration defined by Australia Post PAF code file.
postalDeliveryType
string
optional
-Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
+Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file.
postalDeliveryNumber
PositiveInteger optional
-Postal delivery number if the address is a postal delivery type
+Postal delivery number if the address is a postal delivery type.
postalDeliveryNumberPrefix
string
optional
-Postal delivery number prefix related to the postal delivery number
+Postal delivery number prefix related to the postal delivery number.
postalDeliveryNumberSuffix
string
optional
-Postal delivery number suffix related to the postal delivery number
+Postal delivery number suffix related to the postal delivery number.
localityName
string
mandatory
-Full name of locality
+Full name of locality.
postcode
string
mandatory
-Postcode for the locality
+Postcode for the locality.
state
string
mandatory
-State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation . NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation . NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
@@ -15745,7 +15986,10 @@ Links
-
+
+
{
"self" : "string"
}
@@ -15765,7 +16009,7 @@ Properties
self
URIString mandatory
-Fully qualified link that generated the current response document
+Fully qualified link that generated the current response document.
@@ -15773,7 +16017,10 @@
-
+
+
{}
LinksPagi
-
+
+
{
"self" : "string" ,
"first" : "string" ,
@@ -15809,31 +16059,31 @@ Properties
self
URIString mandatory
-Fully qualified link that generated the current response document
+Fully qualified link that generated the current response document.
first
URIString conditional
-URI to the first page of this set. Mandatory if this response is not the first page
+URI to the first page of this set. Mandatory if this response is not the first page.
prev
URIString conditional
-URI to the previous page of this set. Mandatory if this response is not the first page
+URI to the previous page of this set. Mandatory if this response is not the first page.
next
URIString conditional
-URI to the next page of this set. Mandatory if this response is not the last page
+URI to the next page of this set. Mandatory if this response is not the last page.
last
URIString conditional
-URI to the last page of this set. Mandatory if this response is not the last page
+URI to the last page of this set. Mandatory if this response is not the last page.
@@ -15841,7 +16091,10 @@
-
+
+
{
"totalRecords" : 0 ,
"totalPages" : 0
@@ -15876,7 +16129,10 @@
+
+
{
"totalRecords" : 0 ,
"totalPages" : 0 ,
@@ -15924,7 +16180,7 @@
» isQueryParamUnsupported
Boolean optional
-true if "text" query parameter is not supportedtrue if text query parameter is not supported.
-
+
+
{
"urn" : "string"
}
Additional data for customised error codes
+Additional data for customised error codes.
@@ -15954,7 +16213,7 @@
urn
string
conditional
-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.
+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.
@@ -15962,7 +16221,10 @@ Resp
-
+
+
{
"errors" : [
{
@@ -16015,7 +16277,7 @@ Properties
» meta
MetaError optional
-Additional data for customised error codes
+Additional data for customised error codes.
@@ -16023,11 +16285,14 @@
-
+
+
"BUSINESS_LOANS"
The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
Properties
@@ -16043,7 +16308,7 @@ Properties
anonymous Enum mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
diff --git a/docs/includes/additional/candidates/dp306/banking-dp306_apis b/docs/includes/additional/candidates/dp306/banking-dp306_apis
index 4a1be502..21f36eac 100644
--- a/docs/includes/additional/candidates/dp306/banking-dp306_apis
+++ b/docs/includes/additional/candidates/dp306/banking-dp306_apis
@@ -1,4 +1,5 @@
-Banking APIs
+Banking APIs In addition to minor styling updates, aligned Banking documentation to enhancements applied in the Candidate Standards
+
This standard is part of the Consumer Data Standards and is classified as a Candidate Standard Payees
Register APIs
+Register APIs Fixed typo in 'Country of registeration' in the description of registeredCountry
+The following section provides an overview of the Register APIs for Data Holders and Data Recipients to collect participant metadata.
These endpoints are exposed by the Register and consumed by Data Holders and Data Recipients.
@@ -717,8 +718,7 @@ Register APIs
Data Holders and Data Recipient Software Products are required to call these endpoints to obtain metadata that enables connection and registration between participants as well as obtaining the status of participants in the CDR.
These statuses are provided authoritatively by the Register to allow participants to determine whether a connecting third-party is permitted to perform registration requests or data sharing requests.
-Removed ResponseErrorListV2 as the 401 error response schema for 'Get Data Holder Brands'. This endpoint conforms to RFC6750, returning an oAuth error in the WWW-Authenticate response header.
-
Register OpenAPI Specification (JSON) Get Data H
Code samples
-
GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/brands/summary HTTP / 1.1
Accept: application/json
@@ -1040,7 +1039,6 @@ Get Data H
});
GET /cdr-register/v1/{industry}/data-holders/brands/summary
Endpoint used by participants to discover public details of Data Holder Brands from the CDR Register
@@ -1137,7 +1135,6 @@ {
"data" : [
{
@@ -1161,7 +1158,6 @@ "meta" : {}
}
Responses
@@ -1245,7 +1241,6 @@ Get Data Holder
Code samples
-
GET https://<register-base-url>/cdr-register/v1/{industry}/data-holders/status HTTP / 1.1
Accept: application/json
@@ -1276,7 +1271,6 @@ Get Data Holder
});
GET /cdr-register/v1/{industry}/data-holders/status
Endpoint used by participants to discover the statuses for Data Holders from the CDR Register
@@ -1373,7 +1367,6 @@ {
"data" : [
{
@@ -1387,7 +1380,6 @@ "meta" : {}
}
Responses
@@ -1464,7 +1456,10 @@
-
+
+
{
"data" : [
@@ -1558,7 +1553,10 @@
-
+
+
{
"dataHolderBrandId" : "string" ,
@@ -1709,7 +1707,10 @@
-
+
+
{
"data" : [
@@ -1770,7 +1771,10 @@
-
+
+
{
"dataHolderBrandId" : "string" ,
@@ -1891,7 +1895,10 @@
-
+
+
+
+
{
"data" : [
@@ -1942,7 +1949,10 @@
-
+
+
{
"legalEntityId" : "string" ,
@@ -1997,7 +2007,10 @@
-
+
+
{
"legalEntityId" : "string" ,
@@ -2062,7 +2075,7 @@ PropertiesregisteredCountry
string
optional
-Country of registeration (if the company is registered outside Australia)
+Country of registration (if the company is registered outside Australia)
abn
@@ -2148,7 +2161,10 @@
-
+
+
{
"version" : "string" ,
@@ -2215,7 +2231,10 @@
-
+
+
{
"registerUType" : "SIGNED-JWT" ,
@@ -2268,7 +2287,10 @@
-
+
+
{
"first" : "string" ,
@@ -2326,7 +2348,10 @@
+
+
{
"totalPages" : 0 ,
@@ -2363,7 +2388,10 @@ Link
-
+
+
{
"self" : "string"
@@ -2393,7 +2421,10 @@
-
+
+
{}
@@ -2407,7 +2438,10 @@
-
+
+
{
"urn" : "string"
@@ -2439,7 +2473,10 @@
-
+
+
{
"errors" : [
@@ -2478,7 +2515,10 @@
-
+
+
{
"code" : "string" ,
@@ -2527,7 +2567,8 @@ Pro
Banking APIs
+Banking APIs In addition to minor styling updates, aligned Banking documentation to enhancements applied in the Candidate Standards
+This specification defines the APIs for Data Holders exposing Banking endpoints.
@@ -2581,7 +2622,7 @@ Get Accounts
Obtain a list of accounts.
-Obsolete versions: v1 , v2
+Obsolete versions: v1 , v2 .
Endpoint Version
@@ -2613,63 +2654,63 @@ Parameters
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.)
+Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
open-status
query
Enum optional
-Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
+Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.
is-owned
query
Boolean optional
-Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
+Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -2683,7 +2724,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -2852,25 +2893,25 @@
200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -2924,9 +2965,9 @@ Get Bulk Balances
GET /banking/accounts/balances
-Obtain balances for multiple, filtered accounts
+Obtain balances for multiple, filtered accounts.
-Obsolete versions: v1
+Obsolete versions: v1 .
Endpoint Version
@@ -2958,63 +2999,63 @@ Parameters
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
+Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
open-status
query
Enum optional
-Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
+Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.
is-owned
query
Boolean optional
-Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
+Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -3028,7 +3069,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -3199,25 +3240,25 @@ 200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -3280,7 +3321,7 @@ Get Balances For Spe
POST /banking/accounts/balances
-Obtain balances for a specified list of accounts
+Obtain balances for a specified list of accounts.
Body parameter
@@ -3324,42 +3365,42 @@ Parameter
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -3373,14 +3414,14 @@ Parameter
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body
body
RequestAccountIds mandatory
-The list of account IDs to obtain balances for
+The list of account IDs to obtain balances for.
@@ -3477,25 +3518,25 @@ GET /banking/accounts/{accountId}/balance
-Obtain the balance for a single specified account
+Obtain the balance for a single specified account.
Endpoint Version
@@ -3581,35 +3622,35 @@ Parameters
path
ASCIIString mandatory
-ID of the specific account requested
+ID of the specific account requested.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -3623,7 +3664,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -3709,25 +3750,25 @@ Obtain detailed information on a single account.
-Obsolete versions: v1 , v2 , v3
+Obsolete versions: v1 , v2 , v3 .
Endpoint Version
@@ -3815,35 +3856,35 @@ Parameters
path
ASCIIString mandatory
-A tokenised identifier for the account which is unique but not shareable
+A tokenised identifier for the account which is unique but not shareable.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -3857,7 +3898,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -3943,7 +3984,7 @@ Parameters
"lendingRate" : "string" ,
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -3969,7 +4010,7 @@ Parameters
],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -4145,25 +4186,25 @@ 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 across the subsidiary transactions as possible, is required to be shared
+For aggregated transactions (i.e. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information across the subsidiary transactions as possible, is required to be shared.
Endpoint Version
@@ -4264,84 +4305,84 @@ Parameters
path
ASCIIString mandatory
-ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.
+ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.
oldest-time
query
DateTimeString optional
-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
+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.
newest-time
query
DateTimeString optional
-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
+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.
min-amount
query
AmountString optional
-Filter transactions to only transactions with amounts higher than or equal to this amount
+Filter transactions to only transactions with amounts higher than or equal to this amount.
max-amount
query
AmountString optional
-Filter transactions to only transactions with amounts less than or equal to this amount
+Filter transactions to only transactions with amounts less than or equal to this amount.
text
query
string
optional
-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)
+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).
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -4355,7 +4396,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -4465,31 +4506,31 @@ GET /banking/accounts/{accountId}/transactions/{transactionId}
-Obtain detailed information on a transaction for a specific account
+Obtain detailed information on a transaction for a specific account.
Endpoint Version
@@ -4575,42 +4616,42 @@ Parameters
path
ASCIIString mandatory
-ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints
+ID of the account to get transactions for. Must have previously been returned by one of the account list endpoints.
transactionId
path
ASCIIString mandatory
-ID of the transaction obtained from a previous call to one of the other transaction endpoints
+ID of the transaction obtained from a previous call to one of the other transaction endpoints.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -4624,7 +4665,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -4727,25 +4768,25 @@ GET /banking/accounts/{accountId}/direct-debits
-Obtain direct debit authorisations for a specific account
+Obtain direct debit authorisations for a specific account.
Endpoint Version
@@ -4831,49 +4872,49 @@ Parameters path
ASCIIString mandatory
-ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.
+ID of the account to get direct debit authorisations for. Must have previously been returned by one of the account list endpoints.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -4887,7 +4928,7 @@ Parameters header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -4988,31 +5029,31 @@ GET /banking/accounts/direct-debits
-Obtain direct debit authorisations for multiple, filtered accounts
+Obtain direct debit authorisations for multiple, filtered accounts.
-Obsolete versions: v1
+Obsolete versions: v1 .
Endpoint Version
@@ -5100,63 +5141,63 @@ Parameters
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
+Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
open-status
query
Enum optional
-Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
+Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.
is-owned
query
Boolean optional
-Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
+Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -5170,7 +5211,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -5339,25 +5380,25 @@ POST /banking/accounts/direct-debits
-Obtain direct debit authorisations for a specified list of accounts
+Obtain direct debit authorisations for a specified list of accounts.
Body parameter
@@ -5464,42 +5505,42 @@ Para
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -5513,14 +5554,14 @@ Para
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body
body
RequestAccountIds mandatory
-Array of specific accountIds to obtain authorisations for
+Array of specific accountIds to obtain authorisations for.
@@ -5615,25 +5656,25 @@ GET /banking/accounts/{accountId}/payments/scheduled
-Obtain scheduled, outgoing payments for a specific account
+Obtain scheduled, outgoing payments for a specific account.
-Obsolete versions: v1
+Obsolete versions: v1 .
Endpoint Version
@@ -5721,49 +5762,49 @@ Parameter
path
ASCIIString mandatory
-ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment
+ID of the account to get scheduled payments for. Must have previously been returned by one of the account list endpoints. The account specified is the source account for the payment.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -5777,7 +5818,7 @@ Parameter
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -5966,31 +6007,31 @@ GET /banking/payments/scheduled
-Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments
+Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments.
-Obsolete versions: v1 , v2
+Obsolete versions: v1 , v2 .
Endpoint Version
@@ -6078,63 +6119,63 @@ Parameters
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
+Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
open-status
query
Enum optional
-Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed
+Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.
is-owned
query
Boolean optional
-Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts
+Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -6148,7 +6189,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -6405,25 +6446,25 @@ POST /banking/payments/scheduled
-Obtain scheduled payments for a specified list of accounts
+Obtain scheduled payments for a specified list of accounts.
-Obsolete versions: v1
+Obsolete versions: v1 .
Body parameter
@@ -6532,42 +6573,42 @@ query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -6581,14 +6622,14 @@ header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 encoded, including the original User Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
body
body
RequestAccountIds mandatory
-Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned
+Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned.
@@ -6771,25 +6812,25 @@ [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] An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -6845,7 +6886,7 @@ Get Payees
Obtain a list of pre-registered payees.
-Obsolete versions: v1
+Obsolete versions: v1 .
Endpoint Version
@@ -6877,49 +6918,49 @@ Parameters
query
Enum optional
-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
+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.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -6933,7 +6974,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -7053,25 +7094,25 @@
200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -7129,7 +7170,7 @@ Get Payee Detail
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
+Obsolete versions: v1 .
Endpoint Version
@@ -7161,35 +7202,35 @@ Parameters
path
ASCIIString mandatory
-The ID used to locate the details of a particular payee
+The ID used to locate the details of a particular payee.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
x-fapi-interaction-id
header
string
optional
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
x-fapi-auth-date
header
string
conditional
-The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
+The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]
x-fapi-customer-ip-address
@@ -7203,7 +7244,7 @@ Parameters
header
Base64 conditional
-The customer's original standard http headers Base64 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.
+The customer's original standard http headers Base64 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.
@@ -7337,31 +7378,31 @@
200
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
400
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
404
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
406
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
422
x-fapi-interaction-id
string
-An [RFC4122] [RFC4122]
+An [RFC4122] x-fapi-interaction-id response header. If not provided a [RFC4122]
@@ -7407,9 +7448,9 @@ Get Products
GET /banking/products
-Obtain a list of products that are currently openly offered to the market
+Obtain a list of products that are currently openly offered to the market.
-Note that the results returned by this endpoint are expected to be ordered in descending order according to lastUpdated.
+Note that the results returned by this endpoint 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
@@ -7418,9 +7459,9 @@ Arrays Of Features
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 . 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.
+Each element has a field name additionalValue 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.
+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.
@@ -7428,17 +7469,17 @@
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.
+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.
+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 actually 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.
+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.
+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 , v2 , v3
+Obsolete versions: v1 , v2 , v3 .
Endpoint Version
@@ -7470,56 +7511,56 @@ Parameters
query
Enum optional
-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
+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.
updated-since
query
DateTimeString optional
-Only include products that have been updated after the specified date and time. If absent defaults to include all products
+Only include products that have been updated after the specified date and time. If absent defaults to include all products.
brand
query
string
optional
-Filter results based on a specific brand
+Filter results based on a specific brand.
product-category
query
Enum optional
-Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
+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.
page
query
PositiveInteger optional
-Page of results to request (standard pagination)
+Page of results to request (standard pagination).
page-size
query
PositiveInteger optional
-Page size to request. Default is 25 (standard pagination)
+Page size to request. Default is 25 (standard pagination).
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
@@ -7773,7 +7814,7 @@ Get Product Detail
Obtain detailed information on a single product offered openly to the market.
-Obsolete versions: v1 , v2 , v3 , v4
+Obsolete versions: v1 , v2 , v3 , v4 .
Endpoint Version
@@ -7805,21 +7846,21 @@ Parameters
path
ASCIIString mandatory
-ID of the specific product requested
+ID of the specific product requested.
x-v
header
string
mandatory
-Version of the API endpoint 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 and x-v . If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v 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
+Version of the API endpoint 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 x-v x-min-v x-v x-min-v 406 Not Acceptable. See HTTP Headers .
x-min-v
header
string
optional
-Minimum version of the API endpoint 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 and x-v . If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.
+Minimum version of the API endpoint 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 x-v 406 Not Acceptable.
@@ -7958,7 +7999,7 @@ Parameters
],
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -7984,7 +8025,7 @@ Parameters
],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -8091,7 +8132,10 @@ Reques
-
+
+
{
"data" : {
"accountIds" : [
@@ -8136,7 +8180,10 @@
-
+
+
{
"data" : {
"products" : [
@@ -8232,7 +8279,7 @@ Properties
» products
[BankingProductV5 ]
mandatory
-The list of products returned. If the filter results in an empty set then this array may have no records
+The list of products returned. If the filter results in an empty set then this array may have no records.
links
@@ -8252,7 +8299,10 @@ Banking
-
+
+
{
"productId" : "string" ,
"effectiveFrom" : "string" ,
@@ -8331,49 +8381,49 @@ Properties
effectiveFrom
DateTimeString optional
-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
+The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate.
effectiveTo
DateTimeString optional
-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
+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.
lastUpdated
DateTimeString mandatory
-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)
+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).
productCategory
BankingProductCategoryV2 mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
name
string
mandatory
-The display name of the product
+The display name of the product.
description
string
mandatory
-A description of the product
+A description of the product.
brand
string
mandatory
-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
+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.
brandName
string
optional
-An optional display name of the brand
+An optional display name of the brand.
applicationUri
@@ -8385,31 +8435,31 @@ Properties
isTailored
Boolean mandatory
-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
+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.
additionalInformation
BankingProductAdditionalInformationV2 optional
-Object that contains links to additional information on specific topics
+Object that contains links to additional information on specific topics.
cardArt
[object]
optional
-An array of card art images
+An array of card art images.
» title
string
optional
-Display label for the specific image
+Display label for the specific image.
» imageUri
URIString mandatory
-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]
+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]
@@ -8417,7 +8467,10 @@
-
+
+
{
"overviewUri" : "string" ,
"termsUri" : "string" ,
@@ -8457,7 +8510,7 @@ }
Object that contains links to additional information on specific topics
+Object that contains links to additional information on specific topics.
@@ -8473,61 +8526,61 @@
+
+
{
"description" : "string" ,
"additionalInfoUri" : "string"
@@ -8556,13 +8612,13 @@ URIString
mandatory
-The URI describing the additional information
+The URI describing the additional information.
@@ -8570,7 +8626,10 @@
-
+
+
{
"data" : {
"productId" : "string" ,
@@ -8701,7 +8760,7 @@ ],
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -8727,7 +8786,7 @@ ],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -8805,7 +8864,10 @@ B
-
+
+
{
"productId" : "string" ,
"effectiveFrom" : "string" ,
@@ -8935,7 +8997,7 @@ B
],
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -8961,7 +9023,7 @@ B
],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -9040,49 +9102,49 @@ Properties
» bundles
[BankingProductBundle ]
optional
-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
+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.
» features
[BankingProductFeatureV3 ]
optional
-Array of features available for the product
+Array of features available for the product.
» constraints
[BankingProductConstraint ]
optional
-Constraints on the application for or operation of the product such as minimum balances or limit thresholds
+Constraints on the application for or operation of the product such as minimum balances or limit thresholds.
» eligibility
[BankingProductEligibility ]
optional
-Eligibility criteria for the product
+Eligibility criteria for the product.
» fees
[BankingProductFee ]
optional
-Fees applicable to the product
+Fees applicable to the product.
» depositRates
[BankingProductDepositRate ]
optional
-Interest rates available for deposits
+Interest rates available for deposits.
» lendingRates
[BankingProductLendingRateV2 ]
optional
-Interest rates charged against lending balances
+Interest rates charged against lending balances.
» instalments
BankingProductInstalments optional
-Details of instalment features on the account
+Details of instalment features on the account.
@@ -9090,7 +9152,10 @@ Ban
-
+
+
{
"name" : "string" ,
"description" : "string" ,
@@ -9116,31 +9181,31 @@ Properties
name
string
mandatory
-Name of the bundle
+Name of the bundle.
description
string
mandatory
-Description of the bundle
+Description of the bundle.
additionalInfo
string
optional
-Display text providing more information on the bundle
+Display text providing more information on the bundle.
additionalInfoUri
URIString optional
-Link to a web page with more information on the bundle criteria and benefits
+Link to a web page with more information on the bundle criteria and benefits.
productIds
[ASCIIString] optional
-Array of product IDs for products included in the bundle that are available via the product endpoints. 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 endpoints
+Array of product IDs for products included in the bundle that are available via the product endpoints. 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 endpoints.
@@ -9148,7 +9213,10 @@
-
+
+
{
"featureType" : "ADDITIONAL_CARDS" ,
"additionalValue" : "string" ,
@@ -9171,25 +9239,25 @@ Properties
featureType
Enum mandatory
-The type of feature described. For further details, refer to featureType
+The type of feature described. For further details, refer to Product Feature Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the featureType specified. Whether mandatory or not is dependent on the value of the featureType.
+Generic field containing additional information relevant to the featureType featureType
additionalInfo
string
conditional
-Display text providing more information on the feature. Mandatory if the feature type is set to OTHER
+Display text providing more information on the feature. Mandatory if featureType OTHER.
additionalInfoUri
URIString optional
-Link to a web page with more information on this feature
+Link to a web page with more information on this feature.
@@ -9327,7 +9395,10 @@
-
+
+
{
"constraintType" : "MAX_BALANCE" ,
"additionalValue" : "string" ,
@@ -9350,25 +9421,25 @@ Properties
constraintType
Enum mandatory
-The type of constraint described. See the next section for an overview of valid values and their meaning
+The type of constraint described. For further details, refer to Product Constraint Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the constraintType specified. Whether mandatory or not is dependent on the value of constraintType
+Generic field containing additional information relevant to the constraintType constraintType
additionalInfo
string
optional
-Display text providing more information on the constraint
+Display text providing more information on the constraint.
additionalInfoUri
URIString optional
-Link to a web page with more information on the constraint
+Link to a web page with more information on the constraint.
@@ -9406,7 +9477,10 @@
-
+
+
{
"eligibilityType" : "BUSINESS" ,
"additionalValue" : "string" ,
@@ -9429,25 +9503,25 @@ Properties
eligibilityType
Enum mandatory
-The type of eligibility criteria described. See the next section for an overview of valid values and their meaning
+The type of eligibility criteria described. For further details, refer to Product Eligibility Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the eligibilityType specified. Whether mandatory or not is dependent on the value of eligibilityType
+Generic field containing additional information relevant to the eligibilityType eligibilityType
additionalInfo
string
conditional
-Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER
+Display text providing more information on the eligibility criteria. Mandatory if the field is set to OTHER.
additionalInfoUri
URIString optional
-Link to a web page with more information on this eligibility criteria
+Link to a web page with more information on this eligibility criteria.
@@ -9513,7 +9587,10 @@ Bankin
-
+
+
{
"name" : "string" ,
"feeType" : "DEPOSIT" ,
@@ -9565,73 +9642,73 @@ Properties
name
string
mandatory
-Name of the fee
+Name of the fee.
feeType
Enum mandatory
-The type of fee. For details refer to Product Fee Types .
+The type of fee. For further details, refer to Product Fee Types .
amount
AmountString conditional
-The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the feeType "VARIABLE" is supplied
+The amount charged for the fee. One of amount , balanceRate , transactionRate and accruedRate is mandatory unless the feeType VARIABLE is supplied.
balanceRate
RateString conditional
-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.
+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.
transactionRate
RateString conditional
-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
+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.
accruedRate
RateString conditional
-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
+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.
accrualFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
currency
CurrencyString optional
-The currency the fee will be charged in. Assumes AUD if absent
+The currency the fee will be charged in. Assumes AUD if absent.
additionalValue
string
conditional
-Generic field containing additional information relevant to the feeType specified. Whether mandatory or not is dependent on the value of feeType
+Generic field containing additional information relevant to the feeType feeType
additionalInfo
string
optional
-Display text providing more information on the fee
+Display text providing more information on the fee.
additionalInfoUri
URIString optional
-Link to a web page with more information on this fee
+Link to a web page with more information on this fee.
discounts
[BankingProductDiscount ]
optional
-An optional list of discounts to this fee that may be available
+An optional list of discounts to this fee that may be available.
@@ -9697,7 +9774,10 @@ B
-
+
+
{
"description" : "string" ,
"discountType" : "BALANCE" ,
@@ -9734,67 +9814,67 @@ Properties
description
string
mandatory
-Description of the discount
+Description of the discount.
discountType
Enum mandatory
-The type of discount. See the next section for an overview of valid values and their meaning
+The type of discount. For further details, refer to Product Discount Types .
amount
AmountString conditional
-Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory.
+Dollar value of the discount. One of amount , balanceRate , transactionRate , accruedRate and feeRate is mandatory.
balanceRate
RateString conditional
-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
+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.
transactionRate
RateString conditional
-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
+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.
accruedRate
RateString conditional
-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
+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.
feeRate
RateString conditional
-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
+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.
additionalValue
string
conditional
-Generic field containing additional information relevant to the discountType specified. Whether mandatory or not is dependent on the value of discountType
+Generic field containing additional information relevant to the discountType discountType
additionalInfo
string
optional
-Display text providing more information on the discount
+Display text providing more information on the discount.
additionalInfoUri
URIString optional
-Link to a web page with more information on this discount
+Link to a web page with more information on this discount.
eligibility
[BankingProductDiscountEligibility ]
conditional
-Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
+Eligibility constraints that apply to this discount. Mandatory if discountType is ELIGIBILITY_ONLY.
@@ -9832,7 +9912,10 @@
-
+
+
{
"discountEligibilityType" : "BUSINESS" ,
"additionalValue" : "string" ,
@@ -9855,25 +9938,25 @@ Properties
discountEligibilityType
Enum mandatory
-The type of the specific eligibility constraint for a discount
+The type of the specific eligibility constraint for a discount. For further details, refer to Product Discount Eligibility Types .
additionalValue
string
conditional
-Generic field containing additional information relevant to the discountEligibilityType specified. Whether mandatory or not is dependent on the value of discountEligibilityType
+Generic field containing additional information relevant to the discountEligibilityType discountEligibilityType
additionalInfo
string
conditional
-Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
+Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of discountEligibilityType
additionalInfoUri
URIString optional
-Link to a web page with more information on this eligibility constraint
+Link to a web page with more information on this eligibility constraint.
@@ -9943,9 +10026,12 @@
-
+
+
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -9984,49 +10070,49 @@ Properties
depositRateType
Enum mandatory
-The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning
+The type of rate (FIXED, VARIABLE, BONUS, etc.) For further details, refer to Product Deposit Rate Types .
rate
RateString mandatory
-The rate to be applied
+The rate to be applied.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
tiers
[BankingProductRateTierV3 ]
optional
-Rate tiers applicable for this rate
+Rate tiers applicable for this rate.
additionalValue
string
conditional
-Generic field containing additional information relevant to the depositRateType specified. Whether mandatory or not is dependent on the value of depositRateType
+Generic field containing additional information relevant to the depositRateType depositRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -10072,9 +10158,12 @@
-
+
+
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -10117,73 +10206,73 @@ Properties
lendingRateType
Enum mandatory
-The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning
+The type of rate (FIXED, VARIABLE, etc.) For further details, refer to Product Lending Rate Types .
rate
RateString mandatory
-The rate to be applied
+The rate to be applied.
comparisonRate
RateString optional
-A comparison rate equivalent for this rate
+A comparison rate equivalent for this rate.
calculationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
applicationFrequency
ExternalRef optional
-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 (excludes recurrence syntax)
+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 (excludes recurrence syntax).
interestPaymentDue
Enum optional
-When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered
+When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.
repaymentType
Enum optional
-Options in place for repayments. If absent, the lending rate is applicable to all repayment types
+Options in place for repayments. If absent, the lending rate is applicable to all repayment types.
loanPurpose
Enum optional
-The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes
+The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes.
tiers
[BankingProductRateTierV3 ]
optional
-Rate tiers applicable for this rate
+Rate tiers applicable for this rate.
additionalValue
string
conditional
-Generic field containing additional information relevant to the lendingRateType specified. Whether mandatory or not is dependent on the value of lendingRateType
+Generic field containing additional information relevant to the lendingRateType lendingRateType
additionalInfo
string
optional
-Display text providing more information on the rate
+Display text providing more information on the rate.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate
+Link to a web page with more information on this rate.
@@ -10269,7 +10358,10 @@
-
+
+
{
"name" : "string" ,
"unitOfMeasure" : "DAY" ,
@@ -10285,7 +10377,7 @@ }
Defines the criteria and conditions for which a rate applies
+Defines the criteria and conditions for which a rate applies.
Properties
@@ -10301,49 +10393,49 @@ Properties
name
string
mandatory
-A display name for the tier
+A display name for the tier.
unitOfMeasure
Enum mandatory
-The unit of measure that applies to the minimumValue and maximumValue 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)
+The unit of measure that applies to the minimumValue and maximumValue values e.g.,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).
minimumValue
Number mandatory
-The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value
+The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value.
maximumValue
Number optional
-The number of unitOfMeasure 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 minimumValue. Where this is the same as the minimumValue 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.
+The number of unitOfMeasure 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 minimumValue . Where this is the same as the minimumValue 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.
rateApplicationMethod
Enum optional
-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')
+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').
applicabilityConditions
BankingProductRateCondition optional
-Defines a condition for the applicability of a tiered rate
+Defines a condition for the applicability of a tiered rate.
additionalInfo
string
optional
-Display text providing more information on the rate tier
+Display text providing more information on the rate tier.
additionalInfoUri
URIString optional
-Link to a web page with more information on this rate tier
+Link to a web page with more information on this rate tier.
@@ -10385,14 +10477,17 @@
-
+
+
{
"additionalInfo" : "string" ,
"additionalInfoUri" : "string"
}
Defines a condition for the applicability of a tiered rate
+Defines a condition for the applicability of a tiered rate.
Properties
@@ -10408,13 +10503,13 @@ Properties
additionalInfo
string
optional
-Display text providing more information on the condition
+Display text providing more information on the condition.
additionalInfoUri
URIString optional
-Link to a web page with more information on this condition
+Link to a web page with more information on this condition.
@@ -10422,7 +10517,10 @@
-
+
+
{
"maximumPlanCount" : 1 ,
"instalmentsLimit" : "string" ,
@@ -10447,37 +10545,37 @@ Properties
maximumPlanCount
PositiveInteger mandatory
-Total number of plans that may be created
+Total number of plans that may be created.
instalmentsLimit
AmountString mandatory
-Maximum combined limit of all instalment plans that may be created
+Maximum combined limit of all instalment plans that may be created.
minimumPlanValue
AmountString mandatory
-Minimum value that can be opened as an instalment plan
+Minimum value that can be opened as an instalment plan.
maximumPlanValue
AmountString mandatory
-Maximum value that can be opened as an instalment plan
+Maximum value that can be opened as an instalment plan.
minimumSplit
PositiveInteger mandatory
-Minimum number of instalment payments a plan can be created with
+Minimum number of instalment payments a plan can be created with.
maximumSplit
PositiveInteger mandatory
-Maximum number of instalment payments a plan can be created with
+Maximum number of instalment payments a plan can be created with.
@@ -10485,7 +10583,10 @@
-
+
+
{
"data" : {
"accounts" : [
@@ -10537,7 +10638,7 @@ Properties
» accounts
[BankingAccountV3 ]
mandatory
-The list of accounts returned. If the filter results in an empty set then this array may have no records
+The list of accounts returned. If the filter results in an empty set then this array may have no records.
links
@@ -10557,7 +10658,10 @@ Banking
-
+
+
{
"accountId" : "string" ,
"creationDate" : "string" ,
@@ -10586,61 +10690,61 @@ Properties
accountId
ASCIIString mandatory
-A unique ID of the account adhering to the standards for ID permanence
+A unique ID of the account adhering to the standards for ID permanence.
creationDate
DateString optional
-Date that the account was created (if known)
+Date that the account was created (if known).
displayName
string
mandatory
-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.
+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.
nickname
string
optional
-A customer supplied nick name for the account
+A customer supplied nick name for the account.
openStatus
Enum optional
-Open or closed status for the account. If not present then OPEN is assumed
+Open or closed status for the account. If not present then OPEN is assumed.
isOwned
Boolean optional
-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
+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.
accountOwnership
Enum mandatory
-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
+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.
maskedNumber
MaskedAccountString mandatory
-A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number
+A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number.
productCategory
BankingProductCategoryV2 mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
productName
string
mandatory
-The unique identifier of the account as defined by the data holder (akin to model number for the account)
+The unique identifier of the account as defined by the data holder (akin to model number for the account).
@@ -10686,7 +10790,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -10764,7 +10871,7 @@ "lendingRate" : "string" ,
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -10790,7 +10897,7 @@ ],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -10945,7 +11052,10 @@ B
-
+
+
{
"accountId" : "string" ,
"creationDate" : "string" ,
@@ -11022,7 +11132,7 @@ B
"lendingRate" : "string" ,
"depositRates" : [
{
- "depositRateType" : "BONUS" ,
+ "depositRateType" : "VARIABLE" ,
"rate" : "string" ,
"calculationFrequency" : "string" ,
"applicationFrequency" : "string" ,
@@ -11048,7 +11158,7 @@ B
],
"lendingRates" : [
{
- "lendingRateType" : "BUNDLE_DISCOUNT_FIXED" ,
+ "lendingRateType" : "FIXED" ,
"rate" : "string" ,
"comparisonRate" : "string" ,
"calculationFrequency" : "string" ,
@@ -11204,25 +11314,25 @@ Properties
» bsb
string
optional
-The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces
+The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
» accountNumber
string
optional
-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
+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.
» bundleName
string
optional
-Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer
+Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.
» instalments
BankingAccountInstalments optional
-Details of instalment features on the account
+Details of instalment features on the account.
» specificAccountUType
@@ -11252,31 +11362,31 @@ Properties
» depositRate
RateString optional
-current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call
+current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call.
» lendingRate
RateString optional
-The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call
+The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.
» depositRates
[BankingProductDepositRate ]
optional
-Fully described deposit rates for this account based on the equivalent structure in Product Reference
+Fully described deposit rates for this account based on the equivalent structure in Product Reference.
» lendingRates
[BankingProductLendingRateV2 ]
optional
-Fully described lending rates for this account based on the equivalent structure in Product Reference
+Fully described lending rates for this account based on the equivalent structure in Product Reference.
» features
[allOf]
optional
-Array of features of the account based on the equivalent structure in Product Reference with the following additional field
+Array of features of the account based on the equivalent structure in Product Reference with the following additional field.
@@ -11318,7 +11428,7 @@ Properties
»»» isActivated
Boolean optional
-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)
+true if the feature is already activated and false if the feature is available for activation. Defaults to true if absent.Properties
» fees
[BankingProductFee ]
optional
-Fees and charges applicable to the account based on the equivalent structure in Product Reference
+Fees and charges applicable to the account based on the equivalent structure in Product Reference.
» addresses
[CommonPhysicalAddress ]
optional
-The addresses for the account to be used for correspondence
+The addresses for the account to be used for correspondence.
@@ -11372,7 +11482,10 @@
-
+
+
{
"maximumPlanCount" : 1 ,
"instalmentsLimit" : "string" ,
@@ -11398,7 +11511,7 @@ }
Details of instalment features on the account
+Details of instalment features on the account.
Properties
@@ -11440,7 +11553,7 @@ Properties
» plans
[BankingInstalmentPlans ]
optional
-Array of instalment plans
+Array of instalment plans.
@@ -11448,7 +11561,10 @@ B
-
+
+
{
"planNickname" : "string" ,
"creationDate" : "string" ,
@@ -11478,37 +11594,37 @@ Properties
planNickname
string
mandatory
-The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels
+The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with existing channels.
creationDate
DateString mandatory
-The date the plan was created
+The date the plan was created.
amount
AmountString mandatory
-The total amount of the plan
+The total amount of the plan.
duration
ExternalRef mandatory
-The original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The original expected repayment duration. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
instalmentInterval
ExternalRef mandatory
-The expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
schedule
[BankingInstalmentPlanSchedule ]
mandatory
-Array of expected repayment amounts and dates
+Array of expected repayment amounts and dates.
@@ -11516,7 +11632,10 @@
-
+
+
{
"amountDue" : "string" ,
"dueDate" : "string"
@@ -11537,13 +11656,13 @@ Properties amountDue
AmountString mandatory
-Amount due with this repayment
+Amount due with this repayment.
dueDate
DateString mandatory
-Date this repayment is due
+Date this repayment is due.
@@ -11551,7 +11670,10 @@
-
+
+
{
"lodgementDate" : "string" ,
"maturityDate" : "string" ,
@@ -11575,31 +11697,31 @@ Properties
lodgementDate
DateString mandatory
-The lodgement date of the original deposit
+The lodgement date of the original deposit.
maturityDate
DateString mandatory
-Maturity date for the term deposit
+Maturity date for the term deposit.
maturityAmount
AmountString optional
-Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated
+Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated.
maturityCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
maturityInstructions
Enum mandatory
-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
+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.
@@ -11629,7 +11751,10 @@
-
+
+
{
"minPaymentAmount" : "string" ,
"paymentDueAmount" : "string" ,
@@ -11652,25 +11777,25 @@ Properties
minPaymentAmount
AmountString mandatory
-The minimum payment amount due for the next card payment
+The minimum payment amount due for the next card payment.
paymentDueAmount
AmountString mandatory
-The amount due for the next card payment
+The amount due for the next card payment.
paymentCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
paymentDueDate
DateString mandatory
-Date that the next payment for the card is due
+Date that the next payment for the card is due.
@@ -11678,7 +11803,10 @@ Ban
-
+
+
{
"originalStartDate" : "string" ,
"originalLoanAmount" : "string" ,
@@ -11714,91 +11842,91 @@ Properties
originalStartDate
DateString optional
-Optional original start date for the loan
+Optional original start date for the loan.
originalLoanAmount
AmountString optional
-Optional original loan value
+Optional original loan value.
originalLoanCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
loanEndDate
DateString optional
-Date that the loan is due to be repaid in full
+Date that the loan is due to be repaid in full.
nextInstalmentDate
DateString optional
-Next date that an instalment is required
+Next date that an instalment is required.
minInstalmentAmount
AmountString optional
-Minimum amount of next instalment
+Minimum amount of next instalment.
minInstalmentCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
maxRedraw
AmountString optional
-Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account
+Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account.
maxRedrawCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
minRedraw
AmountString optional
-Minimum redraw amount
+Minimum redraw amount.
minRedrawCurrency
CurrencyString optional
-If absent assumes AUD
+If absent assumes AUD.
offsetAccountEnabled
Boolean optional
-Set to true if one or more offset accounts are configured for this loan account
+Set to true if one or more offset accounts are configured for this loan account.
offsetAccountIds
[ASCIIString] optional
-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
+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.
repaymentType
Enum optional
-Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST
+Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST.
repaymentFrequency
ExternalRef optional
-The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
+The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax).
@@ -11824,7 +11952,10 @@
-
+
+
{
"data" : {
"transactions" : [
@@ -11905,7 +12036,10 @@ Banki
-
+
+
{
"accountId" : "string" ,
"transactionId" : "string" ,
@@ -11942,103 +12076,103 @@ Properties
accountId
ASCIIString mandatory
-ID of the account for which transactions are provided
+ID of the account for which transactions are provided.
transactionId
ASCIIString conditional
-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.
+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.
isDetailAvailable
Boolean mandatory
-True if extended information is available using the transaction detail endpoint. False if extended data is not available
+true if extended information is available using the transaction detail endpoint. false if extended data is not available.
type
Enum mandatory
-The type of the transaction
+The type of the transaction.
status
Enum mandatory
-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
+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.
description
string
mandatory
-The transaction description as applied by the financial institution
+The transaction description as applied by the financial institution.
postingDateTime
DateTimeString conditional
-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
+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.
valueDateTime
DateTimeString optional
-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
+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.
executionDateTime
DateTimeString optional
-The time the transaction was executed by the originating customer, if available
+The time the transaction was executed by the originating customer, if available.
amount
AmountString mandatory
-The value of the transaction. Negative values mean money was outgoing from the account
+The value of the transaction. Negative values mean money was outgoing from the account.
currency
CurrencyString optional
-The currency for the transaction amount. AUD assumed if not present
+The currency for the transaction amount. AUD assumed if not present.
reference
string
mandatory
-The reference for the transaction provided by the originating institution. Empty string if no data provided
+The reference for the transaction provided by the originating institution. Empty string if no data provided.
merchantName
string
optional
-Name of the merchant for an outgoing payment to a merchant
+Name of the merchant for an outgoing payment to a merchant.
merchantCategoryCode
string
optional
-The merchant category code (or MCC) for an outgoing payment to a merchant
+The merchant category code (or MCC) for an outgoing payment to a merchant.
billerCode
string
optional
-BPAY Biller Code for the transaction (if available)
+BPAY Biller Code for the transaction (if available).
billerName
string
optional
-Name of the BPAY biller for the transaction (if available)
+Name of the BPAY biller for the transaction (if available).
crn
string
conditional
-BPAY CRN for the transaction (if available).
+BPAY CRN for the transaction (if available).MaskedPANString . If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
apcaNumber
@@ -12102,7 +12236,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -12176,7 +12313,10 @@
-
+
+
{
"accountId" : "string" ,
"transactionId" : "string" ,
@@ -12256,19 +12396,19 @@ Properties
»» payer
string
conditional
-Label of the originating payer. Mandatory for inbound payment
+Label of the originating payer. Mandatory for inbound payment.
»» payee
string
conditional
-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)
+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).
»» extensionUType
Enum optional
-Optional extended data specific to transactions originated via NPP
+Optional extended data specific to transactions originated via NPP.
»» x2p101Payload
@@ -12280,25 +12420,25 @@ Properties
»»» extendedDescription
string
conditional
-An extended string description. Required if the extensionUType field is x2p101Payload
+An extended string description. Required if the extensionUType field is x2p101Payload.
»»» endToEndId
string
optional
-An end to end ID for the payment created at initiation
+An end to end ID for the payment created at initiation.
»»» purposeCode
string
optional
-Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service
+Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service.
»» service
Enum mandatory
-Identifier of the applicable overlay service. Valid values are: X2P1.01
+Identifier of the applicable overlay service. Valid values are: X2P1.01.
@@ -12324,7 +12464,10 @@
-
+
+
{
"data" : {
"balances" : [
@@ -12378,7 +12521,7 @@ Propertie
» balances
[BankingBalance ]
mandatory
-The list of balances returned
+The list of balances returned.
links
@@ -12398,7 +12541,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -12455,7 +12601,10 @@ BankingBa
-
+
+
{
"accountId" : "string" ,
"currentBalance" : "string" ,
@@ -12486,43 +12635,43 @@ Properties
accountId
ASCIIString mandatory
-A unique ID of the account adhering to the standards for ID permanence
+A unique ID of the account adhering to the standards for ID permanence.
currentBalance
AmountString mandatory
-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
+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.
availableBalance
AmountString mandatory
-Balance representing the amount of funds available for transfer. Assumed to be zero or positive
+Balance representing the amount of funds available for transfer. Assumed to be zero or positive.
creditLimit
AmountString optional
-Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent
+Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent.
amortisedLimit
AmountString optional
-Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent
+Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent.
currency
CurrencyString optional
-The currency for the balance amounts. If absent assumed to be AUD
+The currency for the balance amounts. If absent assumed to be AUD.
purses
[BankingBalancePurse ]
optional
-Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards
+Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards.
@@ -12530,7 +12679,10 @@ Bank
-
+
+
{
"amount" : "string" ,
"currency" : "string"
@@ -12551,13 +12703,13 @@ Properties
amount
AmountString mandatory
-The balance available for this additional currency purse
+The balance available for this additional currency purse.
currency
CurrencyString optional
-The currency for the purse
+The currency for the purse.
@@ -12565,7 +12717,10 @@
-
+
+
{
"data" : {
"payees" : [
@@ -12612,7 +12767,7 @@ Properties
» payees
[BankingPayeeV2 ]
mandatory
-The list of payees returned
+The list of payees returned.
links
@@ -12632,7 +12787,10 @@
-
+
+
{
"data" : {
"payeeId" : "string" ,
@@ -12731,7 +12889,10 @@ BankingPa
-
+
+
{
"payeeId" : "string" ,
"nickname" : "string" ,
@@ -12755,31 +12916,31 @@ Properties
payeeId
ASCIIString mandatory
-ID of the payee adhering to the rules of ID permanence
+ID of the payee adhering to the rules of ID permanence.
nickname
string
mandatory
-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
+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.
description
string
optional
-A description of the payee provided by the customer
+A description of the payee provided by the customer.
type
Enum mandatory
-The type of payee.
+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.
creationDate
DateString optional
-The date the payee was created by the customer
+The date the payee was created by the customer.
@@ -12813,7 +12974,10 @@ Ban
-
+
+
{
"payeeId" : "string" ,
"nickname" : "string" ,
@@ -12912,7 +13076,7 @@ Properties
» payeeUType
Enum mandatory
-Type of object included that describes the payee in detail
+Type of object included that describes the payee in detail.
» biller
@@ -12970,7 +13134,10 @@ Ban
-
+
+
{
"payeeAccountUType" : "account" ,
"account" : {
@@ -13003,7 +13170,7 @@ Properties
payeeAccountUType
Enum mandatory
-Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number. card A credit or charge card to pay to (note that PANs are masked). payId A PayID recognised by NPP
+Type of account object included. Valid values are: account A standard Australian account defined by BSB/Account Number.card A credit or charge card to pay to (note that PANs are masked).payId A PayID recognised by NPP.
account
@@ -13051,7 +13218,10 @@
-
+
+
{
"accountName" : "string" ,
"bsb" : "string" ,
@@ -13073,19 +13243,19 @@ Properties
accountName
string
optional
-Name of the account to pay to
+Name of the account to pay to.
bsb
string
mandatory
-BSB of the account to pay to
+BSB of the account to pay to.
accountNumber
string
mandatory
-Number of the account to pay to
+Number of the account to pay to.
@@ -13093,7 +13263,10 @@
-
+
+
{
"cardNumber" : "string"
}
@@ -13113,7 +13286,7 @@ Properties
cardNumber
MaskedPANString mandatory
-Name of the account to pay to
+Name of the account to pay to.
@@ -13121,7 +13294,10 @@
-
+
+
{
"name" : "string" ,
"identifier" : "string" ,
@@ -13143,19 +13319,19 @@ Properties
name
string
optional
-The name assigned to the PayID by the owner of the PayID
+The name assigned to the PayID by the owner of the PayID.
identifier
string
mandatory
-The identifier of the PayID (dependent on type)
+The identifier of the PayID (dependent on type).
type
Enum mandatory
-The type of the PayID
+The type of the PayID.
@@ -13189,7 +13365,10 @@ Banki
-
+
+
{
"billerCode" : "string" ,
"crn" : "string" ,
@@ -13211,19 +13390,19 @@ Properties
billerCode
string
mandatory
-BPAY Biller Code of the Biller
+BPAY Biller Code of the Biller.
crn
string
conditional
-BPAY CRN of the Biller (if available).
+BPAY CRN of the Biller (if available).MaskedPANString . If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
billerName
string
mandatory
-Name of the Biller
+Name of the Biller.
@@ -13231,7 +13410,10 @@
-
+
+
{
"beneficiaryDetails" : {
"name" : "string" ,
@@ -13275,19 +13457,19 @@ Properties
» name
string
optional
-Name of the beneficiary
+Name of the beneficiary.
» country
ExternalRef mandatory
-Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code
+Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code.
» message
string
optional
-Response message for the payment
+Response message for the payment.
bankDetails
@@ -13299,13 +13481,13 @@ Properties
» country
ExternalRef mandatory
-Country of the recipient institution. A valid ISO 3166 Alpha-3 country code
+Country of the recipient institution. A valid ISO 3166 Alpha-3 country code.
» accountNumber
string
mandatory
-Account Targeted for payment
+Account Targeted for payment.
» bankAddress
@@ -13317,49 +13499,49 @@ Properties
»» name
string
mandatory
-Name of the recipient Bank
+Name of the recipient Bank.
»» address
string
mandatory
-Address of the recipient Bank
+Address of the recipient Bank.
» beneficiaryBankBIC
ExternalRef optional
-Swift bank code. Aligns with standard ISO 9362
+Swift bank code. Aligns with standard ISO 9362 .
» fedWireNumber
string
optional
-Number for Fedwire payment (Federal Reserve Wire Network)
+Number for Fedwire payment (Federal Reserve Wire Network).
» sortCode
string
optional
-Sort code used for account identification in some jurisdictions
+Sort code used for account identification in some jurisdictions.
» chipNumber
string
optional
-Number for the Clearing House Interbank Payments System
+Number for the Clearing House Interbank Payments System.
» routingNumber
string
optional
-International bank routing number
+International bank routing number.
» legalEntityIdentifier
ExternalRef optional
-The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442
+The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442 .
@@ -13367,7 +13549,10 @@
-
+
+
{
"name" : "string" ,
"identifier" : "string" ,
@@ -13390,25 +13575,25 @@ Properties
name
string
mandatory
-The display name of the wallet as given by the customer, else a default value defined by the data holder
+The display name of the wallet as given by the customer, else a default value defined by the data holder.
identifier
string
mandatory
-The identifier of the digital wallet (dependent on type)
+The identifier of the digital wallet (dependent on type).
type
Enum mandatory
-The type of the digital wallet identifier
+The type of the digital wallet identifier.
provider
Enum mandatory
-The provider of the digital wallet
+The provider of the digital wallet.
@@ -13446,7 +13631,10 @@
-
+
+
{
"data" : {
"directDebitAuthorisations" : [
@@ -13498,7 +13686,7 @@
» directDebitAuthorisations
[BankingDirectDebit ]
mandatory
-The list of authorisations returned
+The list of authorisations returned.
links
@@ -13518,7 +13706,10 @@ Banki
-
+
+
{
"accountId" : "string" ,
"authorisedEntity" : {
@@ -13559,13 +13750,13 @@ Properties
lastDebitDateTime
DateTimeString optional
-The date and time of the last debit executed under this authorisation
+The date and time of the last debit executed under this authorisation.
lastDebitAmount
AmountString optional
-The amount of the last debit executed under this authorisation
+The amount of the last debit executed under this authorisation.
@@ -13573,7 +13764,10 @@
-
+
+
{
"description" : "string" ,
"financialInstitution" : "string" ,
@@ -13597,31 +13791,31 @@ Properties
description
string
optional
-Description of the authorised entity derived from previously executed direct debits
+Description of the authorised entity derived from previously executed direct debits.
financialInstitution
string
conditional
-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
+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.
abn
string
optional
-Australian Business Number for the authorised entity
+Australian Business Number for the authorised entity.
acn
string
optional
-Australian Company Number for the authorised entity
+Australian Company Number for the authorised entity.
arbn
string
optional
-Australian Registered Body Number for the authorised entity
+Australian Registered Body Number for the authorised entity.
@@ -13629,7 +13823,10 @@
-
+
+
{
"data" : {
"scheduledPayments" : [
@@ -13769,7 +13966,7 @@ Prope
» scheduledPayments
[BankingScheduledPaymentV2 ]
mandatory
-The list of scheduled payments to return
+The list of scheduled payments to return.
links
@@ -13789,7 +13986,10 @@
-
+
+
{
"scheduledPaymentId" : "string" ,
"nickname" : "string" ,
@@ -13906,49 +14106,49 @@ Properties
scheduledPaymentId
ASCIIString mandatory
-A unique ID of the scheduled payment adhering to the standards for ID permanence
+A unique ID of the scheduled payment adhering to the standards for ID permanence.
nickname
string
optional
-The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels
+The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.
payerReference
string
mandatory
-The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided
+The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided.
payeeReference
string
conditional
-The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided
+The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.
status
Enum mandatory
-Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
+Indicates whether the schedule is currently active. The value SKIP is equivalent to ACTIVE except that the customer has requested the next normal occurrence to be skipped.
from
BankingScheduledPaymentFrom mandatory
-Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
+Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object.
paymentSet
[BankingScheduledPaymentSetV2 ]
mandatory
-[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry]
+[The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.]
recurrence
BankingScheduledPaymentRecurrence mandatory
-Object containing the detail of the schedule for the payment
+Object containing the detail of the schedule for the payment.
@@ -13978,7 +14178,10 @@
-
+
+
{
"to" : {
"toUType" : "accountId" ,
@@ -14041,7 +14244,7 @@ }
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
+The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.
Properties
@@ -14057,25 +14260,25 @@ Properties
to
BankingScheduledPaymentToV2 mandatory
-Object containing details of the destination of the payment. Used to specify a variety of payment destination types
+Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
isAmountCalculated
Boolean optional
-Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed
+Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed.
amount
AmountString conditional
-The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present
+The amount of the next payment if known. Mandatory unless the isAmountCalculated field is set to true. Must be zero or positive if present.
currency
CurrencyString optional
-The currency for the payment. AUD assumed if not present
+The currency for the payment. AUD assumed if not present.
@@ -14083,7 +14286,10 @@
-
+
+
{
"toUType" : "accountId" ,
"accountId" : "string" ,
@@ -14141,7 +14347,7 @@ }
Object containing details of the destination of the payment. Used to specify a variety of payment destination types
+Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
Properties
@@ -14163,19 +14369,19 @@ Properties
accountId
ASCIIString conditional
-Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent
+Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent.
payeeId
ASCIIString conditional
-Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. 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
+Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead.
nickname
string
conditional
-The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels
+The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.
payeeReference
@@ -14247,13 +14453,16 @@
-
+
+
{
"accountId" : "string"
}
Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object
+Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object.
Properties
@@ -14269,7 +14478,7 @@ Properties
accountId
ASCIIString mandatory
-ID of the account that is the source of funds for the payment
+ID of the account that is the source of funds for the payment.
@@ -14277,7 +14486,10 @@
-
+
+
{
"nextPaymentDate" : "string" ,
"recurrenceUType" : "eventBased" ,
@@ -14308,7 +14520,7 @@ }
Object containing the detail of the schedule for the payment
+Object containing the detail of the schedule for the payment.
Properties
@@ -14324,37 +14536,37 @@ Properties
nextPaymentDate
DateString optional
-The date of the next payment under the recurrence schedule
+The date of the next payment under the recurrence schedule.
recurrenceUType
Enum mandatory
-The type of recurrence used to define the schedule
+The type of recurrence used to define the schedule.
onceOff
BankingScheduledPaymentRecurrenceOnceOff conditional
-Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
+Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.
intervalSchedule
BankingScheduledPaymentRecurrenceIntervalSchedule conditional
-Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
+Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.
lastWeekDay
BankingScheduledPaymentRecurrenceLastWeekday conditional
-Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay
+Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.
eventBased
BankingScheduledPaymentRecurrenceEventBased conditional
-Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.
@@ -14388,13 +14600,16 @@
-
+
+
{
"paymentDate" : "string"
}
Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff
+Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.
Properties
@@ -14410,7 +14625,7 @@ Pro
paymentDate
DateString mandatory
-The scheduled date for the once off payment
+The scheduled date for the once off payment.
@@ -14418,7 +14633,10 @@
-
+
+
{
"finalPaymentDate" : "string" ,
"paymentsRemaining" : 1 ,
@@ -14432,7 +14650,7 @@ }
Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule
+Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.
Properties
@@ -14448,25 +14666,25 @@ DateString
optional
-The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
paymentsRemaining
PositiveInteger optional
-Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely
+Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value, If neither field is present the payments will continue indefinitely.
nonBusinessDayTreatment
Enum optional
-Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.
intervals
[BankingScheduledPaymentInterval ]
mandatory
-An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry
+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.
@@ -14500,7 +14718,10 @@
-
+
+
{
"interval" : "string" ,
"dayInInterval" : "string"
@@ -14521,13 +14742,13 @@ Propertiesinterval
ExternalRef mandatory
-An interval for the payment. Formatted according to 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
+An interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate .
dayInInterval
ExternalRef optional
-Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
+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 (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday.
@@ -14535,7 +14756,10 @@
-
+
+
{
"finalPaymentDate" : "string" ,
"paymentsRemaining" : 1 ,
@@ -14545,7 +14769,7 @@ }
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
+Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.
Properties
@@ -14561,19 +14785,19 @@ finalPaymentDate
DateString optional
-The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
paymentsRemaining
PositiveInteger optional
-Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely
+Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely.
interval
ExternalRef mandatory
-The interval for the payment. Formatted according to 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
+The interval for the payment. Formatted according to ISO 8601 Durations (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate .
lastWeekDay
@@ -14585,7 +14809,7 @@ nonBusinessDayTreatment
Enum optional
-Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored
+Enumerated 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.
@@ -14647,13 +14871,16 @@
-
+
+
{
"description" : "string"
}
Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased
+Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.
Properties
@@ -14669,7 +14896,7 @@
description
string
mandatory
-Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer
+Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer.
@@ -14677,7 +14904,10 @@ Co
-
+
+
{
"addressUType" : "paf" ,
"simple" : {
@@ -14731,7 +14961,7 @@ Properties
addressUType
Enum mandatory
-The type of address object present
+The type of address object present.
simple
@@ -14743,7 +14973,7 @@ Properties
paf
CommonPAFAddress conditional
-Australian address formatted according to the file format defined by the PAF file format
+Australian address formatted according to the file format defined by the PAF file format .
@@ -14769,7 +14999,10 @@ Comm
-
+
+
{
"mailingName" : "string" ,
"addressLine1" : "string" ,
@@ -14796,49 +15029,49 @@ Properties
mailingName
string
optional
-Name of the individual or business formatted for inclusion in an address used for physical mail
+Name of the individual or business formatted for inclusion in an address used for physical mail.
addressLine1
string
mandatory
-First line of the standard address object
+First line of the standard address object.
addressLine2
string
optional
-Second line of the standard address object
+Second line of the standard address object.
addressLine3
string
optional
-Third line of the standard address object
+Third line of the standard address object.
postcode
string
conditional
-Mandatory for Australian addresses
+Mandatory for Australian addresses.
city
string
mandatory
-Name of the city or locality
+Name of the city or locality.
state
string
mandatory
-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 in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+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 in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
country
ExternalRef optional
-A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
+A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.
@@ -14846,7 +15079,10 @@ CommonP
-
+
+
{
"dpid" : "string" ,
"thoroughfareNumber1" : 0 ,
@@ -14873,7 +15109,7 @@ CommonP
}
Australian address formatted according to the file format defined by the PAF file format
+Australian address formatted according to the file format defined by the PAF file format .
Properties
@@ -14889,133 +15125,133 @@ Properties
dpid
string
optional
-Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
+Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.
thoroughfareNumber1
PositiveInteger optional
-Thoroughfare number for a property (first number in a property ranged address)
+Thoroughfare number for a property (first number in a property ranged address).
thoroughfareNumber1Suffix
string
optional
-Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
+Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated.
thoroughfareNumber2
PositiveInteger optional
-Second thoroughfare number (only used if the property has a ranged address eg 23-25)
+Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25).
thoroughfareNumber2Suffix
string
optional
-Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
+Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated.
flatUnitType
string
optional
-Type of flat or unit for the address
+Type of flat or unit for the address.
flatUnitNumber
string
optional
-Unit number (including suffix, if applicable)
+Unit number (including suffix, if applicable).
floorLevelType
string
optional
-Type of floor or level for the address
+Type of floor or level for the address.
floorLevelNumber
string
optional
-Floor or level number (including alpha characters)
+Floor or level number (including alpha characters).
lotNumber
string
optional
-Allotment number for the address
+Allotment number for the address.
buildingName1
string
optional
-Building/Property name 1
+Building/Property name 1.
buildingName2
string
optional
-Building/Property name 2
+Building/Property name 2.
streetName
string
optional
-The name of the street
+The name of the street.
streetType
string
optional
-The street type. Valid enumeration defined by Australia Post PAF code file
+The street type. Valid enumeration defined by Australia Post PAF code file.
streetSuffix
string
optional
-The street type suffix. Valid enumeration defined by Australia Post PAF code file
+The street type suffix. Valid enumeration defined by Australia Post PAF code file.
postalDeliveryType
string
optional
-Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
+Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file.
postalDeliveryNumber
PositiveInteger optional
-Postal delivery number if the address is a postal delivery type
+Postal delivery number if the address is a postal delivery type.
postalDeliveryNumberPrefix
string
optional
-Postal delivery number prefix related to the postal delivery number
+Postal delivery number prefix related to the postal delivery number.
postalDeliveryNumberSuffix
string
optional
-Postal delivery number suffix related to the postal delivery number
+Postal delivery number suffix related to the postal delivery number.
localityName
string
mandatory
-Full name of locality
+Full name of locality.
postcode
string
mandatory
-Postcode for the locality
+Postcode for the locality.
state
string
mandatory
-State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation . NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
+State in which the address belongs. Valid enumeration defined by Australia Post PAF code file State Type Abbreviation . NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT.
@@ -15023,7 +15259,10 @@ Links
-
+
+
{
"self" : "string"
}
@@ -15043,7 +15282,7 @@ Properties
self
URIString mandatory
-Fully qualified link that generated the current response document
+Fully qualified link that generated the current response document.
@@ -15051,7 +15290,10 @@
-
+
+
{}
LinksPagi
-
+
+
{
"self" : "string" ,
"first" : "string" ,
@@ -15087,31 +15332,31 @@ Properties
self
URIString mandatory
-Fully qualified link that generated the current response document
+Fully qualified link that generated the current response document.
first
URIString conditional
-URI to the first page of this set. Mandatory if this response is not the first page
+URI to the first page of this set. Mandatory if this response is not the first page.
prev
URIString conditional
-URI to the previous page of this set. Mandatory if this response is not the first page
+URI to the previous page of this set. Mandatory if this response is not the first page.
next
URIString conditional
-URI to the next page of this set. Mandatory if this response is not the last page
+URI to the next page of this set. Mandatory if this response is not the last page.
last
URIString conditional
-URI to the last page of this set. Mandatory if this response is not the last page
+URI to the last page of this set. Mandatory if this response is not the last page.
@@ -15119,7 +15364,10 @@
-
+
+
{
"totalRecords" : 0 ,
"totalPages" : 0
@@ -15154,7 +15402,10 @@
+
+
{
"totalRecords" : 0 ,
"totalPages" : 0 ,
@@ -15202,7 +15453,7 @@
» isQueryParamUnsupported
Boolean optional
-true if "text" query parameter is not supportedtrue if text query parameter is not supported.
-
+
+
{
"urn" : "string"
}
Additional data for customised error codes
+Additional data for customised error codes.
@@ -15232,7 +15486,7 @@
urn
string
conditional
-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.
+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.
@@ -15240,7 +15494,10 @@ Resp
-
+
+
{
"errors" : [
{
@@ -15293,7 +15550,7 @@ Properties
» meta
MetaError optional
-Additional data for customised error codes
+Additional data for customised error codes.
@@ -15301,11 +15558,14 @@
-
+
+
"BUSINESS_LOANS"
The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
Properties
@@ -15321,7 +15581,7 @@ Properties
anonymous Enum mandatory
-The category to which a product or account belongs. See here for more details
+The category to which a product or account belongs. See here for more details.
diff --git a/docs/includes/additional/candidates/non-bank-lending/banking-non-bank-lending_apis b/docs/includes/additional/candidates/non-bank-lending/banking-non-bank-lending_apis
index d1343fe2..056a06a4 100644
--- a/docs/includes/additional/candidates/non-bank-lending/banking-non-bank-lending_apis
+++ b/docs/includes/additional/candidates/non-bank-lending/banking-non-bank-lending_apis
@@ -1,4 +1,5 @@
-Banking APIs
+Banking APIs In addition to minor styling updates, aligned Banking documentation to enhancements applied in the Candidate Standards
+This specification defines the APIs for Data Holders exposing Banking endpoints.
diff --git a/docs/includes/additional/candidates/telco.html b/docs/includes/additional/candidates/telco.html
index 7ea957c7..bcfe0a44 100644
--- a/docs/includes/additional/candidates/telco.html
+++ b/docs/includes/additional/candidates/telco.html
@@ -606,7 +606,8 @@ Telco APIs
This specification defines the APIs for Data Holders exposing Telecommunications endpoints.
-
+Removed duplicate `TelcoAccount` schema in the `TelcoAccountDetailResponseData` schema, in the 'Get Telco Account Detail' endpoint in the Telco Candidate Standards
+
Telco OpenAPI Specification (JSON) Telco OpenAPI Specification (YAML) T
-
+
+
{
"data" : {
"plans" : [
@@ -6145,7 +6149,10 @@ Telco
-
+
+
{
"data" : {
"productId" : "string" ,
@@ -6336,7 +6343,10 @@ TelcoUs
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -6436,7 +6446,10 @@
-
+
+
{
"data" : {
"serviceId" : "string" ,
@@ -6529,7 +6542,10 @@
-
+
+
{
"data" : [
{
@@ -6631,7 +6647,10 @@ T
-
+
+
{
"data" : {
"accounts" : [
@@ -6709,7 +6728,10 @@
-
+
+
{
"data" : {
"accountId" : "string" ,
@@ -6787,7 +6809,10 @@
-
+
+
{
"data" : {
"paymentSchedules" : [
@@ -6868,7 +6893,10 @@ T
-
+
+
{
"data" : {
"concessions" : [
@@ -6936,7 +6964,10 @@ T
-
+
+
{
"data" : {
"balances" : [
@@ -7056,7 +7087,10 @@ Telco
-
+
+
{
"data" : {
"services" : [
@@ -7162,7 +7196,10 @@
-
+
+
{
"data" : {
"transactions" : [
@@ -7261,7 +7298,10 @@
-
+
+
{
"urn" : "string"
}
@@ -7291,7 +7331,10 @@ Respon
-
+
+
{
"errors" : [
{
@@ -7352,7 +7395,10 @@ TelcoProduct<
-
+
+
{
"productId" : "string" ,
"effectiveFrom" : "string" ,
@@ -7563,7 +7609,10 @@ TelcoContrac
-
+
+
{
"name" : "string" ,
"description" : "string" ,
@@ -7614,7 +7663,10 @@ TelcoSe
-
+
+
{
"serviceId" : "string"
}
@@ -7642,7 +7694,10 @@ TelcoAcc
-
+
+
{
"accountId" : "string" ,
"services" : [
@@ -7730,7 +7785,10 @@ TelcoSer
-
+
+
{
"serviceId" : "string" ,
"displayName" : "string" ,
@@ -7835,7 +7893,10 @@ TelcoAcco
-
+
+
{
"accountId" : "string" ,
"accountNumber" : "string" ,
@@ -7923,7 +7984,10 @@ T
-
+
+
{
"accountId" : "string" ,
"accountNumber" : "string" ,
@@ -7992,7 +8056,10 @@
-
+
+
{
"accountId" : "string" ,
"accountNumber" : "string" ,
@@ -8052,24 +8119,6 @@ Properties
and
-
-
-Name
-Type
-Required
-Description
-
-
-
-anonymous TelcoAccount mandatory
-The array of plans containing services and associated plan details
-
-
-
-and
-
Name
@@ -8090,7 +8139,10 @@ Telco
-
+
+
{
"amount" : "string" ,
"paymentScheduleUType" : "cardDebit" ,
@@ -8198,7 +8250,10 @@