ING Australia Banking Accounts API
Banking Account endpoints
Banking Account endpoints
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ing-australia-banking-accounts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: CDR Banking Banking Account Balances Banking Accounts API
version: 1.36.0
description: Specifications for resource endpoints applicable to data holders in the Banking sector.
license:
name: MIT License
url: https://opensource.org/licenses/MIT
contact:
name: Data Standards Body
email: contact@dsb.gov.au
url: https://dsb.gov.au/
servers:
- description: MTLS
url: https://mtls.dh.example.com/cds-au/v1
tags:
- name: Banking Accounts
x-shortName: Accounts
description: Banking Account endpoints
paths:
/banking/accounts:
get:
tags:
- Banking Accounts
summary: Get Accounts
description: 'Obtain a list of accounts.
Obsolete versions: [v1](includes/obsolete/get-accounts-v1.html), [v2](includes/obsolete/get-accounts-v2.html).'
operationId: listBankingAccounts
parameters:
- $ref: '#/components/parameters/QueryBankingProductCategory'
- $ref: '#/components/parameters/QueryBankingAccountOpenStatus'
- $ref: '#/components/parameters/QueryBankingAccountIsOwned'
- $ref: '#/components/parameters/QueryPage'
- $ref: '#/components/parameters/QueryPageSize'
- $ref: '#/components/parameters/HeaderXV'
- $ref: '#/components/parameters/HeaderXMinV'
- $ref: '#/components/parameters/HeaderXFAPIInteractionId'
- $ref: '#/components/parameters/HeaderXFAPIAuthDate'
- $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
- $ref: '#/components/parameters/HeaderXCDSClientHeaders'
responses:
'200':
$ref: '#/components/responses/ListBankingAccounts200'
'400':
$ref: '#/components/responses/ListBankingAccounts400'
'406':
$ref: '#/components/responses/ListBankingAccounts406'
'422':
$ref: '#/components/responses/ListBankingAccounts422'
x-scopes:
- bank:accounts.basic:read
x-version: '3'
/banking/accounts/{accountId}:
get:
tags:
- Banking Accounts
summary: Get Account Detail
description: 'Obtain detailed information on a single account.
Obsolete versions: [v1](includes/obsolete/get-account-detail-v1.html), [v2](includes/obsolete/get-account-detail-v2.html), [v3](includes/obsolete/get-account-detail-v3.html), [v4](includes/obsolete/get-account-detail-v4.html).'
operationId: getBankingAccountDetail
parameters:
- $ref: '#/components/parameters/PathAccountId'
- $ref: '#/components/parameters/HeaderXV'
- $ref: '#/components/parameters/HeaderXMinV'
- $ref: '#/components/parameters/HeaderXFAPIInteractionId'
- $ref: '#/components/parameters/HeaderXFAPIAuthDate'
- $ref: '#/components/parameters/HeaderXFAPICustomerIPAddress'
- $ref: '#/components/parameters/HeaderXCDSClientHeaders'
responses:
'200':
$ref: '#/components/responses/GetBankingAccountDetail200'
'400':
$ref: '#/components/responses/GetBankingAccountDetail400'
'404':
$ref: '#/components/responses/GetBankingAccountDetail404'
'406':
$ref: '#/components/responses/GetBankingAccountDetail406'
x-scopes:
- bank:accounts.detail:read
x-version: '5'
components:
parameters:
QueryBankingProductCategory:
name: product-category
in: query
description: Used to filter results on the _productCategory_ field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
schema:
$ref: '#/components/schemas/BankingProductCategoryV2'
QueryPageSize:
name: page-size
in: query
description: Page size to request. Default is 25 (standard pagination).
schema:
type: integer
default: 25
x-cds-type: PositiveInteger
HeaderXFAPIAuthDate:
name: x-fapi-auth-date
in: header
description: The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
schema:
type: string
x-conditional: true
QueryBankingAccountOpenStatus:
name: open-status
in: query
description: Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.
schema:
type: string
default: ALL
enum:
- ALL
- CLOSED
- OPEN
HeaderXMinV:
name: x-min-v
in: header
description: 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_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.
schema:
type: string
QueryPage:
name: page
in: query
description: Page of results to request (standard pagination).
schema:
type: integer
default: 1
x-cds-type: PositiveInteger
PathAccountId:
name: accountId
in: path
description: The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.
required: true
schema:
$ref: '#/components/schemas/BankingAccountId'
HeaderXFAPIInteractionId:
name: x-fapi-interaction-id
in: header
description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder **MUST** play back this value in the _x-fapi-interaction-id_ response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.
schema:
type: string
HeaderXV:
name: x-v
in: header
description: 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_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).
required: true
schema:
type: string
QueryBankingAccountIsOwned:
name: is-owned
in: query
description: Filters accounts based on whether they are owned by the authorised customer. `true` for owned accounts, `false` for unowned accounts and absent for all accounts.
schema:
type: boolean
HeaderXCDSClientHeaders:
name: x-cds-client-headers
in: header
description: The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
schema:
type: string
x-conditional: true
x-cds-type: Base64
HeaderXFAPICustomerIPAddress:
name: x-fapi-customer-ip-address
in: header
description: The customer's original IP address if the customer is currently logged in to the Data Recipient 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.
schema:
type: string
responses:
ListBankingAccounts400:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Required Field](#error-400-field-missing)</li><li>[400 - Missing Required Header](#error-400-header-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
ListBankingAccounts422:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
ListBankingAccounts406:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
GetBankingAccountDetail404:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Unavailable Banking Account](#error-404-authorisation-unavailable-banking-account)</li><li>[404 - Invalid Banking Account](#error-404-authorisation-invalid-banking-account)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
GetBankingAccountDetail406:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
ListBankingAccounts200:
description: Successful response
headers:
x-v:
$ref: '#/components/headers/XV'
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountListV3'
GetBankingAccountDetail400:
description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Required Field](#error-400-field-missing)</li><li>[400 - Missing Required Header](#error-400-header-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
headers:
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
GetBankingAccountDetail200:
description: Successful response
headers:
x-v:
$ref: '#/components/headers/XV'
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountByIdV5'
schemas:
BankingFeeAmount:
type: object
required:
- amount
properties:
amount:
type: string
description: The specific amount charged for the fee each time it is incurred.
x-cds-type: AmountString
BankingLoanAccountV3:
required:
- repaymentType
type: object
properties:
originalStartDate:
type: string
description: Optional original start date for the loan.
x-cds-type: DateString
originalLoanAmount:
type: string
description: Optional original loan value.
x-cds-type: AmountString
originalLoanCurrency:
type: string
description: If absent assumes `AUD`.
default: AUD
x-cds-type: CurrencyString
loanEndDate:
type: string
description: Date that the loan is due to be repaid in full.
x-cds-type: DateString
nextInstalmentDate:
type: string
description: Next date that an instalment is required.
x-cds-type: DateString
minInstalmentAmount:
type: string
description: Minimum amount of next instalment.
x-cds-type: AmountString
minInstalmentCurrency:
type: string
description: If absent assumes `AUD`.
default: AUD
x-cds-type: CurrencyString
maxRedraw:
type: string
description: Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account.
x-cds-type: AmountString
maxRedrawCurrency:
type: string
description: If absent assumes `AUD`.
default: AUD
x-cds-type: CurrencyString
minRedraw:
type: string
description: Minimum redraw amount.
x-cds-type: AmountString
minRedrawCurrency:
type: string
description: If absent assumes `AUD`.
default: AUD
x-cds-type: CurrencyString
offsetAccountEnabled:
type: boolean
description: Set to `true` if one or more offset accounts are configured for this loan account.
offsetAccountIds:
type: array
description: 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.
items:
$ref: '#/components/schemas/BankingAccountId'
repaymentType:
type: string
description: Option in place for repayments.
enum:
- INTEREST_ONLY
- OTHER
- PRINCIPAL_AND_INTEREST
- UNCONSTRAINED
repaymentFrequency:
type: string
description: The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).
x-cds-type: ExternalRef
BankingProductDiscountV2:
description: Note that the currency of the fee discount is expected to be the same as the currency of the fee itself.
required:
- description
- discountType
- discountMethodUType
type: object
properties:
description:
type: string
description: Description of the discount.
discountType:
type: string
description: The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc).
enum:
- BALANCE
- DEPOSITS
- ELIGIBILITY_ONLY
- FEE_CAP
- PAYMENTS
discountMethodUType:
type: string
description: Reference to the applicable fee discount method structure.
enum:
- fixedAmount
- rateBased
fixedAmount:
description: Mandatory if the _discountMethodUType_ value is `fixedAmount`. Where the discount is a specific amount.
allOf:
- $ref: '#/components/schemas/BankingFeeDiscountAmount'
rateBased:
description: 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.
allOf:
- $ref: '#/components/schemas/BankingFeeDiscountRate'
additionalValue:
type: string
description: Generic field containing additional information relevant to the [_discountType_](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [_discountType_](#tocSproductdiscounttypedoc).
additionalInfo:
type: string
description: Display text providing more information on the discount.
additionalInfoUri:
type: string
description: Link to a web page with more information on this discount.
x-cds-type: URIString
eligibility:
type: array
description: Eligibility constraints that apply to this discount. Mandatory if the [_discountType_](#tocSproductdiscounttypedoc) value is `ELIGIBILITY_ONLY`.
items:
$ref: '#/components/schemas/BankingProductDiscountEligibility'
x-conditional:
- fixedAmount
- rateBased
- additionalValue
- eligibility
BankingFeeDiscountAmount:
type: object
required:
- amount
properties:
amount:
type: string
description: The specific amount discounted from the fee each time it is incurred.
x-cds-type: AmountString
BankingProductCategoryV2:
type: string
description: The category to which a product or account belongs. See [here](#product-categories) for more details.
enum:
- BUSINESS_LOANS
- BUY_NOW_PAY_LATER
- CRED_AND_CHRG_CARDS
- LEASES
- MARGIN_LOANS
- OVERDRAFTS
- PERS_LOANS
- REGULATED_TRUST_ACCOUNTS
- RESIDENTIAL_MORTGAGES
- TERM_DEPOSITS
- TRADE_FINANCE
- TRANS_AND_SAVINGS_ACCOUNTS
- TRAVEL_CARDS
ResponseBankingAccountByIdV5:
required:
- data
- links
type: object
properties:
data:
$ref: '#/components/schemas/BankingAccountDetailV5'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
BankingProductRateConditionV2:
type: object
description: Defines a condition for the applicability of a rate.
properties:
rateApplicabilityType:
type: string
description: Category of applicability condition associated with the rate. For more information refer to [Rate and Tier Applicability Types](#tocSbankingproductrateconditiondoc).
enum:
- MIN_DEPOSITS
- MIN_DEPOSIT_AMOUNT
- DEPOSIT_BALANCE_INCREASED
- EXISTING_CUST
- NEW_ACCOUNTS
- NEW_CUSTOMER
- NEW_CUSTOMER_TO_GROUP
- ONLINE_ONLY
- OTHER
- MIN_PURCHASES
- MAX_WITHDRAWALS
- MAX_WITHDRAWAL_AMOUNT
example: NEW_CUSTOMER
additionalValue:
type: string
description: Generic field containing additional information relevant to the _rateApplicabilityType_ specified. Whether mandatory or not is dependent on the value of [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc).
additionalInfo:
type: string
description: Display text providing more information on the condition. Mandatory if the [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc) value is `OTHER`.
additionalInfoUri:
type: string
description: Link to a web page with more information on this condition.
x-cds-type: URIString
required:
- rateApplicabilityType
x-conditional:
- additionalValue
- additionalInfo
BankingTermDepositAccount:
required:
- lodgementDate
- maturityDate
- maturityInstructions
type: object
properties:
lodgementDate:
type: string
description: The lodgement date of the original deposit.
x-cds-type: DateString
maturityDate:
type: string
description: Maturity date for the term deposit.
x-cds-type: DateString
maturityAmount:
type: string
description: Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated.
x-cds-type: AmountString
maturityCurrency:
type: string
description: If absent assumes `AUD`.
default: AUD
x-cds-type: CurrencyString
maturityInstructions:
type: string
description: Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments.
enum:
- HOLD_ON_MATURITY
- PAID_OUT_AT_MATURITY
- ROLLED_OVER
BankingFeeRange:
type: object
description: A minimum or maximum fee amount where a specific fixed amount is not known until the fee is incurred.
properties:
feeMinimum:
type: string
description: The minimum fee that will be charged per occurrence.
x-cds-type: AmountString
feeMaximum:
type: string
description: The maximum fee that will be charged per occurrence.
x-cds-type: AmountString
ResponseErrorListV2:
type: object
required:
- errors
properties:
errors:
description: List of errors.
type: array
items:
$ref: '#/components/schemas/ErrorV2'
BankingProductDiscountEligibility:
required:
- discountEligibilityType
type: object
properties:
discountEligibilityType:
type: string
description: The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc).
enum:
- BUSINESS
- EMPLOYMENT_STATUS
- INTRODUCTORY
- MAX_AGE
- MIN_AGE
- MIN_INCOME
- MIN_TURNOVER
- NATURAL_PERSON
- OTHER
- PENSION_RECIPIENT
- RESIDENCY_STATUS
- STAFF
- STUDENT
additionalValue:
type: string
description: Generic field containing additional information relevant to the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc).
additionalInfo:
type: string
description: Display text providing more information on this eligibility constraint. Mandatory if the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) value is `OTHER`.
additionalInfoUri:
type: string
description: Link to a web page with more information on this eligibility constraint.
x-cds-type: URIString
x-conditional:
- additionalInfo
- additionalValue
BankingProductDepositRateV2:
required:
- depositRateType
- rate
- applicationType
type: object
properties:
depositRateType:
type: string
description: The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc.) For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc).
enum:
- BONUS
- BUNDLE_BONUS
- FIXED
- FLOATING
- INTRODUCTORY
- MARKET_LINKED
- VARIABLE
example: VARIABLE
rate:
type: string
description: The rate to be applied.
x-cds-type: RateString
calculationFrequency:
type: string
description: The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).
x-cds-type: ExternalRef
applicationType:
type: string
description: The type of approach used to apply the rate to the account.
enum:
- MATURITY
- PERIODIC
- UPFRONT
example: PERIODIC
applicationFrequency:
type: string
description: The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Mandatory if the _applicationType_ value is `PERIODIC`.
x-cds-type: ExternalRef
tiers:
type: array
description: Qualifying criteria or conditions relevant to the associated rate.
items:
$ref: '#/components/schemas/BankingProductRateTierV4'
applicabilityConditions:
type: array
description: Applicability conditions for the rate.
items:
$ref: '#/components/schemas/BankingProductRateConditionV2'
additionalValue:
type: string
description: Generic field containing additional information relevant to the [_depositRateType_](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [_depositRateType_](#tocSproductdepositratetypedoc).
additionalInfo:
type: string
description: Display text providing more information on the rate.
additionalInfoUri:
type: string
description: Link to a web page with more information on this rate.
x-cds-type: URIString
x-conditional:
- additionalValue
- applicationFrequency
BankingProductInstalments:
description: Details of instalment features on the account.
required:
- minimumSplit
- maximumSplit
type: object
properties:
maximumConcurrentPlans:
type: integer
description: Maximum number of concurrent active instalment plans that may be created on the account. If `null`, there is no predetermined maximum number.
x-cds-type: NaturalNumber
instalmentsLimit:
type: string
description: 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.
x-cds-type: AmountString
minimumPlanValue:
type: string
description: Minimum value that can be opened as an instalment plan.
x-cds-type: AmountString
maximumPlanValue:
type: string
description: 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.
x-cds-type: AmountString
minimumSplit:
type: integer
description: Minimum number of instalment payments a plan can be created with.
x-cds-type: PositiveInteger
example: 4
maximumSplit:
type: integer
description: Maximum number of instalment payments a plan can be created with.
x-cds-type: PositiveInteger
example: 4
LinksPaginated:
required:
- self
type: object
properties:
self:
type: string
description: Fully qualified link that generated the current response document.
x-cds-type: URIString
first:
type: string
description: URI to the first page of this set. Mandatory if this response is not the first page.
x-cds-type: URIString
prev:
type: string
description: URI to the previous page of this set. Mandatory if this response is not the first page.
x-cds-type: URIString
next:
type: string
description: URI to the next page of this set. Mandatory if this response is not the last page.
x-cds-type: URIString
last:
type: string
description: URI to the last page of this set. Mandatory if this response is not the last page.
x-cds-type: URIString
x-conditional:
- prev
- next
- first
- last
BankingAccountDetailV5:
allOf:
- $ref: '#/components/schemas/BankingAccountV3'
- type: object
properties:
bsb:
type: string
description: The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
accountNumber:
type: string
description: The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
bundleName:
type: string
description: Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.
instalments:
$ref: '#/components/schemas/BankingProductInstalments'
specificAccountUType:
type: string
description: The type of structure to present account specific fields.
enum:
- creditCard
- loan
- termDeposit
termDeposit:
type: array
description: Mandatory if the _specificAccountUType_ value is `termDeposit`.
items:
$ref: '#/components/schemas/BankingTermDepositAccount'
creditCard:
description: Mandatory if the _specificAccountUType_ value is `creditCard`.
allOf:
- $ref: '#/components/schemas/BankingCreditCardAccount'
loan:
description: Mandatory if the _specificAccountUType_ value is `loan`.
allOf:
- $ref: '#/components/schemas/BankingLoanAccountV3'
depositRate:
type: string
description: Current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call.
x-cds-type: RateString
lendingRate:
type: string
description: The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.
x-cds-type: RateString
depositRates:
type: array
description: Fully described deposit rates for this account based on the equivalent structure in Product Reference.
items:
$ref: '#/components/schemas/BankingProductDepositRateV2'
lendingRates:
type: array
description: Fully described lending rates for this account based on the equivalent structure in Product Reference.
items:
$ref: '#/components/schemas/BankingProductLendingRateV3'
features:
type: array
description: Array of features of the account based on the equivalent structure in Product Reference with the following additional field.
items:
type: object
allOf:
- $ref: '#/components/schemas/BankingProductFeatureV4'
- type: object
properties:
isActivated:
type: string
description: <ul><li>`ACTIVATED` if the feature has been activated by the customer or is a standard feature of the product</li><li>`NOT_ACTIVATED` if the feature is not activated but is available for activation</li><li>`UNKNOWN` or absent if the activation state is unknown.</ul>**Note:** This is an additional field appended to the feature structure defined in the Product Reference payload.
enum:
- ACTIVATED
- NOT_ACTIVATED
- UNK
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ing-australia/refs/heads/main/openapi/ing-australia-banking-accounts-api-openapi.yml