Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/racq-bank-banking-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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 Specification
openapi: 3.2.0
info:
contact:
email: contact@dsb.gov.au
name: Data Standards Body
url: https://dsb.gov.au/
description: Specifications for resource endpoints applicable to data holders in the Banking sector.
license:
name: MIT License
url: https://opensource.org/licenses/MIT
title: CDR Banking Banking Account Balances Banking Accounts API
version: 1.36.0
servers:
- description: MTLS
url: https://mtls.dh.example.com/cds-au/v1
tags:
- description: Banking Account endpoints
name: Banking Accounts
x-shortName: Accounts
paths:
/banking/accounts:
get:
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:
- description: Used to filter results on the _productCategory_ field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.
explode: true
in: query
name: product-category
required: false
schema:
$ref: '#/components/schemas/BankingProductCategoryV2'
style: form
- description: Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed.
explode: true
in: query
name: open-status
required: false
schema:
default: ALL
enum:
- ALL
- CLOSED
- OPEN
type: string
style: form
- description: Filters accounts based on whether they are owned by the authorised customer. `true` for owned accounts, `false` for unowned accounts and absent for all accounts.
explode: true
in: query
name: is-owned
required: false
schema:
type: boolean
style: form
- description: Page of results to request (standard pagination).
explode: true
in: query
name: page
required: false
schema:
default: 1
type: integer
style: form
x-cds-type: PositiveInteger
- description: Page size to request. Default is 25 (standard pagination).
explode: true
in: query
name: page-size
required: false
schema:
default: 25
type: integer
style: form
x-cds-type: PositiveInteger
- 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).
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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`.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder **MUST** play back this value in the _x-fapi-interaction-id_ response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
style: simple
x-conditional: true
- description: The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
style: simple
x-conditional: true
x-cds-type: Base64
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountListV3'
description: Successful response
headers:
x-v:
$ref: '#/components/headers/XV'
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
summary: Get Accounts
tags:
- Banking Accounts
x-scopes:
- bank:accounts.basic:read
x-version: '3'
/banking/accounts/{accountId}:
get:
description: 'Obtain detailed information on a single account.
Obsolete versions: [v1](includes/obsolete/get-account-detail-v1.html), [v2](includes/obsolete/get-account-detail-v2.html), [v3](includes/obsolete/get-account-detail-v3.html), [v4](includes/obsolete/get-account-detail-v4.html).'
operationId: getBankingAccountDetail
parameters:
- description: The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints.
explode: false
in: path
name: accountId
required: true
schema:
$ref: '#/components/schemas/BankingAccountId'
style: simple
- 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).
explode: false
in: header
name: x-v
required: true
schema:
type: string
style: simple
- 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`.
explode: false
in: header
name: x-min-v
required: false
schema:
type: string
style: simple
- description: An **[[RFC4122]](#nref-RFC4122)** UUID used as a correlation id. If provided, the data holder **MUST** play back this value in the _x-fapi-interaction-id_ response header. If not provided a **[[RFC4122]](#nref-RFC4122)** UUID value is required to be provided in the response header to track the interaction.
explode: false
in: header
name: x-fapi-interaction-id
required: false
schema:
type: string
style: simple
- description: The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-1.0-Baseline]](#nref-FAPI-1-0-Baseline)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
explode: false
in: header
name: x-fapi-auth-date
required: false
schema:
type: string
style: simple
x-conditional: true
- description: The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
explode: false
in: header
name: x-fapi-customer-ip-address
required: false
schema:
type: string
style: simple
- description: The customer's original standard http headers [Base64](#common-field-types) encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.
explode: false
in: header
name: x-cds-client-headers
required: false
schema:
type: string
style: simple
x-conditional: true
x-cds-type: Base64
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBankingAccountByIdV5'
description: Successful response
headers:
x-v:
$ref: '#/components/headers/XV'
x-fapi-interaction-id:
$ref: '#/components/headers/XFAPIInteractionId'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorListV2'
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'
summary: Get Account Detail
tags:
- Banking Accounts
x-scopes:
- bank:accounts.detail:read
x-version: '5'
components:
schemas:
BankingProductDiscountEligibility:
properties:
discountEligibilityType:
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
type: string
additionalValue:
description: Generic field containing additional information relevant to the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc).
type: string
additionalInfo:
description: Display text providing more information on this eligibility constraint. Mandatory if the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) value is `OTHER`.
type: string
additionalInfoUri:
description: Link to a web page with more information on this eligibility constraint.
type: string
x-cds-type: URIString
required:
- discountEligibilityType
type: object
x-conditional:
- additionalInfo
- additionalValue
BankingProductFeatureV4:
properties:
featureType:
description: The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc).
enum:
- ADDITIONAL_CARDS
- BALANCE_TRANSFERS
- BILL_PAYMENT
- BONUS_REWARDS
- CARD_ACCESS
- CASHBACK_OFFER
- COMPLEMENTARY_PRODUCT_DISCOUNTS
- EXTRA_DOWN_PAYMENT
- DIGITAL_BANKING
- DIGITAL_WALLET
- DONATE_INTEREST
- EXTRA_REPAYMENTS
- FRAUD_PROTECTION
- FREE_TXNS
- FREE_TXNS_ALLOWANCE
- FUNDS_AVAILABLE_AFTER
- GUARANTOR
- INSTALMENT_PLAN
- INSURANCE
- INTEREST_FREE
- INTEREST_FREE_TRANSFERS
- LOYALTY_PROGRAM
- NOTIFICATIONS
- NPP_ENABLED
- NPP_PAYID
- OFFSET
- OTHER
- OVERDRAFT
- REDRAW
- RELATIONSHIP_MANAGEMENT
- UNLIMITED_TXNS
type: string
additionalValue:
description: Generic field containing additional information relevant to the [_featureType_](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [_featureType_](#tocSproductfeaturetypedoc).
type: string
additionalInfo:
description: Display text providing more information on the feature. Mandatory if the [_featureType_](#tocSproductfeaturetypedoc) value is `OTHER`.
type: string
additionalInfoUri:
description: Link to a web page with more information on this feature.
type: string
x-cds-type: URIString
required:
- featureType
type: object
x-conditional:
- additionalValue
- additionalInfo
BankingTermDepositAccount:
properties:
lodgementDate:
description: The lodgement date of the original deposit.
type: string
x-cds-type: DateString
maturityDate:
description: Maturity date for the term deposit.
type: string
x-cds-type: DateString
maturityAmount:
description: Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated.
type: string
x-cds-type: AmountString
maturityCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
maturityInstructions:
description: Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments.
enum:
- HOLD_ON_MATURITY
- PAID_OUT_AT_MATURITY
- ROLLED_OVER
type: string
required:
- lodgementDate
- maturityDate
- maturityInstructions
type: object
BankingAccountDetailV5_allOf:
properties:
bsb:
description: The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
type: string
accountNumber:
description: The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces.
type: string
bundleName:
description: Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer.
type: string
instalments:
$ref: '#/components/schemas/BankingProductInstalments'
specificAccountUType:
description: The type of structure to present account specific fields.
enum:
- creditCard
- loan
- termDeposit
type: string
termDeposit:
description: Mandatory if the _specificAccountUType_ value is `termDeposit`.
items:
$ref: '#/components/schemas/BankingTermDepositAccount'
type: array
creditCard:
allOf:
- $ref: '#/components/schemas/BankingCreditCardAccount'
description: Mandatory if the _specificAccountUType_ value is `creditCard`.
loan:
allOf:
- $ref: '#/components/schemas/BankingLoanAccountV3'
description: Mandatory if the _specificAccountUType_ value is `loan`.
depositRate:
description: Current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call.
type: string
x-cds-type: RateString
lendingRate:
description: The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call.
type: string
x-cds-type: RateString
depositRates:
description: Fully described deposit rates for this account based on the equivalent structure in Product Reference.
items:
$ref: '#/components/schemas/BankingProductDepositRateV2'
type: array
lendingRates:
description: Fully described lending rates for this account based on the equivalent structure in Product Reference.
items:
$ref: '#/components/schemas/BankingProductLendingRateV3'
type: array
features:
description: Array of features of the account based on the equivalent structure in Product Reference with the following additional field.
items:
allOf:
- $ref: '#/components/schemas/BankingProductFeatureV4'
- properties:
isActivated:
default: UNKNOWN
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
- UNKNOWN
type: string
type: object
type: object
type: array
fees:
description: Fees and charges applicable to the account based on the equivalent structure in Product Reference.
items:
$ref: '#/components/schemas/BankingProductFeeV2'
type: array
addresses:
description: The addresses for the account to be used for correspondence.
items:
$ref: '#/components/schemas/CommonPhysicalAddress'
type: array
type: object
x-conditional:
- termDeposit
- creditCard
- loan
BankingProductCategoryV2:
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
type: string
BankingFeeDiscountRate:
properties:
rateType:
description: Type of fee rate discount calculation.<ul><li>`BALANCE` A fee rate discount based on a balance</li><li>`FEE` A fee rate discount based on the fee to which the discount is attached</li><li>`INTEREST_ACCRUED` A fee rate discount based on interest accrued</li><li>`TRANSACTION` A fee rate discount based on a transaction.</li></ul>
enum:
- BALANCE
- FEE
- INTEREST_ACCRUED
- TRANSACTION
type: string
rate:
description: The fee rate discount calculated according to the _rateType_.
type: string
x-cds-type: RateString
amountRange:
$ref: '#/components/schemas/BankingFeeDiscountRange'
required:
- rate
- rateType
type: object
CommonPAFAddress:
description: Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). Mandatory if the _addressUType_ value is `paf`.
properties:
dpid:
description: Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier.
type: string
thoroughfareNumber1:
description: Thoroughfare number for a property (first number in a property ranged address).
type: integer
x-cds-type: PositiveInteger
thoroughfareNumber1Suffix:
description: Suffix for the thoroughfare number. Only relevant if _thoroughfareNumber1_ is populated.
type: string
thoroughfareNumber2:
description: Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25).
type: integer
x-cds-type: PositiveInteger
thoroughfareNumber2Suffix:
description: Suffix for the second thoroughfare number. Only relevant if _thoroughfareNumber2_ is populated.
type: string
flatUnitType:
description: Type of flat or unit for the address.
type: string
flatUnitNumber:
description: Unit number (including suffix, if applicable).
type: string
floorLevelType:
description: Type of floor or level for the address.
type: string
floorLevelNumber:
description: Floor or level number (including alpha characters).
type: string
lotNumber:
description: Allotment number for the address.
type: string
buildingName1:
description: Building/Property name 1.
type: string
buildingName2:
description: Building/Property name 2.
type: string
streetName:
description: The name of the street.
type: string
streetType:
description: The street type. Valid enumeration defined by Australia Post PAF code file.
type: string
streetSuffix:
description: The street type suffix. Valid enumeration defined by Australia Post PAF code file.
type: string
postalDeliveryType:
description: Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file.
type: string
postalDeliveryNumber:
description: Postal delivery number if the address is a postal delivery type.
type: integer
x-cds-type: PositiveInteger
postalDeliveryNumberPrefix:
description: Postal delivery number prefix related to the postal delivery number.
type: string
postalDeliveryNumberSuffix:
description: Postal delivery number suffix related to the postal delivery number.
type: string
localityName:
description: Full name of locality.
type: string
postcode:
description: Postcode for the locality.
type: string
state:
description: State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`.
type: string
required:
- localityName
- postcode
- state
type: object
LinksPaginated:
properties:
self:
description: Fully qualified link that generated the current response document.
type: string
x-cds-type: URIString
first:
description: URI to the first page of this set. Mandatory if this response is not the first page.
type: string
x-cds-type: URIString
prev:
description: URI to the previous page of this set. Mandatory if this response is not the first page.
type: string
x-cds-type: URIString
next:
description: URI to the next page of this set. Mandatory if this response is not the last page.
type: string
x-cds-type: URIString
last:
description: URI to the last page of this set. Mandatory if this response is not the last page.
type: string
x-cds-type: URIString
required:
- self
type: object
x-conditional:
- prev
- next
- first
- last
BankingProductInstalments:
description: Details of instalment features on the account.
properties:
maximumConcurrentPlans:
description: Maximum number of concurrent active instalment plans that may be created on the account. If `null`, there is no predetermined maximum number.
type: integer
x-cds-type: NaturalNumber
instalmentsLimit:
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.
type: string
x-cds-type: AmountString
minimumPlanValue:
description: Minimum value that can be opened as an instalment plan.
type: string
x-cds-type: AmountString
maximumPlanValue:
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.
type: string
x-cds-type: AmountString
minimumSplit:
description: Minimum number of instalment payments a plan can be created with.
example: 4
type: integer
x-cds-type: PositiveInteger
maximumSplit:
description: Maximum number of instalment payments a plan can be created with.
example: 4
type: integer
x-cds-type: PositiveInteger
required:
- maximumSplit
- minimumSplit
type: object
BankingCreditCardAccount:
properties:
minPaymentAmount:
description: The minimum payment amount due for the next card payment.
type: string
x-cds-type: AmountString
paymentDueAmount:
description: The amount due for the next card payment.
type: string
x-cds-type: AmountString
paymentCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
paymentDueDate:
description: Date that the next payment for the card is due.
type: string
x-cds-type: DateString
required:
- minPaymentAmount
- paymentDueAmount
- paymentDueDate
type: object
BankingAccountDetailV5:
allOf:
- $ref: '#/components/schemas/BankingAccountV3'
- $ref: '#/components/schemas/BankingAccountDetailV5_allOf'
BankingProductRateConditionV2:
description: Defines a condition for the applicability of a rate.
properties:
rateApplicabilityType:
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
type: string
additionalValue:
description: Generic field containing additional information relevant to the _rateApplicabilityType_ specified. Whether mandatory or not is dependent on the value of [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc).
type: string
additionalInfo:
description: Display text providing more information on the condition. Mandatory if the [_rateApplicabilityType_](#tocSbankingproductrateconditiondoc) value is `OTHER`.
type: string
additionalInfoUri:
description: Link to a web page with more information on this condition.
type: string
x-cds-type: URIString
required:
- rateApplicabilityType
type: object
x-conditional:
- additionalValue
- additionalInfo
BankingAccountId:
description: A unique identifier for a Banking account, generated according to [CDR ID Permanence](#id-permanence) requirements.
type: stri
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/racq-bank/refs/heads/main/openapi/racq-bank-banking-accounts-api-openapi.yml