Get Bulk Direct Debits V2

This page documents the obsolete version 2 of the Get Bulk Direct Debits endpoint.

Data Holders can retire this version after June 14th 2027. Data Recipients must update to newer versions prior to this date.

Get Bulk Direct Debits

Code samples

GET https://mtls.dh.example.com/cds-au/v1/banking/accounts/direct-debits 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/direct-debits', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /banking/accounts/direct-debits

Obtain direct debit authorisations for multiple, filtered accounts.

Obsolete versions: v1.

Endpoint Version


Version	2

Parameters

Name	In	Type	Required	Default	Description
product-category	query	BankingProductCategoryV2	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	BUY_NOW_PAY_LATER
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": {
    "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
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	ResponseBankingDirectDebitAuthorisationList
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Required Field 400 - Missing Required Header 400 - Invalid Version 400 - Invalid Page Size	ResponseErrorListV2
406	Not Acceptable	The following error codes MUST be supported: 406 - Unsupported Version	ResponseErrorListV2
422	Unprocessable Entity	The following error codes MUST be supported: 422 - Invalid Page	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	Description
data	object	mandatory	none
» accountIds	[BankingAccountId]	mandatory	Array of accountId values to obtain data for.
meta	Meta	optional	none

ResponseBankingProductListV4

{
  "data": {
    "products": [
      {
        "productId": "string",
        "effectiveFrom": "string",
        "effectiveTo": "string",
        "lastUpdated": "string",
        "productCategory": "BUSINESS_LOANS",
        "name": "string",
        "description": "string",
        "brand": "string",
        "brandName": "string",
        "brandGroup": "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	Description
data	object	mandatory	none
» products	[BankingProductV6]	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

BankingProductV6

{
  "productId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "productCategory": "BUSINESS_LOANS",
  "name": "string",
  "description": "string",
  "brand": "string",
  "brandName": "string",
  "brandGroup": "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	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	BankingProductCategoryV2	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.
brandGroup	ASCIIString	optional	The brandGroup of a consumer data sharing brand that the product is associated with.
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	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	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.

ResponseBankingProductByIdV7

{
  "data": {
    "productId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "productCategory": "BUSINESS_LOANS",
    "name": "string",
    "description": "string",
    "brand": "string",
    "brandName": "string",
    "brandGroup": "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"
      }
    ],
    "instalments": {
      "maximumConcurrentPlans": 0,
      "instalmentsLimit": "string",
      "minimumPlanValue": "string",
      "maximumPlanValue": "string",
      "minimumSplit": 4,
      "maximumSplit": 4
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

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

BankingProductDetailV7

{
  "productId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "productCategory": "BUSINESS_LOANS",
  "name": "string",
  "description": "string",
  "brand": "string",
  "brandName": "string",
  "brandGroup": "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"
    }
  ],
  "instalments": {
    "maximumConcurrentPlans": 0,
    "instalmentsLimit": "string",
    "minimumPlanValue": "string",
    "maximumPlanValue": "string",
    "minimumSplit": 4,
    "maximumSplit": 4
  }
}

Properties

allOf

Name	Type	Required	Default	Description
anonymous	BankingProductV6	mandatory		none

and

Name	Type	Required	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	[BankingProductFeatureV4]	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.
» instalments	BankingProductInstalments	optional	Details of instalment features on the account.

BankingProductBundle

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

Properties

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

BankingProductFeatureV4

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

Properties

Name	Type	Required	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 the featureType value is `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	EXTRA_DOWN_PAYMENT
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	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	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 eligibilityType value is `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	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	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 the discountType value 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	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	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. Mandatory if the discountEligibilityType value is `OTHER`.
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	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	Qualifying criteria or conditions relevant to the associated 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	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	Qualifying criteria or conditions relevant to the associated 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	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	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

BankingProductInstalments

{
  "maximumConcurrentPlans": 0,
  "instalmentsLimit": "string",
  "minimumPlanValue": "string",
  "maximumPlanValue": "string",
  "minimumSplit": 4,
  "maximumSplit": 4
}

Details of instalment features on the account.

Properties

Name	Type	Required	Description
maximumConcurrentPlans	NaturalNumber	optional	Maximum number of concurrent active instalment plans that may be created on the account. If `null`, there is no predetermined maximum number.
instalmentsLimit	AmountString	optional	Maximum combined limit of all instalment plans that may be created on the account. If `null` or not present, an opened account balance creditLimit may be assumed to provide a maximum limit for instalments.
minimumPlanValue	AmountString	optional	Minimum value that can be opened as an instalment plan.
maximumPlanValue	AmountString	optional	Maximum value that can be opened as an instalment plan. If `null` or not present, instalmentsLimit is assumed to be the maximum individual plan value.
minimumSplit	PositiveInteger	mandatory	Minimum number of instalment payments a plan can be created with.
maximumSplit	PositiveInteger	mandatory	Maximum number of instalment payments a plan can be created with.

ResponseBankingAccountListV3

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

Properties

Name	Type	Required	Description
data	object	mandatory	none
» accounts	[BankingAccountV3]	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

BankingAccountV3

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

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	BankingProductCategoryV2	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).
isInstalmentDetailAvailable	Boolean	optional	`false`	`true` if any active or inactive instalment plans are available in the Get Instalment Plans endpoints. `false` if instalment plans are not applicable to the account.

Enumerated Values

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

ResponseBankingAccountByIdV5

{
  "data": {
    "accountId": "string",
    "creationDate": "string",
    "displayName": "string",
    "nickname": "string",
    "openStatus": "CLOSED",
    "isOwned": true,
    "accountOwnership": "UNKNOWN",
    "maskedNumber": "string",
    "productCategory": "BUSINESS_LOANS",
    "productName": "string",
    "isInstalmentDetailAvailable": false,
    "bsb": "string",
    "accountNumber": "string",
    "bundleName": "string",
    "instalments": {
      "maximumConcurrentPlans": 0,
      "instalmentsLimit": "string",
      "minimumPlanValue": "string",
      "maximumPlanValue": "string",
      "minimumSplit": 4,
      "maximumSplit": 4
    },
    "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	Description
data	BankingAccountDetailV5	mandatory	none
links	Links	mandatory	none
meta	Meta	optional	none

BankingAccountDetailV5

{
  "accountId": "string",
  "creationDate": "string",
  "displayName": "string",
  "nickname": "string",
  "openStatus": "CLOSED",
  "isOwned": true,
  "accountOwnership": "UNKNOWN",
  "maskedNumber": "string",
  "productCategory": "BUSINESS_LOANS",
  "productName": "string",
  "isInstalmentDetailAvailable": false,
  "bsb": "string",
  "accountNumber": "string",
  "bundleName": "string",
  "instalments": {
    "maximumConcurrentPlans": 0,
    "instalmentsLimit": "string",
    "minimumPlanValue": "string",
    "maximumPlanValue": "string",
    "minimumSplit": 4,
    "maximumSplit": 4
  },
  "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	BankingAccountV3	mandatory		none

and

Name	Type	Required	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.
» instalments	BankingProductInstalments	optional	Details of instalment features on the account.
» 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	BankingProductFeatureV4	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

BankingInstalmentPlan

{
  "accountId": "string",
  "planId": "string",
  "planReference": "string",
  "merchantName": "string",
  "merchantCategoryCode": "string",
  "planNickname": "string",
  "creationDate": "string",
  "amount": "string",
  "planCurrency": "AUD",
  "planCharge": "string",
  "planRate": "string",
  "duration": "string",
  "instalmentInterval": "string",
  "schedule": [
    {
      "amountDue": "string",
      "dueDate": "string",
      "isPaid": false
    }
  ]
}

Properties

Name	Type	Required	Default	Description
accountId	BankingAccountId	mandatory		Unique identifier for the account.
planId	BankingInstalmentPlanId	mandatory		Unique identifier for this plan in accordance with ID Permanence requirements.
planReference	string	mandatory		Unique purchase or order number for this plan, aligned to other channels.
merchantName	string	mandatory		Name of the merchant associated with the instalment plan.
merchantCategoryCode	string	optional		The merchant category code (MCC) for the merchant associated with the instalment plan.
planNickname	string	mandatory		The short display name of the plan as provided by the customer. Where a customer has not provided a nickname, a display name derived by the data holder consistent with other channels.
creationDate	DateString	mandatory		The date the plan was created.
amount	AmountString	mandatory		The original transaction amount the instalment plan was created for, including any upfront payment. E.g., For a $100 purchase split into four repayments, this would be `100.00`.
planCurrency	CurrencyString	optional	`AUD`	The currency of the plan amount. If absent assumed to be `AUD`.
planCharge	AmountString	optional		Any charges incorporated into the scheduled amounts due, excluding other fees. E.g., If the consumer agrees to repay a $100 purchase plus a $5 charge split across four instalments, this would be `5.00`.
planRate	RateString	optional		If displayed to the consumer, the percentage value of any charges incorporated into the scheduled amounts due, excluding other fees. E.g., If the consumer agrees to repay a $1000 purchase plus 10% interest split across twelve instalments, this would be `0.1`.
duration	ExternalRef	mandatory		The expected repayment period as at the creation of the plan. Formatted according to ISO 8601 Durations (excludes recurrence syntax). E.g., For a further three fortnightly repayments from the creationDate, this would be `P6W`.
instalmentInterval	ExternalRef	mandatory		The expected repayment interval. Formatted according to ISO 8601 Durations (excludes recurrence syntax). E.g., For fortnightly repayments, this would be `P2W`.
schedule	[BankingInstalmentPlanSchedule]	mandatory		Array of scheduled repayment amounts and dates.

BankingInstalmentPlanSchedule

{
  "amountDue": "string",
  "dueDate": "string",
  "isPaid": false
}

Properties

Name	Type	Required	Default	Description
amountDue	AmountString	mandatory		Amount due with this repayment.
dueDate	DateString	mandatory		Date this repayment is or was due.
isPaid	Boolean	optional	`false`	Whether the associated amountDue has been paid or is otherwise considered as not outstanding. `false` is assumed if absent.

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

ResponseBankingTransactionListV2

{
  "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",
        "instalmentPlanId": "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	Description
data	object	mandatory	none
» transactions	[BankingTransactionV2]	mandatory	none
links	LinksPaginated	mandatory	none
meta	MetaPaginatedTransaction	mandatory	none

BankingTransactionV2

{
  "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",
  "instalmentPlanId": "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.
instalmentPlanId	BankingInstalmentPlanId	optional		If the transaction is associated with an instalment plan, the corresponding planId value. It should be noted that if the transaction is for a fee associated with a plan, or any amount of repayment, the amount of the transaction may not match a scheduled instalment amount.
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

ResponseBankingTransactionByIdV3

{
  "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",
    "instalmentPlanId": "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	Description
data	BankingTransactionDetailV3	mandatory	none
links	Links	mandatory	none
meta	Meta	optional	none

BankingTransactionDetailV3

{
  "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",
  "instalmentPlanId": "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	BankingTransactionV2	mandatory		none

and

Name	Type	Required	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	Mandatory if the extensionUType value is `nppPayload`.
»»» extendedDescription	string	conditional	An extended string description. Mandatory 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": "0.00",
        "amortisedLimit": "0.00",
        "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	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": "0.00",
    "amortisedLimit": "0.00",
    "currency": "AUD",
    "purses": [
      {
        "amount": "string",
        "currency": "string"
      }
    ]
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

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

BankingBalance

{
  "accountId": "string",
  "currentBalance": "string",
  "availableBalance": "string",
  "creditLimit": "0.00",
  "amortisedLimit": "0.00",
  "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	`0.00`	Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent.
amortisedLimit	AmountString	optional	`0.00`	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	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	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	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	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	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	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	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	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	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	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	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	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	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": "P1D"
              }
            ]
          },
          "lastWeekDay": {
            "finalPaymentDate": "string",
            "paymentsRemaining": 1,
            "interval": "string",
            "lastWeekDay": "FRI",
            "nonBusinessDayTreatment": "AFTER"
          },
          "eventBased": {
            "description": "string"
          }
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» scheduledPayments	[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": "P1D"
        }
      ]
    },
    "lastWeekDay": {
      "finalPaymentDate": "string",
      "paymentsRemaining": 1,
      "interval": "string",
      "lastWeekDay": "FRI",
      "nonBusinessDayTreatment": "AFTER"
    },
    "eventBased": {
      "description": "string"
    }
  }
}

Properties

Name	Type	Required	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	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": "P1D"
      }
    ]
  },
  "lastWeekDay": {
    "finalPaymentDate": "string",
    "paymentsRemaining": 1,
    "interval": "string",
    "lastWeekDay": "FRI",
    "nonBusinessDayTreatment": "AFTER"
  },
  "eventBased": {
    "description": "string"
  }
}

Object containing the detail of the schedule for the payment.

Properties

Name	Type	Required	Description
nextPaymentDate	DateString	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 the recurrenceUType value is `onceOff`.
intervalSchedule	BankingScheduledPaymentRecurrenceIntervalSchedule	conditional	Indicates that the schedule of payments is defined by a series of intervals. Mandatory if the recurrenceUType value is `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 the recurrenceUType value is `lastWeekDay`.
eventBased	BankingScheduledPaymentRecurrenceEventBased	conditional	Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if the recurrenceUType value is `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 the recurrenceUType value is 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": "P1D"
    }
  ]
}

Indicates that the schedule of payments is defined by a series of intervals. Mandatory if the recurrenceUType value is 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": "P1D"
}

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	`P1D`	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 the recurrenceUType value is 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 the recurrenceUType value is 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	Description
addressUType	Enum	mandatory	The type of address object present.
simple	CommonSimpleAddress	conditional	Mandatory if the addressUType value is `simple`.
paf	CommonPAFAddress	conditional	Australian address formatted according to the file format defined by the PAF file format. Mandatory if the addressUType value is `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"
}

Mandatory if the addressUType value is 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. Mandatory if the addressUType value is paf.

Properties

Name	Type	Required	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`.

Links

{
  "self": "string"
}

Properties

Name	Type	Required	Default	Description
self	URIString	mandatory		Fully qualified link that generated the current response document.

Properties

None

LinksPaginated

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

Properties

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

BankingProductCategoryV2

"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	BUY_NOW_PAY_LATER
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

ResponseBankingInstalmentPlanList

{
  "data": {
    "plans": [
      {
        "accountId": "string",
        "planId": "string",
        "planReference": "string",
        "merchantName": "string",
        "merchantCategoryCode": "string",
        "planNickname": "string",
        "creationDate": "string",
        "amount": "string",
        "planCurrency": "AUD",
        "planCharge": "string",
        "planRate": "string",
        "duration": "string",
        "instalmentInterval": "string",
        "schedule": [
          {
            "amountDue": "string",
            "dueDate": "string",
            "isPaid": false
          }
        ]
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» plans	[BankingInstalmentPlan]	mandatory	Array of instalment plans. An instalment plan describes the terms of repayment for a specified loan amount such as a Buy Now, Pay Later (BNPL) purchase or a specific card transaction.
links	LinksPaginated	mandatory	none
meta	MetaPaginated	mandatory	none

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.

BankingInstalmentPlanId

"string"

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

Properties

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