openbankingproject-ch / obp-apis

OpenBankingProject.ch Community APIs
http://www.OpenBankingProject.ch
Creative Commons Attribution 4.0 International
24 stars 6 forks source link

Description of transactionCurrency #31

Closed yves-bussard closed 3 years ago

yves-bussard commented 3 years ago

In the description for the Model paymentInitiation_json we have a table which defines for each property, whether it is mandatory or not (depending on the payment type).

While the name of the property in the model is transactionCurrency the table include this property as currencyOfTransfer. Please rename the name in the table from currencyOfTransfer to transactionCurrency (do not rename the property).

The currencyOfTransfer references Footnote 1) in some columns. There is also a footnote 7) whose text refers to this property but it is never used. I don't know which footnote would be correct for this property: 1? 7? 1 AND 7?

If 7) is not used, then please remove it. If it is used then rename the property in the footnote too.

NOTE: There is a corresponding table in periodic payments and bulk payments. Please apply the above corrections to ALL 3 tables and footnotes.

blehers commented 3 years ago

Source of inaccuracy can also be found in the documents of Berlin Group.

In the SIX Swiss Payment Standards Version 1.11 19.11.2021 "currencyOfTransfer" is used. grafik

I therefore suggest to use "currencyOfTransfer" throughout and adapt the API accordingly.

yves-bussard commented 3 years ago

I'm not really convinced. Throughouot the yaml file, Berlin Group uses the name transactionCurrency consistently, even in descriptions: image

It is probably not possible to predict whether they are going to change the code (yaml file) according to the documentation or the documentation according to the code. If we go ahead and change the code (property name) then we change the API. If we change the description, the API remains the same and we just fixed a typo. Besides we stay more in line with PSD2.

Therefore I suggest we use transactionCurrency until Berlin Group changes it in the code.

wishopt commented 3 years ago

Closed, as this change has been merged to the master branch.