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/move-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:
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
ResponseBankingAccountListV3:
properties:
data:
$ref: '#/components/schemas/ResponseBankingAccountListV3_data'
links:
$ref: '#/components/schemas/LinksPaginated'
meta:
$ref: '#/components/schemas/MetaPaginated'
required:
- data
- links
- meta
type: object
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
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
BankingProductLendingRateV3:
properties:
lendingRateType:
description: The type of rate (`FIXED`, `VARIABLE`, etc.) For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc).
enum:
- BALANCE_TRANSFER
- BUNDLE_DISCOUNT_FIXED
- BUNDLE_DISCOUNT_VARIABLE
- CASH_ADVANCE
- DISCOUNT
- FIXED
- FLOATING
- INTRODUCTORY
- MARKET_LINKED
- PENALTY
- PURCHASE
- VARIABLE
example: FIXED
type: string
rate:
description: The rate to be applied.
type: string
x-cds-type: RateString
comparisonRate:
description: A comparison rate equivalent for this rate.
type: string
x-cds-type: RateString
calculationFrequency:
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).
type: string
x-cds-type: ExternalRef
applicationType:
description: The type of approach used to apply the rate to the account.
enum:
- MATURITY
- PERIODIC
- UPFRONT
example: PERIODIC
type: string
applicationFrequency:
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`.
type: string
x-cds-type: ExternalRef
interestPaymentDue:
description: When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered.
enum:
- IN_ADVANCE
- IN_ARREARS
type: string
repaymentType:
description: Option in place for repayments.
enum:
- INTEREST_ONLY
- OTHER
- PRINCIPAL_AND_INTEREST
- UNCONSTRAINED
type: string
loanPurpose:
description: The reason for taking out the loan.
enum:
- INVESTMENT
- OTHER
- OWNER_OCCUPIED
- UNCONSTRAINED
type: string
tiers:
description: Qualifying criteria or conditions relevant to the associated rate.
items:
$ref: '#/components/schemas/BankingProductRateTierV4'
type: array
applicabilityConditions:
description: Applicability conditions for the rate.
items:
$ref: '#/components/schemas/BankingProductRateConditionV2'
type: array
additionalValue:
description: Generic field containing additional information relevant to the [_lendingRateType_](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [_lendingRateType_](#tocSproductlendingratetypedoc).
type: string
additionalInfo:
description: Display text providing more information on the rate.
type: string
additionalInfoUri:
description: Link to a web page with more information on this rate.
type: string
x-cds-type: URIString
required:
- applicationType
- lendingRateType
- loanPurpose
- rate
- repaymentType
type: object
x-conditional:
- additionalValue
- applicationFrequency
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
BankingFeeRate:
properties:
rateType:
description: Type of fee rate calculation.<ul><li>`BALANCE` A fee rate based on a balance</li><li>`INTEREST_ACCRUED` A fee rate based on interest accrued</li><li>`TRANSACTION` A fee rate based on a transaction.</li></ul>
enum:
- BALANCE
- INTEREST_ACCRUED
- TRANSACTION
type: string
rate:
description: The fee rate calculated according to the _rateType_.
type: string
x-cds-type: RateString
accrualFrequency:
description: The indicative frequency with which the fee is calculated on the account if applicable. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).
type: string
x-cds-type: ExternalRef
amountRange:
$ref: '#/components/schemas/BankingFeeRange'
required:
- rate
- rateType
type: object
x-conditional:
- balanceRate
- transactionRate
- accruedRate
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
BankingLoanAccountV3:
properties:
originalStartDate:
description: Optional original start date for the loan.
type: string
x-cds-type: DateString
originalLoanAmount:
description: Optional original loan value.
type: string
x-cds-type: AmountString
originalLoanCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
loanEndDate:
description: Date that the loan is due to be repaid in full.
type: string
x-cds-type: DateString
nextInstalmentDate:
description: Next date that an instalment is required.
type: string
x-cds-type: DateString
minInstalmentAmount:
description: Minimum amount of next instalment.
type: string
x-cds-type: AmountString
minInstalmentCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
maxRedraw:
description: Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account.
type: string
x-cds-type: AmountString
maxRedrawCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
minRedraw:
description: Minimum redraw amount.
type: string
x-cds-type: AmountString
minRedrawCurrency:
default: AUD
description: If absent assumes `AUD`.
type: string
x-cds-type: CurrencyString
offsetAccountEnabled:
description: Set to `true` if one or more offset accounts are configured for this loan account.
type: boolean
offsetAccountIds:
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'
type: array
repaymentType:
description: Option in place for repayments.
enum:
- INTEREST_ONLY
- OTHER
- PRINCIPAL_AND_INTEREST
- UNCONSTRAINED
type: string
repaymentFrequency:
description: The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).
type: string
x-cds-type: ExternalRef
required:
- repaymentType
type: object
BankingFeeAmount:
properties:
amount:
description: The specific amount charged for the fee each time it is incurred.
type: string
x-cds-type: AmountString
required:
- amount
type: object
BankingProductFeeV2:
properties:
name:
description: Name of the fee.
type: string
feeType:
description: The type of fee. For further details, refer to [Product Fee Types](#tocSproductfeetypedoc).
enum:
- CASH_ADVANCE
- DEPOSIT
- DISHONOUR
- ENQUIRY
- EVENT
- EXIT
- LATE_PAYMENT
- OTHER
- PAYMENT
- PERIODIC
- PURCHASE
- REPLACEMENT
- TRANSACTION
- UPFRONT
- UPFRONT_PER_PLAN
- VARIATION
- WITHDRAWAL
example: CASH_ADVANCE
type: string
feeMethodUType:
description: Reference to the applicable fee charging method structure.
enum:
- fixedAmount
- rateBased
- variable
type: string
fixedAmount:
allOf:
- $ref: '#/components/schemas/BankingFeeAmount'
description: Mandatory if the _feeMethodUType_ value is `fixedAmount`. Where the fee is a specific amount.
rateBased:
allOf:
- $ref: '#/components/schemas/BankingFeeRate'
description: Mandatory if the _feeMethodUType_ value is `rateBased`. Where the fee is based on a type of rate.
variable:
allOf:
- $ref: '#/components/schemas/BankingFeeRange'
description: Mandatory if the _feeMethodUType_ value is `variable`. Where the amount or rate may not be known until the fee is incurred.
feeCap:
description: The cap amount if multiple occurrences of the fee are capped to a limit.
type: string
x-cds-type: AmountString
feeCapPeriod:
description: Specifies a duration over which multiple occurrences of the fee will be capped. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).
type: string
x-cds-type: ExternalRef
currency:
default: AUD
description: The currency the fee will be charged in. Assumes `AUD` if absent.
type: string
x-cds-type: CurrencyString
additionalValue:
description: Generic field containing additional information relevant to the [_feeType_](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [_feeType_](#tocSproductfeetypedoc).
type: string
additionalInfo:
description: Display text providing more information on the fee. Mandatory if the [_feeType_](#tocSproductfeetypedoc) value is `OTHER`.
type: string
additionalInfoUri:
description: Link to a web page with more information on this fee.
type: string
x-cds-type: URIString
discounts:
description: An optional list of discounts to this fee that may be available.
items:
$ref: '#/components/schemas/BankingProductDiscountV2'
type: array
required:
- feeMethodUType
- feeType
- name
type: object
x-conditional:
- fixedAmount
- rateBased
- variable
- additionalValue
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/move-bank/refs/heads/main/openapi/move-bank-banking-accounts-api-openapi.yml