ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Schemas missing currency field #594

Open nils-work opened 1 year ago

nils-work commented 1 year ago

Description

A number of schemas are missing a currency field to directly associate to an amount provided in an additionalValue or other 'amount' field. For accuracy and flexibility, these schemas may require a 'currency' field to be added.

Area Affected

Schemas in table below.

Change Proposed

Endpoint Schema Amount field Proposed currency field
Get Product Detail BankingProductConstraint additionalValue currency
Get Product Detail BankingProductEligibility additionalValue currency
Get Product Detail
Get Account Detail
Fees > BankingProductDiscount amount Although the discount amount is currently assumed to be in the same currency as the associated fee, this may not always be the case.
An amountCurrency field could assume the currency of the fee when absent.
Get Product Detail
Get Account Detail
Fees > BankingProductDiscount additionalValue additionalValueCurrency
Get Product Detail
Get Account Detail
Fees > BankingProductDiscountEligibility additionalValue currency
Get Direct Debits For Account
Get Bulk Direct Debits
• Get Direct Debits For Specific Accounts
BankingDirectDebit lastDebitAmount currency. May not be required if Direct Debits are always assumed to be AUD or match the currency of the account balance.
perlboy commented 11 months ago

Is there an identified need for this change? The addition of currency beside additionalValue fundamentally breaks the abstraction provided for the additional information. I question the point of doing the proposed change unless there's an identified product that needs to actively describe constraints & eligibility in a currency other than the base currency of the product.