NAV Navbar
CDR Data Standards

Get Accounts V2

This page documents the obsolete version 2 of the Get Accounts endpoint.

Data Holders can retire this version after December 7th 2026. Data Recipients must update to newer versions prior to this date.

Get Accounts

Code samples

GET https://mtls.dh.example.com/cds-au/v1/banking/accounts HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string
const fetch = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'
};

fetch('https://mtls.dh.example.com/cds-au/v1/banking/accounts', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /banking/accounts

Obtain a list of accounts.

Obsolete versions: v1.

Endpoint Version

Version 2

Parameters

Name In Type Required Default Description
product-category query BankingProductCategory optional Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
open-status query Enum optional ALL 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.
page query PositiveInteger optional 1 Page of results to request (standard pagination).
page-size query PositiveInteger optional 25 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 endpoint 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 endpoint MUST respond with a 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 endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a 406 Not Acceptable.
x-fapi-interaction-id header string optional An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
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]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address header string optional The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers header Base64 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.

Enumerated Values

Parameter Value
product-category BUSINESS_LOANS
product-category CRED_AND_CHRG_CARDS
product-category LEASES
product-category MARGIN_LOANS
product-category OVERDRAFTS
product-category PERS_LOANS
product-category REGULATED_TRUST_ACCOUNTS
product-category RESIDENTIAL_MORTGAGES
product-category TERM_DEPOSITS
product-category TRADE_FINANCE
product-category TRANS_AND_SAVINGS_ACCOUNTS
product-category TRAVEL_CARDS
open-status ALL
open-status CLOSED
open-status OPEN

Example responses

200 Response

{
  "data": {
    "accounts": [
      {
        "accountId": "string",
        "creationDate": "string",
        "displayName": "string",
        "nickname": "string",
        "openStatus": "CLOSED",
        "isOwned": true,
        "accountOwnership": "UNKNOWN",
        "maskedNumber": "string",
        "productCategory": "BUSINESS_LOANS",
        "productName": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Successful response ResponseBankingAccountListV2
400 Bad Request The following error codes MUST be supported:
ResponseErrorListV2
406 Not Acceptable The following error codes MUST be supported:
ResponseErrorListV2
422 Unprocessable Entity The following error codes MUST be supported:
ResponseErrorListV2

Response Headers

Status Header Type Required Description
200 x-v string mandatory The payload version that the endpoint has responded with.
200 x-fapi-interaction-id string mandatory An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400 x-fapi-interaction-id string mandatory An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406 x-fapi-interaction-id string mandatory An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422 x-fapi-interaction-id string mandatory An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.

Schemas

RequestAccountIdListV1

{
  "data": {
    "accountIds": [
      "string"
    ]
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data object mandatory none
» accountIds [BankingAccountId] mandatory Array of accountId values to obtain data for.
meta Meta optional none

ResponseBankingProductListV3

{
  "data": {
    "products": [
      {
        "productId": "string",
        "effectiveFrom": "string",
        "effectiveTo": "string",
        "lastUpdated": "string",
        "productCategory": "BUSINESS_LOANS",
        "name": "string",
        "description": "string",
        "brand": "string",
        "brandName": "string",
        "applicationUri": "string",
        "isTailored": true,
        "additionalInformation": {
          "overviewUri": "string",
          "termsUri": "string",
          "eligibilityUri": "string",
          "feesAndPricingUri": "string",
          "bundleUri": "string",
          "additionalOverviewUris": [
            {
              "description": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalTermsUris": [
            {
              "description": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalEligibilityUris": [
            {
              "description": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalFeesAndPricingUris": [
            {
              "description": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalBundleUris": [
            {
              "description": "string",
              "additionalInfoUri": "string"
            }
          ]
        },
        "cardArt": [
          {
            "cardScheme": "AMEX",
            "cardType": "CHARGE",
            "title": "string",
            "imageUri": "string"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» products [BankingProductV5] mandatory The list of products returned. If the filter results in an empty set then this array may have no records.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

BankingProductV5

{
  "productId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "productCategory": "BUSINESS_LOANS",
  "name": "string",
  "description": "string",
  "brand": "string",
  "brandName": "string",
  "applicationUri": "string",
  "isTailored": true,
  "additionalInformation": {
    "overviewUri": "string",
    "termsUri": "string",
    "eligibilityUri": "string",
    "feesAndPricingUri": "string",
    "bundleUri": "string",
    "additionalOverviewUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalTermsUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalEligibilityUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalFeesAndPricingUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalBundleUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ]
  },
  "cardArt": [
    {
      "cardScheme": "AMEX",
      "cardType": "CHARGE",
      "title": "string",
      "imageUri": "string"
    }
  ]
}

Properties

Name Type Required Default Description
productId BankingProductId mandatory A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.
effectiveFrom DateTimeString optional 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.
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).
productCategory BankingProductCategory mandatory The category to which a product or account belongs. See here for more details.
name string mandatory The display name of the product.
description string mandatory 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.
brandName string optional An optional display name of the brand.
applicationUri URIString optional A link to an application web page where this product can be applied for.
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.
additionalInformation BankingProductAdditionalInformationV2 optional Object that contains links to additional information on specific topics.
cardArt [BankingProductCardArt] optional Information about any cards available with the account.

BankingProductCardArt

{
  "cardScheme": "AMEX",
  "cardType": "CHARGE",
  "title": "string",
  "imageUri": "string"
}

Properties

Name Type Required Default Description
cardScheme Enum mandatory Card scheme available with the account.
cardType Enum mandatory Card type available with the account.
title string optional 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].

Enumerated Values

Property Value
cardScheme AMEX
cardScheme EFTPOS
cardScheme MASTERCARD
cardScheme VISA
cardScheme OTHER
cardType CHARGE
cardType CREDIT
cardType DEBIT

BankingProductAdditionalInformationV2

{
  "overviewUri": "string",
  "termsUri": "string",
  "eligibilityUri": "string",
  "feesAndPricingUri": "string",
  "bundleUri": "string",
  "additionalOverviewUris": [
    {
      "description": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalTermsUris": [
    {
      "description": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalEligibilityUris": [
    {
      "description": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalFeesAndPricingUris": [
    {
      "description": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalBundleUris": [
    {
      "description": "string",
      "additionalInfoUri": "string"
    }
  ]
}

Object that contains links to additional information on specific topics.

Properties

Name Type Required Default Description
overviewUri URIString conditional General overview of the product. Mandatory if additionalOverviewUris includes one or more supporting documents.
termsUri URIString conditional Terms and conditions for the product. Mandatory if additionalTermsUris includes one or more supporting documents.
eligibilityUri URIString conditional Eligibility rules and criteria for the product. Mandatory if additionalEligibilityUris includes one or more supporting documents.
feesAndPricingUri URIString conditional Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if additionalFeesAndPricingUris includes one or more supporting documents.
bundleUri URIString conditional Description of a bundle that this product can be part of. Mandatory if additionalBundleUris includes one or more supporting documents.
additionalOverviewUris [BankingProductAdditionalInformationV2_additionalInformationUris] optional An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the overviewUri. Only to be used if there is a primary overviewUri.
additionalTermsUris [BankingProductAdditionalInformationV2_additionalInformationUris] optional An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the termsUri. Only to be used if there is a primary termsUri.
additionalEligibilityUris [BankingProductAdditionalInformationV2_additionalInformationUris] optional An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the eligibilityUri. Only to be used if there is a primary eligibilityUri.
additionalFeesAndPricingUris [BankingProductAdditionalInformationV2_additionalInformationUris] optional An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the feesAndPricingUri. Only to be used if there is a primary feesAndPricingUri.
additionalBundleUris [BankingProductAdditionalInformationV2_additionalInformationUris] optional An array of additional bundles for the product, if applicable. To be treated as secondary documents to the bundleUri. Only to be used if there is a primary bundleUri.

BankingProductAdditionalInformationV2_additionalInformationUris

{
  "description": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
description string optional Display text providing more information about the document URI.
additionalInfoUri URIString mandatory The URI describing the additional information.

ResponseBankingProductByIdV6

{
  "data": {
    "productId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "productCategory": "BUSINESS_LOANS",
    "name": "string",
    "description": "string",
    "brand": "string",
    "brandName": "string",
    "applicationUri": "string",
    "isTailored": true,
    "additionalInformation": {
      "overviewUri": "string",
      "termsUri": "string",
      "eligibilityUri": "string",
      "feesAndPricingUri": "string",
      "bundleUri": "string",
      "additionalOverviewUris": [
        {
          "description": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalTermsUris": [
        {
          "description": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalEligibilityUris": [
        {
          "description": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalFeesAndPricingUris": [
        {
          "description": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalBundleUris": [
        {
          "description": "string",
          "additionalInfoUri": "string"
        }
      ]
    },
    "cardArt": [
      {
        "cardScheme": "AMEX",
        "cardType": "CHARGE",
        "title": "string",
        "imageUri": "string"
      }
    ],
    "bundles": [
      {
        "name": "string",
        "description": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "productIds": [
          "string"
        ]
      }
    ],
    "features": [
      {
        "featureType": "ADDITIONAL_CARDS",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "constraints": [
      {
        "constraintType": "MAX_BALANCE",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "eligibility": [
      {
        "eligibilityType": "BUSINESS",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "fees": [
      {
        "name": "string",
        "feeType": "CASH_ADVANCE",
        "feeMethodUType": "fixedAmount",
        "fixedAmount": {
          "amount": "string"
        },
        "rateBased": {
          "rateType": "BALANCE",
          "rate": "string",
          "accrualFrequency": "string",
          "amountRange": {
            "feeMinimum": "string",
            "feeMaximum": "string"
          }
        },
        "variable": {
          "feeMinimum": "string",
          "feeMaximum": "string"
        },
        "feeCap": "string",
        "feeCapPeriod": "string",
        "currency": "AUD",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "discounts": [
          {
            "description": "string",
            "discountType": "BALANCE",
            "discountMethodUType": "fixedAmount",
            "fixedAmount": {
              "amount": "string"
            },
            "rateBased": {
              "rateType": "BALANCE",
              "rate": "string",
              "amountRange": {
                "discountMinimum": "string",
                "discountMaximum": "string"
              }
            },
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string",
            "eligibility": [
              {
                "discountEligibilityType": "BUSINESS",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ]
          }
        ]
      }
    ],
    "depositRates": [
      {
        "depositRateType": "VARIABLE",
        "rate": "string",
        "calculationFrequency": "string",
        "applicationType": "PERIODIC",
        "applicationFrequency": "string",
        "tiers": [
          {
            "name": "string",
            "unitOfMeasure": "DAY",
            "minimumValue": "string",
            "maximumValue": "string",
            "rateApplicationMethod": "PER_TIER",
            "applicabilityConditions": [
              {
                "rateApplicabilityType": "NEW_CUSTOMER",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "applicabilityConditions": [
          {
            "rateApplicabilityType": "NEW_CUSTOMER",
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "lendingRates": [
      {
        "lendingRateType": "FIXED",
        "rate": "string",
        "comparisonRate": "string",
        "calculationFrequency": "string",
        "applicationType": "PERIODIC",
        "applicationFrequency": "string",
        "interestPaymentDue": "IN_ADVANCE",
        "repaymentType": "INTEREST_ONLY",
        "loanPurpose": "INVESTMENT",
        "tiers": [
          {
            "name": "string",
            "unitOfMeasure": "DAY",
            "minimumValue": "string",
            "maximumValue": "string",
            "rateApplicationMethod": "PER_TIER",
            "applicabilityConditions": [
              {
                "rateApplicabilityType": "NEW_CUSTOMER",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "applicabilityConditions": [
          {
            "rateApplicabilityType": "NEW_CUSTOMER",
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data BankingProductDetailV6 mandatory none
links Links mandatory none
meta Meta optional none

BankingProductDetailV6

{
  "productId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "productCategory": "BUSINESS_LOANS",
  "name": "string",
  "description": "string",
  "brand": "string",
  "brandName": "string",
  "applicationUri": "string",
  "isTailored": true,
  "additionalInformation": {
    "overviewUri": "string",
    "termsUri": "string",
    "eligibilityUri": "string",
    "feesAndPricingUri": "string",
    "bundleUri": "string",
    "additionalOverviewUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalTermsUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalEligibilityUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalFeesAndPricingUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ],
    "additionalBundleUris": [
      {
        "description": "string",
        "additionalInfoUri": "string"
      }
    ]
  },
  "cardArt": [
    {
      "cardScheme": "AMEX",
      "cardType": "CHARGE",
      "title": "string",
      "imageUri": "string"
    }
  ],
  "bundles": [
    {
      "name": "string",
      "description": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "productIds": [
        "string"
      ]
    }
  ],
  "features": [
    {
      "featureType": "ADDITIONAL_CARDS",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "constraints": [
    {
      "constraintType": "MAX_BALANCE",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "eligibility": [
    {
      "eligibilityType": "BUSINESS",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "fees": [
    {
      "name": "string",
      "feeType": "CASH_ADVANCE",
      "feeMethodUType": "fixedAmount",
      "fixedAmount": {
        "amount": "string"
      },
      "rateBased": {
        "rateType": "BALANCE",
        "rate": "string",
        "accrualFrequency": "string",
        "amountRange": {
          "feeMinimum": "string",
          "feeMaximum": "string"
        }
      },
      "variable": {
        "feeMinimum": "string",
        "feeMaximum": "string"
      },
      "feeCap": "string",
      "feeCapPeriod": "string",
      "currency": "AUD",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "discounts": [
        {
          "description": "string",
          "discountType": "BALANCE",
          "discountMethodUType": "fixedAmount",
          "fixedAmount": {
            "amount": "string"
          },
          "rateBased": {
            "rateType": "BALANCE",
            "rate": "string",
            "amountRange": {
              "discountMinimum": "string",
              "discountMaximum": "string"
            }
          },
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string",
          "eligibility": [
            {
              "discountEligibilityType": "BUSINESS",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ]
        }
      ]
    }
  ],
  "depositRates": [
    {
      "depositRateType": "VARIABLE",
      "rate": "string",
      "calculationFrequency": "string",
      "applicationType": "PERIODIC",
      "applicationFrequency": "string",
      "tiers": [
        {
          "name": "string",
          "unitOfMeasure": "DAY",
          "minimumValue": "string",
          "maximumValue": "string",
          "rateApplicationMethod": "PER_TIER",
          "applicabilityConditions": [
            {
              "rateApplicabilityType": "NEW_CUSTOMER",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "lendingRates": [
    {
      "lendingRateType": "FIXED",
      "rate": "string",
      "comparisonRate": "string",
      "calculationFrequency": "string",
      "applicationType": "PERIODIC",
      "applicationFrequency": "string",
      "interestPaymentDue": "IN_ADVANCE",
      "repaymentType": "INTEREST_ONLY",
      "loanPurpose": "INVESTMENT",
      "tiers": [
        {
          "name": "string",
          "unitOfMeasure": "DAY",
          "minimumValue": "string",
          "maximumValue": "string",
          "rateApplicationMethod": "PER_TIER",
          "applicabilityConditions": [
            {
              "rateApplicabilityType": "NEW_CUSTOMER",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ]
}

Properties

allOf

Name Type Required Default Description
anonymous BankingProductV5 mandatory none

and

Name Type Required Default Description
anonymous object mandatory none
» 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 productID values 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.
» constraints [BankingProductConstraintV3] optional Constraints on the application for the product such as minimum balances or limit thresholds.
» eligibility [BankingProductEligibilityV2] optional Eligibility criteria for the product.
» fees [BankingProductFeeV2] optional Fees applicable to the product.
» depositRates [BankingProductDepositRateV2] optional Interest rates available for deposits.
» lendingRates [BankingProductLendingRateV3] optional Interest rates charged against lending balances.

BankingProductBundle

{
  "name": "string",
  "description": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string",
  "productIds": [
    "string"
  ]
}

Properties

Name Type Required Default Description
name string mandatory Name of the bundle.
description string mandatory Description of the bundle.
additionalInfo string optional 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.
productIds [BankingProductId] optional Array of productID values 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.

BankingProductFeatureV3

{
  "featureType": "ADDITIONAL_CARDS",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
featureType Enum mandatory 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.
additionalInfo string conditional Display text providing more information on the feature. Mandatory if featureType is set to OTHER.
additionalInfoUri URIString optional Link to a web page with more information on this feature.

Enumerated Values

Property Value
featureType ADDITIONAL_CARDS
featureType BALANCE_TRANSFERS
featureType BILL_PAYMENT
featureType BONUS_REWARDS
featureType CARD_ACCESS
featureType CASHBACK_OFFER
featureType COMPLEMENTARY_PRODUCT_DISCOUNTS
featureType DIGITAL_BANKING
featureType DIGITAL_WALLET
featureType DONATE_INTEREST
featureType EXTRA_REPAYMENTS
featureType FRAUD_PROTECTION
featureType FREE_TXNS
featureType FREE_TXNS_ALLOWANCE
featureType FUNDS_AVAILABLE_AFTER
featureType GUARANTOR
featureType INSTALMENT_PLAN
featureType INSURANCE
featureType INTEREST_FREE
featureType INTEREST_FREE_TRANSFERS
featureType LOYALTY_PROGRAM
featureType NOTIFICATIONS
featureType NPP_ENABLED
featureType NPP_PAYID
featureType OFFSET
featureType OTHER
featureType OVERDRAFT
featureType REDRAW
featureType RELATIONSHIP_MANAGEMENT
featureType UNLIMITED_TXNS

BankingProductConstraintV3

{
  "constraintType": "MAX_BALANCE",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
constraintType Enum mandatory 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.
additionalInfo string conditional Display text providing more information on the constraint. Mandatory if the constraintType value is OTHER.
additionalInfoUri URIString optional Link to a web page with more information on the constraint.

Enumerated Values

Property Value
constraintType MAX_BALANCE
constraintType MAX_LIMIT
constraintType MAX_LVR
constraintType MIN_BALANCE
constraintType MIN_LIMIT
constraintType MIN_LVR
constraintType OPENING_BALANCE
constraintType OTHER

BankingProductEligibilityV2

{
  "eligibilityType": "BUSINESS",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
eligibilityType Enum mandatory 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.
additionalInfo string conditional 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.

Enumerated Values

Property Value
eligibilityType BUSINESS
eligibilityType EMPLOYMENT_STATUS
eligibilityType MAX_AGE
eligibilityType MIN_AGE
eligibilityType MIN_INCOME
eligibilityType MIN_TURNOVER
eligibilityType NATURAL_PERSON
eligibilityType OTHER
eligibilityType PENSION_RECIPIENT
eligibilityType RESIDENCY_STATUS
eligibilityType STAFF
eligibilityType STUDENT

BankingProductFeeV2

{
  "name": "string",
  "feeType": "CASH_ADVANCE",
  "feeMethodUType": "fixedAmount",
  "fixedAmount": {
    "amount": "string"
  },
  "rateBased": {
    "rateType": "BALANCE",
    "rate": "string",
    "accrualFrequency": "string",
    "amountRange": {
      "feeMinimum": "string",
      "feeMaximum": "string"
    }
  },
  "variable": {
    "feeMinimum": "string",
    "feeMaximum": "string"
  },
  "feeCap": "string",
  "feeCapPeriod": "string",
  "currency": "AUD",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string",
  "discounts": [
    {
      "description": "string",
      "discountType": "BALANCE",
      "discountMethodUType": "fixedAmount",
      "fixedAmount": {
        "amount": "string"
      },
      "rateBased": {
        "rateType": "BALANCE",
        "rate": "string",
        "amountRange": {
          "discountMinimum": "string",
          "discountMaximum": "string"
        }
      },
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "eligibility": [
        {
          "discountEligibilityType": "BUSINESS",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Default Description
name string mandatory Name of the fee.
feeType Enum mandatory The type of fee. For further details, refer to Product Fee Types.
feeMethodUType Enum mandatory Reference to the applicable fee charging method structure.
fixedAmount BankingFeeAmount conditional Mandatory if the feeMethodUType value is fixedAmount. Where the fee is a specific amount.
rateBased BankingFeeRate conditional Mandatory if the feeMethodUType value is rateBased. Where the fee is based on a type of rate.
variable BankingFeeRange conditional Mandatory if the feeMethodUType value is 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.
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).
currency CurrencyString optional AUD 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.
additionalInfo string conditional Display text providing more information on the fee. Mandatory if the feeType value is OTHER.
additionalInfoUri URIString optional Link to a web page with more information on this fee.
discounts [BankingProductDiscountV2] optional An optional list of discounts to this fee that may be available.

Enumerated Values

Property Value
feeType CASH_ADVANCE
feeType DEPOSIT
feeType DISHONOUR
feeType ENQUIRY
feeType EVENT
feeType EXIT
feeType LATE_PAYMENT
feeType OTHER
feeType PAYMENT
feeType PERIODIC
feeType PURCHASE
feeType REPLACEMENT
feeType TRANSACTION
feeType UPFRONT
feeType UPFRONT_PER_PLAN
feeType VARIATION
feeType WITHDRAWAL
feeMethodUType fixedAmount
feeMethodUType rateBased
feeMethodUType variable

BankingFeeAmount

{
  "amount": "string"
}

Properties

Name Type Required Default Description
amount AmountString mandatory The specific amount charged for the fee each time it is incurred.

BankingFeeRate

{
  "rateType": "BALANCE",
  "rate": "string",
  "accrualFrequency": "string",
  "amountRange": {
    "feeMinimum": "string",
    "feeMaximum": "string"
  }
}

Properties

Name Type Required Default Description
rateType Enum mandatory Type of fee rate calculation.
  • BALANCE A fee rate based on a balance
  • INTEREST_ACCRUED A fee rate based on interest accrued
  • TRANSACTION A fee rate based on a transaction.
rate RateString mandatory The fee rate calculated according to the rateType.
accrualFrequency ExternalRef optional The indicative frequency with which the fee is calculated on the account if applicable. 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.

Enumerated Values

Property Value
rateType BALANCE
rateType INTEREST_ACCRUED
rateType TRANSACTION

BankingFeeRange

{
  "feeMinimum": "string",
  "feeMaximum": "string"
}

A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.

Properties

Name Type Required Default Description
feeMinimum AmountString optional The minimum fee that will be charged per occurrence.
feeMaximum AmountString optional The maximum fee that will be charged per occurrence.

BankingProductDiscountV2

{
  "description": "string",
  "discountType": "BALANCE",
  "discountMethodUType": "fixedAmount",
  "fixedAmount": {
    "amount": "string"
  },
  "rateBased": {
    "rateType": "BALANCE",
    "rate": "string",
    "amountRange": {
      "discountMinimum": "string",
      "discountMaximum": "string"
    }
  },
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string",
  "eligibility": [
    {
      "discountEligibilityType": "BUSINESS",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ]
}

Note that the currency of the fee discount is expected to be the same as the currency of the fee itself.

Properties

Name Type Required Default Description
description string mandatory Description of the discount.
discountType Enum mandatory The type of discount. For further details, refer to Product Discount Types.
discountMethodUType Enum mandatory Reference to the applicable fee discount method structure.
fixedAmount BankingFeeDiscountAmount conditional Mandatory if the discountMethodUType value is fixedAmount. Where the discount is a specific amount.
rateBased BankingFeeDiscountRate conditional Mandatory if the discountMethodUType value is rateBased. Where the discount is based on a type of rate. 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.
additionalInfo string optional Display text providing more information on the discount.
additionalInfoUri URIString optional 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.

Enumerated Values

Property Value
discountType BALANCE
discountType DEPOSITS
discountType ELIGIBILITY_ONLY
discountType FEE_CAP
discountType PAYMENTS
discountMethodUType fixedAmount
discountMethodUType rateBased

BankingFeeDiscountAmount

{
  "amount": "string"
}

Properties

Name Type Required Default Description
amount AmountString mandatory The specific amount discounted from the fee each time it is incurred.

BankingFeeDiscountRate

{
  "rateType": "BALANCE",
  "rate": "string",
  "amountRange": {
    "discountMinimum": "string",
    "discountMaximum": "string"
  }
}

Properties

Name Type Required Default Description
rateType Enum mandatory Type of fee rate discount calculation.
  • BALANCE A fee rate discount based on a balance
  • FEE A fee rate discount based on the fee to which the discount is attached
  • INTEREST_ACCRUED A fee rate discount based on interest accrued
  • TRANSACTION A fee rate discount based on a transaction.
rate RateString mandatory The fee rate discount calculated according to the rateType.
amountRange BankingFeeDiscountRange optional A minimum or maximum fee discount amount where a specific fixed amount is not known until the fee is incurred.

Enumerated Values

Property Value
rateType BALANCE
rateType FEE
rateType INTEREST_ACCRUED
rateType TRANSACTION

BankingFeeDiscountRange

{
  "discountMinimum": "string",
  "discountMaximum": "string"
}

A minimum or maximum fee discount amount where a specific fixed amount is not known until the fee is incurred.

Properties

Name Type Required Default Description
discountMinimum AmountString optional The minimum fee discount that will be applied per occurrence.
discountMaximum AmountString optional The maximum fee discount that will be applied per occurrence.

BankingProductDiscountEligibility

{
  "discountEligibilityType": "BUSINESS",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
discountEligibilityType Enum mandatory 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.
additionalInfo string conditional 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.

Enumerated Values

Property Value
discountEligibilityType BUSINESS
discountEligibilityType EMPLOYMENT_STATUS
discountEligibilityType INTRODUCTORY
discountEligibilityType MAX_AGE
discountEligibilityType MIN_AGE
discountEligibilityType MIN_INCOME
discountEligibilityType MIN_TURNOVER
discountEligibilityType NATURAL_PERSON
discountEligibilityType OTHER
discountEligibilityType PENSION_RECIPIENT
discountEligibilityType RESIDENCY_STATUS
discountEligibilityType STAFF
discountEligibilityType STUDENT

BankingProductDepositRateV2

{
  "depositRateType": "VARIABLE",
  "rate": "string",
  "calculationFrequency": "string",
  "applicationType": "PERIODIC",
  "applicationFrequency": "string",
  "tiers": [
    {
      "name": "string",
      "unitOfMeasure": "DAY",
      "minimumValue": "string",
      "maximumValue": "string",
      "rateApplicationMethod": "PER_TIER",
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "applicabilityConditions": [
    {
      "rateApplicabilityType": "NEW_CUSTOMER",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
depositRateType Enum mandatory 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.
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).
applicationType Enum mandatory The type of approach used to apply the rate to the account.
applicationFrequency ExternalRef conditional 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). Mandatory if the applicationType value is PERIODIC.
tiers [BankingProductRateTierV4] optional Rate tiers applicable for this rate.
applicabilityConditions [BankingProductRateConditionV2] optional Applicability conditions for the 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.
additionalInfo string optional Display text providing more information on the rate.
additionalInfoUri URIString optional Link to a web page with more information on this rate.

Enumerated Values

Property Value
depositRateType BONUS
depositRateType BUNDLE_BONUS
depositRateType FIXED
depositRateType FLOATING
depositRateType INTRODUCTORY
depositRateType MARKET_LINKED
depositRateType VARIABLE
applicationType MATURITY
applicationType PERIODIC
applicationType UPFRONT

BankingProductLendingRateV3

{
  "lendingRateType": "FIXED",
  "rate": "string",
  "comparisonRate": "string",
  "calculationFrequency": "string",
  "applicationType": "PERIODIC",
  "applicationFrequency": "string",
  "interestPaymentDue": "IN_ADVANCE",
  "repaymentType": "INTEREST_ONLY",
  "loanPurpose": "INVESTMENT",
  "tiers": [
    {
      "name": "string",
      "unitOfMeasure": "DAY",
      "minimumValue": "string",
      "maximumValue": "string",
      "rateApplicationMethod": "PER_TIER",
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "applicabilityConditions": [
    {
      "rateApplicabilityType": "NEW_CUSTOMER",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Properties

Name Type Required Default Description
lendingRateType Enum mandatory The type of rate (FIXED, VARIABLE, etc.) For further details, refer to Product Lending Rate Types.
rate RateString mandatory The rate to be applied.
comparisonRate RateString optional 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).
applicationType Enum mandatory The type of approach used to apply the rate to the account.
applicationFrequency ExternalRef conditional 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). Mandatory if the applicationType value is PERIODIC.
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.
repaymentType Enum mandatory Option in place for repayments.
loanPurpose Enum mandatory The reason for taking out the loan.
tiers [BankingProductRateTierV4] optional Rate tiers applicable for this rate.
applicabilityConditions [BankingProductRateConditionV2] optional Applicability conditions for the 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.
additionalInfo string optional Display text providing more information on the rate.
additionalInfoUri URIString optional Link to a web page with more information on this rate.

Enumerated Values

Property Value
lendingRateType BALANCE_TRANSFER
lendingRateType BUNDLE_DISCOUNT_FIXED
lendingRateType BUNDLE_DISCOUNT_VARIABLE
lendingRateType CASH_ADVANCE
lendingRateType DISCOUNT
lendingRateType FIXED
lendingRateType FLOATING
lendingRateType INTRODUCTORY
lendingRateType MARKET_LINKED
lendingRateType PENALTY
lendingRateType PURCHASE
lendingRateType VARIABLE
applicationType MATURITY
applicationType PERIODIC
applicationType UPFRONT
interestPaymentDue IN_ADVANCE
interestPaymentDue IN_ARREARS
repaymentType INTEREST_ONLY
repaymentType OTHER
repaymentType PRINCIPAL_AND_INTEREST
repaymentType UNCONSTRAINED
loanPurpose INVESTMENT
loanPurpose OTHER
loanPurpose OWNER_OCCUPIED
loanPurpose UNCONSTRAINED

BankingProductRateTierV4

{
  "name": "string",
  "unitOfMeasure": "DAY",
  "minimumValue": "string",
  "maximumValue": "string",
  "rateApplicationMethod": "PER_TIER",
  "applicabilityConditions": [
    {
      "rateApplicabilityType": "NEW_CUSTOMER",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Defines the criteria and conditions for which a rate applies.

Properties

Name Type Required Default Description
name string mandatory 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).
minimumValue string mandatory 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.
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').
applicabilityConditions [BankingProductRateConditionV2] optional Applicability conditions for the rate tier.
additionalInfo string optional Display text providing more information on the rate tier.
additionalInfoUri URIString optional Link to a web page with more information on this rate tier.

Enumerated Values

Property Value
unitOfMeasure DAY
unitOfMeasure DOLLAR
unitOfMeasure MONTH
unitOfMeasure PERCENT
rateApplicationMethod PER_TIER
rateApplicationMethod WHOLE_BALANCE

BankingProductRateConditionV2

{
  "rateApplicabilityType": "NEW_CUSTOMER",
  "additionalValue": "string",
  "additionalInfo": "string",
  "additionalInfoUri": "string"
}

Defines a condition for the applicability of a rate.

Properties

Name Type Required Default Description
rateApplicabilityType Enum mandatory 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.
additionalInfo string conditional Display text providing more information on the condition. Mandatory if the rateApplicabilityType value is OTHER.
additionalInfoUri URIString optional Link to a web page with more information on this condition.

Enumerated Values

Property Value
rateApplicabilityType MIN_DEPOSITS
rateApplicabilityType MIN_DEPOSIT_AMOUNT
rateApplicabilityType DEPOSIT_BALANCE_INCREASED
rateApplicabilityType EXISTING_CUST
rateApplicabilityType NEW_ACCOUNTS
rateApplicabilityType NEW_CUSTOMER
rateApplicabilityType NEW_CUSTOMER_TO_GROUP
rateApplicabilityType ONLINE_ONLY
rateApplicabilityType OTHER
rateApplicabilityType MIN_PURCHASES
rateApplicabilityType MAX_WITHDRAWALS
rateApplicabilityType MAX_WITHDRAWAL_AMOUNT

ResponseBankingAccountListV2

{
  "data": {
    "accounts": [
      {
        "accountId": "string",
        "creationDate": "string",
        "displayName": "string",
        "nickname": "string",
        "openStatus": "CLOSED",
        "isOwned": true,
        "accountOwnership": "UNKNOWN",
        "maskedNumber": "string",
        "productCategory": "BUSINESS_LOANS",
        "productName": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» accounts [BankingAccountV2] mandatory The list of accounts returned. If the filter results in an empty set then this array may have no records.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

BankingAccountV2

{
  "accountId": "string",
  "creationDate": "string",
  "displayName": "string",
  "nickname": "string",
  "openStatus": "CLOSED",
  "isOwned": true,
  "accountOwnership": "UNKNOWN",
  "maskedNumber": "string",
  "productCategory": "BUSINESS_LOANS",
  "productName": "string"
}

Properties

Name Type Required Default Description
accountId BankingAccountId mandatory Unique identifier for the account.
creationDate DateString optional 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.
nickname string optional A customer supplied nickname for the account.
openStatus Enum optional OPEN Open or closed status for the account. If not present then OPEN is assumed.
isOwned Boolean optional true 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.
maskedNumber MaskedAccountString mandatory A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number.
productCategory BankingProductCategory mandatory 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).

Enumerated Values

Property Value
openStatus CLOSED
openStatus OPEN
accountOwnership UNKNOWN
accountOwnership ONE_PARTY
accountOwnership TWO_PARTY
accountOwnership MANY_PARTY
accountOwnership OTHER

ResponseBankingAccountByIdV4

{
  "data": {
    "accountId": "string",
    "creationDate": "string",
    "displayName": "string",
    "nickname": "string",
    "openStatus": "CLOSED",
    "isOwned": true,
    "accountOwnership": "UNKNOWN",
    "maskedNumber": "string",
    "productCategory": "BUSINESS_LOANS",
    "productName": "string",
    "bsb": "string",
    "accountNumber": "string",
    "bundleName": "string",
    "specificAccountUType": "creditCard",
    "termDeposit": [
      {
        "lodgementDate": "string",
        "maturityDate": "string",
        "maturityAmount": "string",
        "maturityCurrency": "AUD",
        "maturityInstructions": "HOLD_ON_MATURITY"
      }
    ],
    "creditCard": {
      "minPaymentAmount": "string",
      "paymentDueAmount": "string",
      "paymentCurrency": "AUD",
      "paymentDueDate": "string"
    },
    "loan": {
      "originalStartDate": "string",
      "originalLoanAmount": "string",
      "originalLoanCurrency": "AUD",
      "loanEndDate": "string",
      "nextInstalmentDate": "string",
      "minInstalmentAmount": "string",
      "minInstalmentCurrency": "AUD",
      "maxRedraw": "string",
      "maxRedrawCurrency": "AUD",
      "minRedraw": "string",
      "minRedrawCurrency": "AUD",
      "offsetAccountEnabled": true,
      "offsetAccountIds": [
        "string"
      ],
      "repaymentType": "INTEREST_ONLY",
      "repaymentFrequency": "string"
    },
    "depositRate": "string",
    "lendingRate": "string",
    "depositRates": [
      {
        "depositRateType": "VARIABLE",
        "rate": "string",
        "calculationFrequency": "string",
        "applicationType": "PERIODIC",
        "applicationFrequency": "string",
        "tiers": [
          {
            "name": "string",
            "unitOfMeasure": "DAY",
            "minimumValue": "string",
            "maximumValue": "string",
            "rateApplicationMethod": "PER_TIER",
            "applicabilityConditions": [
              {
                "rateApplicabilityType": "NEW_CUSTOMER",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "applicabilityConditions": [
          {
            "rateApplicabilityType": "NEW_CUSTOMER",
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "lendingRates": [
      {
        "lendingRateType": "FIXED",
        "rate": "string",
        "comparisonRate": "string",
        "calculationFrequency": "string",
        "applicationType": "PERIODIC",
        "applicationFrequency": "string",
        "interestPaymentDue": "IN_ADVANCE",
        "repaymentType": "INTEREST_ONLY",
        "loanPurpose": "INVESTMENT",
        "tiers": [
          {
            "name": "string",
            "unitOfMeasure": "DAY",
            "minimumValue": "string",
            "maximumValue": "string",
            "rateApplicationMethod": "PER_TIER",
            "applicabilityConditions": [
              {
                "rateApplicabilityType": "NEW_CUSTOMER",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "applicabilityConditions": [
          {
            "rateApplicabilityType": "NEW_CUSTOMER",
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string"
      }
    ],
    "features": [
      {
        "featureType": "ADDITIONAL_CARDS",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "isActivated": "ACTIVATED"
      }
    ],
    "fees": [
      {
        "name": "string",
        "feeType": "CASH_ADVANCE",
        "feeMethodUType": "fixedAmount",
        "fixedAmount": {
          "amount": "string"
        },
        "rateBased": {
          "rateType": "BALANCE",
          "rate": "string",
          "accrualFrequency": "string",
          "amountRange": {
            "feeMinimum": "string",
            "feeMaximum": "string"
          }
        },
        "variable": {
          "feeMinimum": "string",
          "feeMaximum": "string"
        },
        "feeCap": "string",
        "feeCapPeriod": "string",
        "currency": "AUD",
        "additionalValue": "string",
        "additionalInfo": "string",
        "additionalInfoUri": "string",
        "discounts": [
          {
            "description": "string",
            "discountType": "BALANCE",
            "discountMethodUType": "fixedAmount",
            "fixedAmount": {
              "amount": "string"
            },
            "rateBased": {
              "rateType": "BALANCE",
              "rate": "string",
              "amountRange": {
                "discountMinimum": "string",
                "discountMaximum": "string"
              }
            },
            "additionalValue": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string",
            "eligibility": [
              {
                "discountEligibilityType": "BUSINESS",
                "additionalValue": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ]
          }
        ]
      }
    ],
    "addresses": [
      {
        "addressUType": "paf",
        "simple": {
          "mailingName": "string",
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "postcode": "string",
          "city": "string",
          "state": "string",
          "country": "AUS"
        },
        "paf": {
          "dpid": "string",
          "thoroughfareNumber1": 0,
          "thoroughfareNumber1Suffix": "string",
          "thoroughfareNumber2": 0,
          "thoroughfareNumber2Suffix": "string",
          "flatUnitType": "string",
          "flatUnitNumber": "string",
          "floorLevelType": "string",
          "floorLevelNumber": "string",
          "lotNumber": "string",
          "buildingName1": "string",
          "buildingName2": "string",
          "streetName": "string",
          "streetType": "string",
          "streetSuffix": "string",
          "postalDeliveryType": "string",
          "postalDeliveryNumber": 0,
          "postalDeliveryNumberPrefix": "string",
          "postalDeliveryNumberSuffix": "string",
          "localityName": "string",
          "postcode": "string",
          "state": "string"
        }
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data BankingAccountDetailV4 mandatory none
links Links mandatory none
meta Meta optional none

BankingAccountDetailV4

{
  "accountId": "string",
  "creationDate": "string",
  "displayName": "string",
  "nickname": "string",
  "openStatus": "CLOSED",
  "isOwned": true,
  "accountOwnership": "UNKNOWN",
  "maskedNumber": "string",
  "productCategory": "BUSINESS_LOANS",
  "productName": "string",
  "bsb": "string",
  "accountNumber": "string",
  "bundleName": "string",
  "specificAccountUType": "creditCard",
  "termDeposit": [
    {
      "lodgementDate": "string",
      "maturityDate": "string",
      "maturityAmount": "string",
      "maturityCurrency": "AUD",
      "maturityInstructions": "HOLD_ON_MATURITY"
    }
  ],
  "creditCard": {
    "minPaymentAmount": "string",
    "paymentDueAmount": "string",
    "paymentCurrency": "AUD",
    "paymentDueDate": "string"
  },
  "loan": {
    "originalStartDate": "string",
    "originalLoanAmount": "string",
    "originalLoanCurrency": "AUD",
    "loanEndDate": "string",
    "nextInstalmentDate": "string",
    "minInstalmentAmount": "string",
    "minInstalmentCurrency": "AUD",
    "maxRedraw": "string",
    "maxRedrawCurrency": "AUD",
    "minRedraw": "string",
    "minRedrawCurrency": "AUD",
    "offsetAccountEnabled": true,
    "offsetAccountIds": [
      "string"
    ],
    "repaymentType": "INTEREST_ONLY",
    "repaymentFrequency": "string"
  },
  "depositRate": "string",
  "lendingRate": "string",
  "depositRates": [
    {
      "depositRateType": "VARIABLE",
      "rate": "string",
      "calculationFrequency": "string",
      "applicationType": "PERIODIC",
      "applicationFrequency": "string",
      "tiers": [
        {
          "name": "string",
          "unitOfMeasure": "DAY",
          "minimumValue": "string",
          "maximumValue": "string",
          "rateApplicationMethod": "PER_TIER",
          "applicabilityConditions": [
            {
              "rateApplicabilityType": "NEW_CUSTOMER",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "lendingRates": [
    {
      "lendingRateType": "FIXED",
      "rate": "string",
      "comparisonRate": "string",
      "calculationFrequency": "string",
      "applicationType": "PERIODIC",
      "applicationFrequency": "string",
      "interestPaymentDue": "IN_ADVANCE",
      "repaymentType": "INTEREST_ONLY",
      "loanPurpose": "INVESTMENT",
      "tiers": [
        {
          "name": "string",
          "unitOfMeasure": "DAY",
          "minimumValue": "string",
          "maximumValue": "string",
          "rateApplicationMethod": "PER_TIER",
          "applicabilityConditions": [
            {
              "rateApplicabilityType": "NEW_CUSTOMER",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "applicabilityConditions": [
        {
          "rateApplicabilityType": "NEW_CUSTOMER",
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string"
        }
      ],
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string"
    }
  ],
  "features": [
    {
      "featureType": "ADDITIONAL_CARDS",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "isActivated": "ACTIVATED"
    }
  ],
  "fees": [
    {
      "name": "string",
      "feeType": "CASH_ADVANCE",
      "feeMethodUType": "fixedAmount",
      "fixedAmount": {
        "amount": "string"
      },
      "rateBased": {
        "rateType": "BALANCE",
        "rate": "string",
        "accrualFrequency": "string",
        "amountRange": {
          "feeMinimum": "string",
          "feeMaximum": "string"
        }
      },
      "variable": {
        "feeMinimum": "string",
        "feeMaximum": "string"
      },
      "feeCap": "string",
      "feeCapPeriod": "string",
      "currency": "AUD",
      "additionalValue": "string",
      "additionalInfo": "string",
      "additionalInfoUri": "string",
      "discounts": [
        {
          "description": "string",
          "discountType": "BALANCE",
          "discountMethodUType": "fixedAmount",
          "fixedAmount": {
            "amount": "string"
          },
          "rateBased": {
            "rateType": "BALANCE",
            "rate": "string",
            "amountRange": {
              "discountMinimum": "string",
              "discountMaximum": "string"
            }
          },
          "additionalValue": "string",
          "additionalInfo": "string",
          "additionalInfoUri": "string",
          "eligibility": [
            {
              "discountEligibilityType": "BUSINESS",
              "additionalValue": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ]
        }
      ]
    }
  ],
  "addresses": [
    {
      "addressUType": "paf",
      "simple": {
        "mailingName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "postcode": "string",
        "city": "string",
        "state": "string",
        "country": "AUS"
      },
      "paf": {
        "dpid": "string",
        "thoroughfareNumber1": 0,
        "thoroughfareNumber1Suffix": "string",
        "thoroughfareNumber2": 0,
        "thoroughfareNumber2Suffix": "string",
        "flatUnitType": "string",
        "flatUnitNumber": "string",
        "floorLevelType": "string",
        "floorLevelNumber": "string",
        "lotNumber": "string",
        "buildingName1": "string",
        "buildingName2": "string",
        "streetName": "string",
        "streetType": "string",
        "streetSuffix": "string",
        "postalDeliveryType": "string",
        "postalDeliveryNumber": 0,
        "postalDeliveryNumberPrefix": "string",
        "postalDeliveryNumberSuffix": "string",
        "localityName": "string",
        "postcode": "string",
        "state": "string"
      }
    }
  ]
}

Properties

allOf

Name Type Required Default Description
anonymous BankingAccountV2 mandatory none

and

Name Type Required Default Description
anonymous object mandatory none
» 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.
» 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.
» bundleName string optional Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.
» specificAccountUType Enum optional The type of structure to present account specific fields.
» termDeposit [BankingTermDepositAccount] conditional Mandatory if the specificAccountUType value is termDeposit.
» creditCard BankingCreditCardAccount conditional Mandatory if the specificAccountUType value is creditCard.
» loan BankingLoanAccountV3 conditional Mandatory if the specificAccountUType value is loan.
» depositRate RateString optional 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.
» depositRates [BankingProductDepositRateV2] optional Fully described deposit rates for this account based on the equivalent structure in Product Reference.
» lendingRates [BankingProductLendingRateV3] optional 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.

allOf

Name Type Required Default Description
»» anonymous BankingProductFeatureV3 mandatory none

and

Name Type Required Default Description
»» anonymous object mandatory none
»»» isActivated Enum optional UNKNOWN
  • ACTIVATED if the feature has been activated by the customer or is a standard feature of the product
  • NOT_ACTIVATED if the feature is not activated but is available for activation
  • UNKNOWN or absent if the activation state is unknown.
Note: This is an additional field appended to the feature structure defined in the Product Reference payload.

continued

Name Type Required Default Description
» fees [BankingProductFeeV2] optional 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.

Enumerated Values

Property Value
specificAccountUType creditCard
specificAccountUType loan
specificAccountUType termDeposit
isActivated ACTIVATED
isActivated NOT_ACTIVATED
isActivated UNKNOWN

BankingTermDepositAccount

{
  "lodgementDate": "string",
  "maturityDate": "string",
  "maturityAmount": "string",
  "maturityCurrency": "AUD",
  "maturityInstructions": "HOLD_ON_MATURITY"
}

Properties

Name Type Required Default Description
lodgementDate DateString mandatory The lodgement date of the original deposit.
maturityDate DateString mandatory 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.
maturityCurrency CurrencyString optional 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.

Enumerated Values

Property Value
maturityInstructions HOLD_ON_MATURITY
maturityInstructions PAID_OUT_AT_MATURITY
maturityInstructions ROLLED_OVER

BankingCreditCardAccount

{
  "minPaymentAmount": "string",
  "paymentDueAmount": "string",
  "paymentCurrency": "AUD",
  "paymentDueDate": "string"
}

Properties

Name Type Required Default Description
minPaymentAmount AmountString mandatory The minimum payment amount due for the next card payment.
paymentDueAmount AmountString mandatory The amount due for the next card payment.
paymentCurrency CurrencyString optional AUD If absent assumes AUD.
paymentDueDate DateString mandatory Date that the next payment for the card is due.

BankingLoanAccountV3

{
  "originalStartDate": "string",
  "originalLoanAmount": "string",
  "originalLoanCurrency": "AUD",
  "loanEndDate": "string",
  "nextInstalmentDate": "string",
  "minInstalmentAmount": "string",
  "minInstalmentCurrency": "AUD",
  "maxRedraw": "string",
  "maxRedrawCurrency": "AUD",
  "minRedraw": "string",
  "minRedrawCurrency": "AUD",
  "offsetAccountEnabled": true,
  "offsetAccountIds": [
    "string"
  ],
  "repaymentType": "INTEREST_ONLY",
  "repaymentFrequency": "string"
}

Properties

Name Type Required Default Description
originalStartDate DateString optional Optional original start date for the loan.
originalLoanAmount AmountString optional Optional original loan value.
originalLoanCurrency CurrencyString optional AUD If absent assumes AUD.
loanEndDate DateString optional Date that the loan is due to be repaid in full.
nextInstalmentDate DateString optional Next date that an instalment is required.
minInstalmentAmount AmountString optional Minimum amount of next instalment.
minInstalmentCurrency CurrencyString optional 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.
maxRedrawCurrency CurrencyString optional AUD If absent assumes AUD.
minRedraw AmountString optional Minimum redraw amount.
minRedrawCurrency CurrencyString optional AUD If absent assumes AUD.
offsetAccountEnabled Boolean optional Set to true if one or more offset accounts are configured for this loan account.
offsetAccountIds [BankingAccountId] optional The accountId values 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 mandatory Option in place for repayments.
repaymentFrequency ExternalRef optional The expected or required repayment frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax).

Enumerated Values

Property Value
repaymentType INTEREST_ONLY
repaymentType OTHER
repaymentType PRINCIPAL_AND_INTEREST
repaymentType UNCONSTRAINED

ResponseBankingTransactionList

{
  "data": {
    "transactions": [
      {
        "accountId": "string",
        "transactionId": "string",
        "isDetailAvailable": true,
        "type": "DIRECT_DEBIT",
        "status": "PENDING",
        "description": "string",
        "postingDateTime": "string",
        "valueDateTime": "string",
        "executionDateTime": "string",
        "amount": "string",
        "currency": "AUD",
        "reference": "string",
        "merchantName": "string",
        "merchantCategoryCode": "string",
        "billerCode": "string",
        "billerName": "string",
        "crn": "string",
        "apcaNumber": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0,
    "isQueryParamUnsupported": false
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» transactions [BankingTransaction] mandatory none
links LinksPaginated mandatory none
meta MetaPaginatedTransaction mandatory none

BankingTransaction

{
  "accountId": "string",
  "transactionId": "string",
  "isDetailAvailable": true,
  "type": "DIRECT_DEBIT",
  "status": "PENDING",
  "description": "string",
  "postingDateTime": "string",
  "valueDateTime": "string",
  "executionDateTime": "string",
  "amount": "string",
  "currency": "AUD",
  "reference": "string",
  "merchantName": "string",
  "merchantCategoryCode": "string",
  "billerCode": "string",
  "billerName": "string",
  "crn": "string",
  "apcaNumber": "string"
}

Properties

Name Type Required Default Description
accountId BankingAccountId mandatory Unique identifier for the account.
transactionId BankingTransactionId conditional Unique identifier for the transaction. 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. Mandatory if the isDetailAvailable value is true.
isDetailAvailable Boolean mandatory 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.
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.
description string mandatory 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.
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.
executionDateTime DateTimeString optional 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.
currency CurrencyString optional AUD 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.
merchantName string optional 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.
billerCode string optional BPAY Biller Code for the transaction (if available).
billerName string optional Name of the BPAY biller for the transaction (if available).
crn string conditional BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
apcaNumber string optional 6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable.

Enumerated Values

Property Value
type DIRECT_DEBIT
type FEE
type INTEREST_CHARGED
type INTEREST_PAID
type OTHER
type PAYMENT
type TRANSFER_INCOMING
type TRANSFER_OUTGOING
status PENDING
status POSTED

ResponseBankingTransactionByIdV2

{
  "data": {
    "accountId": "string",
    "transactionId": "string",
    "isDetailAvailable": true,
    "type": "DIRECT_DEBIT",
    "status": "PENDING",
    "description": "string",
    "postingDateTime": "string",
    "valueDateTime": "string",
    "executionDateTime": "string",
    "amount": "string",
    "currency": "AUD",
    "reference": "string",
    "merchantName": "string",
    "merchantCategoryCode": "string",
    "billerCode": "string",
    "billerName": "string",
    "crn": "string",
    "apcaNumber": "string",
    "extendedData": {
      "payer": "string",
      "payee": "string",
      "extensionUType": "nppPayload",
      "nppPayload": {
        "extendedDescription": "string",
        "endToEndId": "string",
        "purposeCode": "string",
        "service": "X2P1",
        "serviceVersion": "03"
      }
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data BankingTransactionDetailV2 mandatory none
links Links mandatory none
meta Meta optional none

BankingTransactionDetailV2

{
  "accountId": "string",
  "transactionId": "string",
  "isDetailAvailable": true,
  "type": "DIRECT_DEBIT",
  "status": "PENDING",
  "description": "string",
  "postingDateTime": "string",
  "valueDateTime": "string",
  "executionDateTime": "string",
  "amount": "string",
  "currency": "AUD",
  "reference": "string",
  "merchantName": "string",
  "merchantCategoryCode": "string",
  "billerCode": "string",
  "billerName": "string",
  "crn": "string",
  "apcaNumber": "string",
  "extendedData": {
    "payer": "string",
    "payee": "string",
    "extensionUType": "nppPayload",
    "nppPayload": {
      "extendedDescription": "string",
      "endToEndId": "string",
      "purposeCode": "string",
      "service": "X2P1",
      "serviceVersion": "03"
    }
  }
}

Properties

allOf

Name Type Required Default Description
anonymous BankingTransaction mandatory none

and

Name Type Required Default Description
anonymous object mandatory none
» extendedData object mandatory none
»» payer string conditional 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).
»» extensionUType Enum optional Optional extended data specific to transactions. Currently extended data is supported for NPP service overlays.
»» nppPayload object conditional Required if the extensionUType value is nppPayload.
»»» extendedDescription string conditional An extended string description. Required if the extensionUType value is nppPayload.
»»» endToEndId string optional An end to end ID for the payment created at initiation.
»»» purposeCode ExternalRef optional Purpose of the payment. Format is defined by the NPP standards for the NPP overlay services including Osko (X2P1).
»»» service NppPaymentService mandatory Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. See here for more details.
»»» serviceVersion ExternalRef mandatory Two-digit NPP service overlay version with leading zero.

Enumerated Values

Property Value
extensionUType nppPayload

ResponseBankingAccountsBalanceList

{
  "data": {
    "balances": [
      {
        "accountId": "string",
        "currentBalance": "string",
        "availableBalance": "string",
        "creditLimit": "string",
        "amortisedLimit": "string",
        "currency": "AUD",
        "purses": [
          {
            "amount": "string",
            "currency": "string"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» balances [BankingBalance] mandatory The list of balances returned.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

ResponseBankingAccountsBalanceById

{
  "data": {
    "accountId": "string",
    "currentBalance": "string",
    "availableBalance": "string",
    "creditLimit": "string",
    "amortisedLimit": "string",
    "currency": "AUD",
    "purses": [
      {
        "amount": "string",
        "currency": "string"
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data BankingBalance mandatory none
links Links mandatory none
meta Meta optional none

BankingBalance

{
  "accountId": "string",
  "currentBalance": "string",
  "availableBalance": "string",
  "creditLimit": "string",
  "amortisedLimit": "string",
  "currency": "AUD",
  "purses": [
    {
      "amount": "string",
      "currency": "string"
    }
  ]
}

Properties

Name Type Required Default Description
accountId BankingAccountId mandatory Unique identifier for the account.
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.
availableBalance AmountString mandatory 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.
amortisedLimit AmountString optional Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent.
currency CurrencyString optional 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.

BankingBalancePurse

{
  "amount": "string",
  "currency": "string"
}

Properties

Name Type Required Default Description
amount AmountString mandatory The balance available for this additional currency purse.
currency CurrencyString optional The currency for the purse.

ResponseBankingPayeeListV2

{
  "data": {
    "payees": [
      {
        "payeeId": "string",
        "nickname": "string",
        "description": "string",
        "type": "BILLER",
        "creationDate": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» payees [BankingPayeeV2] mandatory The list of payees returned.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

ResponseBankingPayeeByIdV2

{
  "data": {
    "payeeId": "string",
    "nickname": "string",
    "description": "string",
    "type": "BILLER",
    "creationDate": "string",
    "payeeUType": "biller",
    "biller": {
      "billerCode": "string",
      "crn": "string",
      "billerName": "string"
    },
    "domestic": {
      "payeeAccountUType": "account",
      "account": {
        "accountName": "string",
        "bsb": "string",
        "accountNumber": "string"
      },
      "card": {
        "cardNumber": "string"
      },
      "payId": {
        "name": "string",
        "identifier": "string",
        "type": "ABN"
      }
    },
    "digitalWallet": {
      "name": "string",
      "identifier": "string",
      "type": "EMAIL",
      "provider": "PAYPAL_AU"
    },
    "international": {
      "beneficiaryDetails": {
        "name": "string",
        "country": "string",
        "message": "string"
      },
      "bankDetails": {
        "country": "string",
        "accountNumber": "string",
        "bankAddress": {
          "name": "string",
          "address": "string"
        },
        "beneficiaryBankBIC": "string",
        "fedWireNumber": "string",
        "sortCode": "string",
        "chipNumber": "string",
        "routingNumber": "string",
        "legalEntityIdentifier": "string"
      }
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name Type Required Default Description
data BankingPayeeDetailV2 mandatory none
links Links mandatory none
meta Meta optional none

BankingPayeeV2

{
  "payeeId": "string",
  "nickname": "string",
  "description": "string",
  "type": "BILLER",
  "creationDate": "string"
}

Properties

Name Type Required Default Description
payeeId BankingPayeeId mandatory Unique identifier for the payee.
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.
description string optional 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.
creationDate DateString optional The date the payee was created by the customer.

Enumerated Values

Property Value
type BILLER
type DIGITAL_WALLET
type DOMESTIC
type INTERNATIONAL

BankingPayeeDetailV2

{
  "payeeId": "string",
  "nickname": "string",
  "description": "string",
  "type": "BILLER",
  "creationDate": "string",
  "payeeUType": "biller",
  "biller": {
    "billerCode": "string",
    "crn": "string",
    "billerName": "string"
  },
  "domestic": {
    "payeeAccountUType": "account",
    "account": {
      "accountName": "string",
      "bsb": "string",
      "accountNumber": "string"
    },
    "card": {
      "cardNumber": "string"
    },
    "payId": {
      "name": "string",
      "identifier": "string",
      "type": "ABN"
    }
  },
  "digitalWallet": {
    "name": "string",
    "identifier": "string",
    "type": "EMAIL",
    "provider": "PAYPAL_AU"
  },
  "international": {
    "beneficiaryDetails": {
      "name": "string",
      "country": "string",
      "message": "string"
    },
    "bankDetails": {
      "country": "string",
      "accountNumber": "string",
      "bankAddress": {
        "name": "string",
        "address": "string"
      },
      "beneficiaryBankBIC": "string",
      "fedWireNumber": "string",
      "sortCode": "string",
      "chipNumber": "string",
      "routingNumber": "string",
      "legalEntityIdentifier": "string"
    }
  }
}

Properties

allOf

Name Type Required Default Description
anonymous BankingPayeeV2 mandatory none

and

Name Type Required Default Description
anonymous object mandatory none
» payeeUType Enum mandatory Type of object included that describes the payee in detail.
» biller BankingBillerPayee conditional none
» domestic BankingDomesticPayee conditional none
» digitalWallet BankingDigitalWalletPayee conditional none
» international BankingInternationalPayee conditional none

Enumerated Values

Property Value
payeeUType biller
payeeUType digitalWallet
payeeUType domestic
payeeUType international

BankingDomesticPayee

{
  "payeeAccountUType": "account",
  "account": {
    "accountName": "string",
    "bsb": "string",
    "accountNumber": "string"
  },
  "card": {
    "cardNumber": "string"
  },
  "payId": {
    "name": "string",
    "identifier": "string",
    "type": "ABN"
  }
}

Properties

Name Type Required Default Description
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.
account BankingDomesticPayeeAccount conditional none
card BankingDomesticPayeeCard conditional none
payId BankingDomesticPayeePayId conditional none

Enumerated Values

Property Value
payeeAccountUType account
payeeAccountUType card
payeeAccountUType payId

BankingDomesticPayeeAccount

{
  "accountName": "string",
  "bsb": "string",
  "accountNumber": "string"
}

Properties

Name Type Required Default Description
accountName string optional Name of the account to pay to.
bsb string mandatory BSB of the account to pay to.
accountNumber string mandatory Number of the account to pay to.

BankingDomesticPayeeCard

{
  "cardNumber": "string"
}

Properties

Name Type Required Default Description
cardNumber MaskedPANString mandatory Name of the account to pay to.

BankingDomesticPayeePayId

{
  "name": "string",
  "identifier": "string",
  "type": "ABN"
}

Properties

Name Type Required Default Description
name string optional The name assigned to the PayID by the owner of the PayID.
identifier string mandatory The identifier of the PayID (dependent on type).
type Enum mandatory The type of the PayID.

Enumerated Values

Property Value
type ABN
type EMAIL
type ORG_IDENTIFIER
type TELEPHONE

BankingBillerPayee

{
  "billerCode": "string",
  "crn": "string",
  "billerName": "string"
}

Properties

Name Type Required Default Description
billerCode string mandatory BPAY Biller Code of the Biller.
crn string conditional BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type.
billerName string mandatory Name of the Biller.

BankingInternationalPayee

{
  "beneficiaryDetails": {
    "name": "string",
    "country": "string",
    "message": "string"
  },
  "bankDetails": {
    "country": "string",
    "accountNumber": "string",
    "bankAddress": {
      "name": "string",
      "address": "string"
    },
    "beneficiaryBankBIC": "string",
    "fedWireNumber": "string",
    "sortCode": "string",
    "chipNumber": "string",
    "routingNumber": "string",
    "legalEntityIdentifier": "string"
  }
}

Properties

Name Type Required Default Description
beneficiaryDetails object mandatory none
» name string optional Name of the beneficiary.
» country ExternalRef mandatory Country where the beneficiary resides. A valid ISO 3166 Alpha-3 country code.
» message string optional Response message for the payment.
bankDetails object mandatory none
» country ExternalRef mandatory Country of the recipient institution. A valid ISO 3166 Alpha-3 country code.
» accountNumber string mandatory Account Targeted for payment.
» bankAddress object optional none
»» name string mandatory Name of the recipient Bank.
»» address string mandatory Address of the recipient Bank.
» beneficiaryBankBIC ExternalRef optional Swift bank code. Aligns with standard ISO 9362.
» fedWireNumber string optional Number for Fedwire payment (Federal Reserve Wire Network).
» sortCode string optional Sort code used for account identification in some jurisdictions.
» chipNumber string optional Number for the Clearing House Interbank Payments System.
» routingNumber string optional International bank routing number.
» legalEntityIdentifier ExternalRef optional The legal entity identifier (LEI) for the beneficiary. Aligns with ISO 17442.

BankingDigitalWalletPayee

{
  "name": "string",
  "identifier": "string",
  "type": "EMAIL",
  "provider": "PAYPAL_AU"
}

Properties

Name Type Required Default Description
name string mandatory 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).
type Enum mandatory The type of the digital wallet identifier.
provider Enum mandatory The provider of the digital wallet.

Enumerated Values

Property Value
type EMAIL
type CONTACT_NAME
type TELEPHONE
provider PAYPAL_AU
provider OTHER

ResponseBankingDirectDebitAuthorisationList

{
  "data": {
    "directDebitAuthorisations": [
      {
        "accountId": "string",
        "authorisedEntity": {
          "description": "string",
          "financialInstitution": "string",
          "abn": "string",
          "acn": "string",
          "arbn": "string"
        },
        "lastDebitDateTime": "string",
        "lastDebitAmount": "string"
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» directDebitAuthorisations [BankingDirectDebit] mandatory The list of authorisations returned.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

BankingDirectDebit

{
  "accountId": "string",
  "authorisedEntity": {
    "description": "string",
    "financialInstitution": "string",
    "abn": "string",
    "acn": "string",
    "arbn": "string"
  },
  "lastDebitDateTime": "string",
  "lastDebitAmount": "string"
}

Properties

Name Type Required Default Description
accountId BankingAccountId mandatory Unique identifier for the account.
authorisedEntity BankingAuthorisedEntity mandatory none
lastDebitDateTime DateTimeString optional 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.

BankingAuthorisedEntity

{
  "description": "string",
  "financialInstitution": "string",
  "abn": "string",
  "acn": "string",
  "arbn": "string"
}

Properties

Name Type Required Default Description
description string optional 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.
abn string optional Australian Business Number for the authorised entity.
acn string optional Australian Company Number for the authorised entity.
arbn string optional Australian Registered Body Number for the authorised entity.

ResponseBankingScheduledPaymentsListV2

{
  "data": {
    "scheduledPayments": [
      {
        "scheduledPaymentId": "string",
        "nickname": "string",
        "payerReference": "string",
        "payeeReference": "string",
        "status": "ACTIVE",
        "from": {
          "accountId": "string"
        },
        "paymentSet": [
          {
            "to": {
              "toUType": "accountId",
              "accountId": "string",
              "payeeId": "string",
              "nickname": "string",
              "payeeReference": "string",
              "digitalWallet": {
                "name": "string",
                "identifier": "string",
                "type": "EMAIL",
                "provider": "PAYPAL_AU"
              },
              "domestic": {
                "payeeAccountUType": "account",
                "account": {
                  "accountName": "string",
                  "bsb": "string",
                  "accountNumber": "string"
                },
                "card": {
                  "cardNumber": "string"
                },
                "payId": {
                  "name": "string",
                  "identifier": "string",
                  "type": "ABN"
                }
              },
              "biller": {
                "billerCode": "string",
                "crn": "string",
                "billerName": "string"
              },
              "international": {
                "beneficiaryDetails": {
                  "name": "string",
                  "country": "string",
                  "message": "string"
                },
                "bankDetails": {
                  "country": "string",
                  "accountNumber": "string",
                  "bankAddress": {
                    "name": "string",
                    "address": "string"
                  },
                  "beneficiaryBankBIC": "string",
                  "fedWireNumber": "string",
                  "sortCode": "string",
                  "chipNumber": "string",
                  "routingNumber": "string",
                  "legalEntityIdentifier": "string"
                }
              }
            },
            "isAmountCalculated": false,
            "amount": "string",
            "currency": "AUD"
          }
        ],
        "recurrence": {
          "nextPaymentDate": "string",
          "recurrenceUType": "eventBased",
          "onceOff": {
            "paymentDate": "string"
          },
          "intervalSchedule": {
            "finalPaymentDate": "string",
            "paymentsRemaining": 1,
            "nonBusinessDayTreatment": "AFTER",
            "intervals": [
              {
                "interval": "string",
                "dayInInterval": "string"
              }
            ]
          },
          "lastWeekDay": {
            "finalPaymentDate": "string",
            "paymentsRemaining": 1,
            "interval": "string",
            "lastWeekDay": "FRI",
            "nonBusinessDayTreatment": "AFTER"
          },
          "eventBased": {
            "description": "string"
          }
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name Type Required Default Description
data object mandatory none
» scheduledPayments [BankingScheduledPaymentV2] mandatory The list of scheduled payments to return.
links LinksPaginated mandatory none
meta MetaPaginated mandatory none

BankingScheduledPaymentV2

{
  "scheduledPaymentId": "string",
  "nickname": "string",
  "payerReference": "string",
  "payeeReference": "string",
  "status": "ACTIVE",
  "from": {
    "accountId": "string"
  },
  "paymentSet": [
    {
      "to": {
        "toUType": "accountId",
        "accountId": "string",
        "payeeId": "string",
        "nickname": "string",
        "payeeReference": "string",
        "digitalWallet": {
          "name": "string",
          "identifier": "string",
          "type": "EMAIL",
          "provider": "PAYPAL_AU"
        },
        "domestic": {
          "payeeAccountUType": "account",
          "account": {
            "accountName": "string",
            "bsb": "string",
            "accountNumber": "string"
          },
          "card": {
            "cardNumber": "string"
          },
          "payId": {
            "name": "string",
            "identifier": "string",
            "type": "ABN"
          }
        },
        "biller": {
          "billerCode": "string",
          "crn": "string",
          "billerName": "string"
        },
        "international": {
          "beneficiaryDetails": {
            "name": "string",
            "country": "string",
            "message": "string"
          },
          "bankDetails": {
            "country": "string",
            "accountNumber": "string",
            "bankAddress": {
              "name": "string",
              "address": "string"
            },
            "beneficiaryBankBIC": "string",
            "fedWireNumber": "string",
            "sortCode": "string",
            "chipNumber": "string",
            "routingNumber": "string",
            "legalEntityIdentifier": "string"
          }
        }
      },
      "isAmountCalculated": false,
      "amount": "string",
      "currency": "AUD"
    }
  ],
  "recurrence": {
    "nextPaymentDate": "string",
    "recurrenceUType": "eventBased",
    "onceOff": {
      "paymentDate": "string"
    },
    "intervalSchedule": {
      "finalPaymentDate": "string",
      "paymentsRemaining": 1,
      "nonBusinessDayTreatment": "AFTER",
      "intervals": [
        {
          "interval": "string",
          "dayInInterval": "string"
        }
      ]
    },
    "lastWeekDay": {
      "finalPaymentDate": "string",
      "paymentsRemaining": 1,
      "interval": "string",
      "lastWeekDay": "FRI",
      "nonBusinessDayTreatment": "AFTER"
    },
    "eventBased": {
      "description": "string"
    }
  }
}

Properties

Name Type Required Default Description
scheduledPaymentId BankingScheduledPaymentId mandatory Unique identifier for the scheduled payment.
nickname string optional The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels.
payerReference string mandatory The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided.
payeeReference string conditional The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided.
status 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.
from BankingScheduledPaymentFrom mandatory Object containing details of the source of the payment. Currently only specifies an accountId 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.]
recurrence BankingScheduledPaymentRecurrence mandatory Object containing the detail of the schedule for the payment.

Enumerated Values

Property Value
status ACTIVE
status INACTIVE
status SKIP

BankingScheduledPaymentSetV2

{
  "to": {
    "toUType": "accountId",
    "accountId": "string",
    "payeeId": "string",
    "nickname": "string",
    "payeeReference": "string",
    "digitalWallet": {
      "name": "string",
      "identifier": "string",
      "type": "EMAIL",
      "provider": "PAYPAL_AU"
    },
    "domestic": {
      "payeeAccountUType": "account",
      "account": {
        "accountName": "string",
        "bsb": "string",
        "accountNumber": "string"
      },
      "card": {
        "cardNumber": "string"
      },
      "payId": {
        "name": "string",
        "identifier": "string",
        "type": "ABN"
      }
    },
    "biller": {
      "billerCode": "string",
      "crn": "string",
      "billerName": "string"
    },
    "international": {
      "beneficiaryDetails": {
        "name": "string",
        "country": "string",
        "message": "string"
      },
      "bankDetails": {
        "country": "string",
        "accountNumber": "string",
        "bankAddress": {
          "name": "string",
          "address": "string"
        },
        "beneficiaryBankBIC": "string",
        "fedWireNumber": "string",
        "sortCode": "string",
        "chipNumber": "string",
        "routingNumber": "string",
        "legalEntityIdentifier": "string"
      }
    }
  },
  "isAmountCalculated": false,
  "amount": "string",
  "currency": "AUD"
}

The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry.

Properties

Name Type Required Default Description
to BankingScheduledPaymentToV2 mandatory Object containing details of the destination of the payment. Used to specify a variety of payment destination types.
isAmountCalculated Boolean optional false 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.
currency CurrencyString optional AUD The currency for the payment. AUD assumed if not present.

BankingScheduledPaymentToV2

{
  "toUType": "accountId",
  "accountId": "string",
  "payeeId": "string",
  "nickname": "string",
  "payeeReference": "string",
  "digitalWallet": {
    "name": "string",
    "identifier": "string",
    "type": "EMAIL",
    "provider": "PAYPAL_AU"
  },
  "domestic": {
    "payeeAccountUType": "account",
    "account": {
      "accountName": "string",
      "bsb": "string",
      "accountNumber": "string"
    },
    "card": {
      "cardNumber": "string"
    },
    "payId": {
      "name": "string",
      "identifier": "string",
      "type": "ABN"
    }
  },
  "biller": {
    "billerCode": "string",
    "crn": "string",
    "billerName": "string"
  },
  "international": {
    "beneficiaryDetails": {
      "name": "string",
      "country": "string",
      "message": "string"
    },
    "bankDetails": {
      "country": "string",
      "accountNumber": "string",
      "bankAddress": {
        "name": "string",
        "address": "string"
      },
      "beneficiaryBankBIC": "string",
      "fedWireNumber": "string",
      "sortCode": "string",
      "chipNumber": "string",
      "routingNumber": "string",
      "legalEntityIdentifier": "string"
    }
  }
}

Object containing details of the destination of the payment. Used to specify a variety of payment destination types.

Properties

Name Type Required Default Description
toUType Enum mandatory The type of object provided that specifies the destination of the funds for the payment.
accountId BankingAccountId conditional Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent.
payeeId BankingPayeeId 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.
nickname string conditional The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels.
payeeReference string conditional The reference for the transaction, if applicable, that will be provided by the originating institution for the specific payment. If not empty, it overrides the value provided at the BankingScheduledPayment level.
digitalWallet BankingDigitalWalletPayee conditional none
domestic BankingDomesticPayee conditional none
biller BankingBillerPayee conditional none
international BankingInternationalPayee conditional none

Enumerated Values

Property Value
toUType accountId
toUType biller
toUType digitalWallet
toUType domestic
toUType international
toUType payeeId

BankingScheduledPaymentFrom

{
  "accountId": "string"
}

Object containing details of the source of the payment. Currently only specifies an accountId but provided as an object to facilitate future extensibility and consistency with the to object.

Properties

Name Type Required Default Description
accountId BankingAccountId mandatory Unique identifier for the account.

BankingScheduledPaymentRecurrence

{
  "nextPaymentDate": "string",
  "recurrenceUType": "eventBased",
  "onceOff": {
    "paymentDate": "string"
  },
  "intervalSchedule": {
    "finalPaymentDate": "string",
    "paymentsRemaining": 1,
    "nonBusinessDayTreatment": "AFTER",
    "intervals": [
      {
        "interval": "string",
        "dayInInterval": "string"
      }
    ]
  },
  "lastWeekDay": {
    "finalPaymentDate": "string",
    "paymentsRemaining": 1,
    "interval": "string",
    "lastWeekDay": "FRI",
    "nonBusinessDayTreatment": "AFTER"
  },
  "eventBased": {
    "description": "string"
  }
}

Object containing the detail of the schedule for the payment.

Properties

Name Type Required Default Description
nextPaymentDate DateString optional The date of the next payment under the recurrence schedule.
recurrenceUType Enum mandatory 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.
intervalSchedule BankingScheduledPaymentRecurrenceIntervalSchedule conditional 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.
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.

Enumerated Values

Property Value
recurrenceUType eventBased
recurrenceUType intervalSchedule
recurrenceUType lastWeekDay
recurrenceUType onceOff

BankingScheduledPaymentRecurrenceOnceOff

{
  "paymentDate": "string"
}

Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff.

Properties

Name Type Required Default Description
paymentDate DateString mandatory The scheduled date for the once off payment.

BankingScheduledPaymentRecurrenceIntervalSchedule

{
  "finalPaymentDate": "string",
  "paymentsRemaining": 1,
  "nonBusinessDayTreatment": "AFTER",
  "intervals": [
    {
      "interval": "string",
      "dayInInterval": "string"
    }
  ]
}

Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule.

Properties

Name Type Required Default Description
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.
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.
nonBusinessDayTreatment Enum optional ON 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.

Enumerated Values

Property Value
nonBusinessDayTreatment AFTER
nonBusinessDayTreatment BEFORE
nonBusinessDayTreatment ON
nonBusinessDayTreatment ONLY

BankingScheduledPaymentInterval

{
  "interval": "string",
  "dayInInterval": "string"
}

Properties

Name Type Required Default Description
interval 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.
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.

BankingScheduledPaymentRecurrenceLastWeekday

{
  "finalPaymentDate": "string",
  "paymentsRemaining": 1,
  "interval": "string",
  "lastWeekDay": "FRI",
  "nonBusinessDayTreatment": "AFTER"
}

Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay.

Properties

Name Type Required Default Description
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.
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.
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.
lastWeekDay Enum mandatory The weekDay specified. The payment will occur on the last occurrence of this weekday in the interval.
nonBusinessDayTreatment Enum optional ON Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
  • AFTER - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
  • BEFORE - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
  • ON - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
  • ONLY - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.

Enumerated Values

Property Value
lastWeekDay FRI
lastWeekDay MON
lastWeekDay SAT
lastWeekDay SUN
lastWeekDay THU
lastWeekDay TUE
lastWeekDay WED
nonBusinessDayTreatment AFTER
nonBusinessDayTreatment BEFORE
nonBusinessDayTreatment ON
nonBusinessDayTreatment ONLY

BankingScheduledPaymentRecurrenceEventBased

{
  "description": "string"
}

Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased.

Properties

Name Type Required Default Description
description string mandatory Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer.

CommonPhysicalAddress

{
  "addressUType": "paf",
  "simple": {
    "mailingName": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "postcode": "string",
    "city": "string",
    "state": "string",
    "country": "AUS"
  },
  "paf": {
    "dpid": "string",
    "thoroughfareNumber1": 0,
    "thoroughfareNumber1Suffix": "string",
    "thoroughfareNumber2": 0,
    "thoroughfareNumber2Suffix": "string",
    "flatUnitType": "string",
    "flatUnitNumber": "string",
    "floorLevelType": "string",
    "floorLevelNumber": "string",
    "lotNumber": "string",
    "buildingName1": "string",
    "buildingName2": "string",
    "streetName": "string",
    "streetType": "string",
    "streetSuffix": "string",
    "postalDeliveryType": "string",
    "postalDeliveryNumber": 0,
    "postalDeliveryNumberPrefix": "string",
    "postalDeliveryNumberSuffix": "string",
    "localityName": "string",
    "postcode": "string",
    "state": "string"
  }
}

Properties

Name Type Required Default Description
addressUType Enum mandatory The type of address object present.
simple CommonSimpleAddress conditional Required if addressUType is set to simple.
paf CommonPAFAddress conditional Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf.

Enumerated Values

Property Value
addressUType paf
addressUType simple

CommonSimpleAddress

{
  "mailingName": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "postcode": "string",
  "city": "string",
  "state": "string",
  "country": "AUS"
}

Required if addressUType is set to simple.

Properties

Name Type Required Default Description
mailingName string optional 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.
addressLine2 string optional Second line of the standard address object.
addressLine3 string optional Third line of the standard address object.
postcode string conditional Mandatory for Australian addresses.
city string mandatory 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.
country ExternalRef optional AUS A valid ISO 3166 Alpha-3 country code. Australia (AUS) is assumed if country is not present.

CommonPAFAddress

{
  "dpid": "string",
  "thoroughfareNumber1": 0,
  "thoroughfareNumber1Suffix": "string",
  "thoroughfareNumber2": 0,
  "thoroughfareNumber2Suffix": "string",
  "flatUnitType": "string",
  "flatUnitNumber": "string",
  "floorLevelType": "string",
  "floorLevelNumber": "string",
  "lotNumber": "string",
  "buildingName1": "string",
  "buildingName2": "string",
  "streetName": "string",
  "streetType": "string",
  "streetSuffix": "string",
  "postalDeliveryType": "string",
  "postalDeliveryNumber": 0,
  "postalDeliveryNumberPrefix": "string",
  "postalDeliveryNumberSuffix": "string",
  "localityName": "string",
  "postcode": "string",
  "state": "string"
}

Australian address formatted according to the file format defined by the PAF file format. Required if addressUType is set to paf.

Properties

Name Type Required Default Description
dpid string optional 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).
thoroughfareNumber1Suffix string optional Suffix for the thoroughfare number. Only relevant if thoroughfareNumber1 is populated.
thoroughfareNumber2 PositiveInteger optional 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 if thoroughfareNumber2 is populated.
flatUnitType string optional Type of flat or unit for the address.
flatUnitNumber string optional Unit number (including suffix, if applicable).
floorLevelType string optional Type of floor or level for the address.
floorLevelNumber string optional Floor or level number (including alpha characters).
lotNumber string optional Allotment number for the address.
buildingName1 string optional Building/Property name 1.
buildingName2 string optional Building/Property name 2.
streetName string optional The name of the street.
streetType string optional 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.
postalDeliveryType string optional 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.
postalDeliveryNumberPrefix string optional Postal delivery number prefix related to the postal delivery number.
postalDeliveryNumberSuffix string optional Postal delivery number suffix related to the postal delivery number.
localityName string mandatory Full name of locality.
postcode string mandatory 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.

{
  "self": "string"
}
Name Type Required Default Description
self URIString mandatory Fully qualified link that generated the current response document.

Meta

{}

Properties

None

LinksPaginated

{
  "self": "string",
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Properties

Name Type Required Default Description
self URIString mandatory 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.
prev URIString conditional 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.
last URIString conditional URI to the last page of this set. Mandatory if this response is not the last page.

MetaPaginated

{
  "totalRecords": 0,
  "totalPages": 0
}

Properties

Name Type Required Default Description
totalRecords NaturalNumber mandatory The total number of records in the full set. See pagination.
totalPages NaturalNumber mandatory The total number of pages in the full set. See pagination.

MetaPaginatedTransaction

{
  "totalRecords": 0,
  "totalPages": 0,
  "isQueryParamUnsupported": false
}

Properties

allOf

Name Type Required Default Description
anonymous MetaPaginated mandatory none

and

Name Type Required Default Description
anonymous object mandatory none
» isQueryParamUnsupported Boolean optional false true if text query parameter is not supported.

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name Type Required Default Description
errors [ErrorV2] mandatory List of errors.

ErrorV2

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {
    "urn": "string"
  }
}

Properties

Name Type Required Default Description
code string mandatory The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
title string mandatory A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail string mandatory A human-readable explanation specific to this occurrence of the problem.
meta object conditional Additional data for customised error codes.
» 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.

BankingProductCategory

"BUSINESS_LOANS"

The category to which a product or account belongs. See here for more details.

Properties

Name Type Required Default Description
anonymous Enum mandatory The category to which a product or account belongs. See here for more details.

Enumerated Values

Property Value
anonymous BUSINESS_LOANS
anonymous CRED_AND_CHRG_CARDS
anonymous LEASES
anonymous MARGIN_LOANS
anonymous OVERDRAFTS
anonymous PERS_LOANS
anonymous REGULATED_TRUST_ACCOUNTS
anonymous RESIDENTIAL_MORTGAGES
anonymous TERM_DEPOSITS
anonymous TRADE_FINANCE
anonymous TRANS_AND_SAVINGS_ACCOUNTS
anonymous TRAVEL_CARDS

NppPaymentService

"X2P1"

Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. See here for more details.

Properties

Name Type Required Default Description
anonymous Enum mandatory Identifier of the applicable overlay service. The service is used in conjunction with the serviceVersion. See here for more details.

Enumerated Values

Property Value
anonymous X2P1
anonymous IFTI
anonymous BSCT
anonymous CATSCT

BankingProductId

"string"

A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.

Properties

Name Type Required Default Description
anonymous ASCIIString mandatory A data holder-specific unique identifier for a Banking product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines.

BankingAccountId

"string"

A unique identifier for a Banking account, generated according to CDR ID Permanence requirements.

Properties

Name Type Required Default Description
anonymous ASCIIString mandatory A unique identifier for a Banking account, generated according to CDR ID Permanence requirements.

BankingTransactionId

"string"

A unique identifier for a Banking transaction, generated according to CDR ID Permanence requirements.

Properties

Name Type Required Default Description
anonymous ASCIIString mandatory A unique identifier for a Banking transaction, generated according to CDR ID Permanence requirements.

BankingScheduledPaymentId

"string"

A unique identifier for a Banking scheduled payment, generated according to CDR ID Permanence requirements.

Properties

Name Type Required Default Description
anonymous ASCIIString mandatory A unique identifier for a Banking scheduled payment, generated according to CDR ID Permanence requirements.

BankingPayeeId

"string"

A unique identifier for a Banking payee, generated according to CDR ID Permanence requirements.

Properties

Name Type Required Default Description
anonymous ASCIIString mandatory A unique identifier for a Banking payee, generated according to CDR ID Permanence requirements.

Product Categories

The productCategory enumeration provides the values for categorising products and accounts. These are explained in the following tables:

Deposit Products

Enum Description
REGULATED_TRUST_ACCOUNTS This grouping of products includes accounts where funds are held in trust in regulated industries with complex rules embedded on how the products must operate. Industries that require this sort of product include real estate agents, solicitors and conveyancers.
TERM_DEPOSITS This grouping of products includes all accounts where cash is deposited in the account for a set time period with restrictions on when funds can be withdrawn. Includes traditional Term Deposits and specialised deposits with either fixed terms or notice periods for withdrawal of funds.
TRANS_AND_SAVINGS_ACCOUNTS This grouping of products includes all accounts where cash is deposited in the account and is accessible to the customer when they choose. These are given many names on the market including Cash Accounts, Saving Accounts, Transaction Accounts, Current Accounts, Cheque Accounts, Passbook Accounts, etc.
TRAVEL_CARDS This grouping of products includes prepaid cards with multi-currency capabilities.

Lending Products

Enum Description
BUSINESS_LOANS This grouping of products incorporates all types of lending for business purpose that is not a trade finance facility, lease, overdraft, residential mortgage, credit card or margin lending. It includes traditional term loans, bank guarantees and commercial bills. This category would incorporate both secured and unsecured business purpose lending including all business purpose equipment finance that is not covered by a lease.
CRED_AND_CHRG_CARDS This grouping of products includes all lending products that are issued for the purpose of allowing a flexible line of credit accessed through use of a card. These may be called various names including Credit Cards, Charge Cards and Store Cards.
LEASES This grouping of products will include all types of leases including Financial Lease, Operating Lease, Sale and leaseback, etc.
MARGIN_LOANS This grouping of products includes all types of margin loans which let you borrow money to invest in traded assets including shares & commodities or in managed funds.
OVERDRAFTS This grouping of products includes all types of lending which allows for the loan amount to be withdrawn, repaid, and redrawn again in any manner and any number of times, until the arrangement expires. These loans may be secured or unsecured, and generally don’t have set / minimum repayment requirements.
PERS_LOANS This grouping of products includes all lending for personal purposes that is not a residential mortgage, credit card or margin lending. These loans may be unsecured loans and term loans for purchase assets used as security such as motor vehicles. These may be called various names including Personal Loans and Car Loans.
RESIDENTIAL_MORTGAGES This grouping of products includes all lending products that are available for the primary purpose of borrowing for the purpose of purchasing or renovating residential property, where a residential property will be used as security. This group will include both fixed, variable & secured overdraft types of product and may include both owner-occupied and investment purpose borrowing.
TRADE_FINANCE This grouping of products includes specialised lending products specifically designed to facilitate domestic & international trade. This includes the issuance of letters of credit, factoring, export credit.

Product & Account Components

Product Feature Types

Added featureType:
+ FUNDS_AVAILABLE_AFTER

Description of the usage of the featureType field as it applies to products.

Value Description Use of additionalValue Field
ADDITIONAL_CARDS Additional cards can be requested. The maximum number of additional cards. If no maximum then should be set to null.
BALANCE_TRANSFERS Balance transfers can be made to the account (e.g., for credit cards). N/A
BILL_PAYMENT The product can be attached to an automatic budgeting and bill payment service. Optional name of the service.
BONUS_REWARDS Bonus loyalty rewards points are available. Number of points available.
CARD_ACCESS A card is available for the product to access funds. Text describing list of card types that this product can be linked to.
CASHBACK_OFFER Subject to terms, conditions and eligibility criteria, the product has a cashback offer for opening an account or by spending at a certain retailer. The amount of the cashback offer (in AUD).
COMPLEMENTARY_PRODUCT_DISCOUNTS Indicates that complementary, discounted offerings (such as gift cards, or discounted travel) is available. Description of the complementary offering.
DIGITAL_BANKING Access is available to online banking features for the product. N/A
DIGITAL_WALLET A Digital wallet can be attached to the product. The name or brand of the wallet.
DONATE_INTEREST Indicates that interest generated from the product can be automatically donated to a charity or community group. N/A
EXTRA_REPAYMENTS Indicates that the product has the option to accept extra repayments without incurring additional charges (for example Buy Now, Pay Later (BNPL) or line of credit products may offer the facility to repay instalments on an adhoc basis). N/A
FRAUD_PROTECTION The product includes fraud protection features. N/A
FREE_TXNS A set number of free transactions available per month. The number of free transactions.
FREE_TXNS_ALLOWANCE A set amount of transaction fee value that is discounted per month. The amount of transaction fee discounted (in AUD).
FUNDS_AVAILABLE_AFTER Deposited funds are available after a specified time period. This is distinct from a term deposit duration. The specified time period. Formatted according to ISO 8601 Durations.
GUARANTOR Subject to terms and conditions, the customer may be able to nominate a guarantor during the origination process. N/A
INSTALMENT_PLAN The product has the option to pay for eligible purchases over time with a set number of payments. N/A
INSURANCE Insurance is provided as an additional feature of the product. Text description of the type of insurance (e.g., Travel Insurance).
INTEREST_FREE Interest free period for purchases. Interest free period. Formatted according to ISO 8601 Durations.
INTEREST_FREE_TRANSFERS Interest free period for balance transfers. Interest free period. Formatted according to ISO 8601 Durations.
LOYALTY_PROGRAM A points based loyalty program is available. Name of the loyalty program.
NOTIFICATIONS Advanced notifications are available for the product. Description of the notification capability.
NPP_ENABLED An account of this product type can be used to receive funds as a result of a BSB/Number based NPP payment. N/A
NPP_PAYID An account of this product type can be used as the target of an NPP PayID. N/A
OFFSET An offset account can be connected to the product. N/A
OTHER Another feature that can not be included in any of the other categories. The additionalInfo field is mandatory for this type. N/A
OVERDRAFT An overdraft can be applied for. N/A
REDRAW Redraw of repaid principal above minimum required is available. N/A
RELATIONSHIP_MANAGEMENT Relationship management is available for eligible customers. N/A
UNLIMITED_TXNS Unlimited free transactions available. N/A

Product Constraint Types

Added constraintType:
+ OTHER

Description of the usage of the constraintType field as it applies to products.

Value Description Use of additionalValue Field
MAX_BALANCE A maximum balance is required for the product. The maximum balance in AmountString format.
MAX_LIMIT A maximum limit exists (such as a maximum loan balance denoting the borrowable amount or maximum allowable credit limit). The maximum limit in AmountString format.
MAX_LVR A maximum LVR (Loan to Value Ratio) exists. The maximum LVR in RateString format.
MIN_BALANCE A minimum balance is required for the product. The minimum balance in AmountString format.
MIN_LIMIT A minimum limit exists (such as a minimum loan balance denoting the borrowable amount or minimum credit limit). The minimum limit in AmountString format.
MIN_LVR A minimum LVR (Loan to Value Ratio) exists. The minimum LVR in RateString format.
OPENING_BALANCE An opening balance is required for the product. The minimum opening balance in AmountString format.
OTHER Another constraint that can not be included in any of the other categories. The additionalInfo field is mandatory for this type. N/A

Product Eligibility Types

Updated eligibilityType 'Use of additionalValue Field' details:

PENSION_RECIPIENT
- N/A
+ Optional. If present, MUST contain a description of which pensions qualify.

STUDENT
- N/A
+ Optional. If present, MUST contain a description of who qualifies as a student, e.g., do apprentices qualify?

Description of the usage of the eligibilityType field as it applies to products.

Value Description Use of additionalValue Field
BUSINESS Only business may apply for the account. N/A
EMPLOYMENT_STATUS An eligibility constraint based on employment status applies. A description of the status required.
MAX_AGE Only customers younger than a maximum age may apply. The maximum age in years.
MIN_AGE Only customers older than a minimum age may apply. The minimum age in years.
MIN_INCOME The customer must have an income greater than a specified threshold to obtain the product. Minimum income in AmountString format.
MIN_TURNOVER Only a business with greater than a minimum turnover may apply. Minimum turnover in AmountString format.
NATURAL_PERSON The customer must be a natural person rather than another legal entity. N/A
OTHER Another eligibility criteria exists as described in the additionalInfo field. The additionalInfo field is mandatory for this type. N/A
PENSION_RECIPIENT Only a recipient of a government pension may apply for the product. Optional. If present, MUST contain a description of which pensions qualify.
RESIDENCY_STATUS An eligibility constraint based on residency status applies. A description of the status required.
STAFF Only a staff member of the provider may apply. N/A
STUDENT Only students may apply for the product. Optional. If present, MUST contain a description of who qualifies as a student, e.g., do apprentices qualify?

Product Fee Types

Updated feeType values:
- VARIABLE
+ CASH_ADVANCE
+ DISHONOUR
+ ENQUIRY
+ LATE_PAYMENT
+ OTHER
+ REPLACEMENT
+ UPFRONT_PER_PLAN
+ VARIATION

Description of the usage of the feeType field as it applies to products.

Value Description Use of additionalValue Field
CASH_ADVANCE A fee associated with a cash advance. N/A
DEPOSIT A fee associated with making a deposit. N/A
DISHONOUR A fee associated with a dishonour. N/A
ENQUIRY A fee associated with an enquiry, including a balance enquiry. N/A
EVENT A fee in relation to a particular event (e.g., ordering a new card, viewing a balance or stopping a cheque). N/A
EXIT A fee for closing the product. N/A
LATE_PAYMENT A fee associated with making a payment after a due date. Number of days late, after which the associated fee will be applied.
OTHER Another fee that can not be included in any of the other categories. The additionalInfo field is mandatory for this type. N/A
PAYMENT A fee associated with making a payment. N/A
PERIODIC A periodic fee such as a monthly account servicing fee. The period of charge. Formatted according to ISO 8601 Durations.
PURCHASE A fee associated with making a purchase at a merchant. N/A
REPLACEMENT A fee associated with a receiving a replacement, including cards, cheques, statements, security tokens. N/A
TRANSACTION A fee associated with any transaction (incorporates WITHDRAWAL, DEPOSIT, PAYMENT and PURCHASE). N/A
UPFRONT A fee paid at the beginning of the product lifecycle, such as an establishment fee, loyalty program fee or application fee. N/A
UPFRONT_PER_PLAN A fee paid at the creation of a new payment plan, such as an instalment plan. N/A
VARIATION A fee associated with a request for a variation, including to an existing process, instruction or terms. N/A
WITHDRAWAL A fee associated with making a withdrawal. N/A

Product Discount Types

Description of the usage of the discountType field as it applies to products.

Value Description Use of additionalValue Field
BALANCE Discount on a fee for maintaining a set balance. As the discount applies to a fee the period is the same as for the fee. The minimum balance in AmountString format.
DEPOSITS Discount for depositing a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. The minimum deposit amount in AmountString format.
ELIGIBILITY_ONLY Discount applies based on customer eligibility (eligibility array must be populated). N/A
FEE_CAP The amount, balanceRate, transactionRate, accruedRate or feeRate fields of the discount represent the maximum amount charged in a time period. The time period for which the fee cap applies. Formatted according to ISO 8601 Durations.
PAYMENTS Discount for outbound payments from the account under a certain amount of money in a period. As the discount applies to a fee the period is the same as for the fee. The payment threshold amount in AmountString format.

Product Discount Eligibility Types

Updated discountEligibilityType 'Use of additionalValue Field' details:

PENSION_RECIPIENT
- Optional. Should contain a description of which pensions qualify.
+ Optional. If present, MUST contain a description of which pensions qualify.

STUDENT
- Optional. Should contain a description of who qualifies as a student, e.g., do apprentices qualify?
+ Optional. If present, MUST contain a description of who qualifies as a student, e.g., do apprentices qualify?

Description of the usage of the discountEligibilityType field as it applies to products.

Value Description Use of additionalValue Field
BUSINESS A business or other non-person legal entity. N/A
EMPLOYMENT_STATUS An eligibility constraint based on employment status applies. A description of the status required.
INTRODUCTORY The discount is only available during an introductory period. The period of time for the introductory discount. Formatted according to ISO 8601 Durations.
MAX_AGE Only customers younger than a maximum age receive the discount. The maximum age in years.
MIN_AGE Only customers older than a minimum age receive the discount. The minimum age in years.
MIN_INCOME The customer must have an income greater than a specified threshold to obtain the discount. Minimum income in AmountString format.
MIN_TURNOVER Only a business with greater than a minimum turnover is eligible. Minimum turnover in AmountString format.
NATURAL_PERSON The customer must be a natural person rather than another legal entity. N/A
OTHER Another eligibility criteria exists as described in the additionalInfo field. The additionalInfo field is mandatory for this type. N/A
PENSION_RECIPIENT Only a recipient of a government pension may receive the discount. Optional. If present, MUST contain a description of which pensions qualify.
RESIDENCY_STATUS An eligibility constraint based on residency status applies. A description of the status required.
STAFF Only a staff member of the provider may receive the discount. N/A
STUDENT Only students may receive the discount. Optional. If present, MUST contain a description of who qualifies as a student, e.g., do apprentices qualify?

Product Deposit Rate Types

Description of the usage of the depositRateType field as it applies to products.

A deposit product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

Value Description Use of additionalValue Field
FIXED Fixed rate for a period of time. The period of time fixed. Formatted according to ISO 8601 Durations.
FLOATING A floating rate is relatively fixed but still adjusts under specific circumstances. Details of the float parameters.
MARKET_LINKED A rate that is linked to a specific market, commodity or asset class. Details of the market linkage.
VARIABLE A variable base rate for the product. N/A

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

Value Description Use of additionalValue Field
BONUS A bonus rate available by meeting a specific criteria. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). A description of the criteria to obtain the bonus.
BUNDLE_BONUS A bonus rate obtained by originating a bundle instead of a standalone product. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). The name of the bundle.
INTRODUCTORY An introductory bonus that will expire after a set period. A deposit 'bonus' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Bonus). The period of time for the introductory rate. Formatted according to ISO 8601 Durations.

Product Lending Rate Types

Description of the usage of the lendingRateType field as it applies to products.

Added lendingRateType:
+ BALANCE_TRANSFER

A lending product is expected to present a single Base rate corresponding to relevant selection criteria including the rate tiers and additionalValue, where applicable.

Card products may have two or more base rates, including CASH_ADVANCE and PURCHASE as they may apply to different transaction types within an account. The PURCHASE lendingRateType is considered the rate commonly applicable to a card.

Value Description Use of additionalValue Field
BALANCE_TRANSFER Specific rate applied to balance transfers to the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. N/A
CASH_ADVANCE Specific rate applied to cash advances from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. N/A
FIXED Fixed rate for a period of time. The period of time fixed. Formatted according to ISO 8601 Durations.
FLOATING A floating rate is relatively fixed but still adjusts under specific circumstances. Details of the float parameters.
MARKET_LINKED A rate that is linked to a specific market, commodity or asset class. Details of the market linkage.
PURCHASE Specific rate applied to purchases from the account. This is expected to apply to products in the CRED_AND_CHRG_CARDS category only. N/A
VARIABLE A variable base rate for the product. N/A

A product may have zero, one, or multiple adjustment rates that are taken to apply to a Base rate.

Value Description Use of additionalValue Field
BUNDLE_DISCOUNT_FIXED A discount rate off the fixed rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). The name of the bundle.
BUNDLE_DISCOUNT_VARIABLE A discount rate off the variable rate obtained by originating a bundle instead of a standalone product. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). The name of the bundle.
DISCOUNT A specific discount rate that may be applied. A discount rate reduces the interest payable. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). Description of the discount rate that is applicable.
INTRODUCTORY An introductory discount that will expire after a set period. A lending 'discount' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base-Discount). The period of time for the introductory rate. Formatted according to ISO 8601 Durations.
PENALTY A specific penalty rate that may be applied. A penalty rate increases the interest payable. A lending 'penalty' rate value MUST be specified as zero or a positive number in the RateString format. The formula to calculate an Effective rate would be (Base+Penalty). Description of the penalty rate that is applicable.

Banking Term Deposit Account Types

Description of the usage of the maturityInstructions field as it applies to accounts.

Value Description Use of additionalValue Field
HOLD_ON_MATURITY Funds are held in a facility or similar mechanism managed by the data holder for a period of time until the customer provides instructions or the maximum period of the hold has elapsed. Funds may be renewed or withdrawn upon instructions by the customer. N/A
PAID_OUT_AT_MATURITY Funds are to be paid out at maturity. N/A
ROLLED_OVER Funds are to be rolled over at maturity. N/A

Rate and Tier Applicability Types

+ Added Rate and Tier Applicability Types section

Description of the usage of the rateApplicabilityType field as it applies to products.

Value Description Use of additionalValue Field
MIN_DEPOSITS When a minimum number of deposits is made in a month, or the month prior. Minimum number of deposits.
MIN_DEPOSIT_AMOUNT When a minimum deposit amount is made in a month, or the month prior. Minimum deposit in AmountString format.
DEPOSIT_BALANCE_INCREASED When the overall balance of the account, excluding interest, has increased over the month prior. Minimum amount in AmountString format.
EXISTING_CUST Applicable to existing customers of the brand. N/A
NEW_ACCOUNTS Applicable to new accounts. N/A
NEW_CUSTOMER Applicable to new customers to the brand. N/A
NEW_CUSTOMER_TO_GROUP Applicable to new customers to a group of brands. N/A
ONLINE_ONLY Applicable to accounts originated online. N/A
OTHER Applicable under other conditions. The additionalInfo field is mandatory for this type. N/A
MIN_PURCHASES When a minimum number of purchases is made and settled in a month, or the month prior. Minimum number of purchases.
MAX_WITHDRAWALS Applicable up to a maximum number of withdrawals in a month, or the month prior. Maximum number of withdrawals.
MAX_WITHDRAWAL_AMOUNT Applicable up to a maximum amount withdrawn in a month, or the month prior. Maximum withdrawn in AmountString format.

NPP Services

The service enumeration provides the values for specifying New Payments Platform (NPP) payments by their NPP service category. These are explained in the following tables:

NPP Service Overlay Codes

Value Description
X2P1 Represents the Osko payment service that allow consumers and businesses to send money between eligible accounts in near real-time.
BSCT Basic Single Credit Transfers means a credit payment message sent over the NPP without an overlay. It is an individual transaction that will be cleared then settled.
CATSCT Category Purpose Payments denote categorised payments for super, tax and payroll payments. This service helps third parties to instruct financial institutions on the purpose of the payment and priority. These payments may represent additional reference information in the payment message, which can be presented to the payee. For example, "Adjustment pay for week ending 20/1/19" or "Commission payment for Quarter 1", up to date details of hours paid, superannuation contributions or details relevant to the employee payslip.
IFTI International Funds Transfers Instructions (IFTIs) are payments sent between an Australian financial institution and an overseas financial institution.