diff options
Diffstat (limited to 'core/api-bank-conversion-info.rst')
| -rw-r--r-- | core/api-bank-conversion-info.rst | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/core/api-bank-conversion-info.rst b/core/api-bank-conversion-info.rst index 834cac46..322e9403 100644 --- a/core/api-bank-conversion-info.rst +++ b/core/api-bank-conversion-info.rst @@ -48,10 +48,14 @@ is used by wallets for withdrawals that involve a currency conversion. // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning // The format is "current:revision:age". version: string; - + // Name of the API. name: "taler-conversion-info"; + // URN of the implementation (needed to interpret 'revision' in version). + // @since v4, may become mandatory in the future. + implementation?: string; + // Currency used by this bank. regional_currency: string; @@ -65,9 +69,9 @@ is used by wallets for withdrawals that involve a currency conversion. fiat_currency_specification: CurrencySpecification; // Additional information on conversion rates. - // Those informations should never be used to perform conversions, + // Those informations should never be used to perform conversions, // use /cashin-rate or /cashout-rate instead. - // Conversion rates can change at any time. Clients must deal with + // Conversion rates can change at any time. Clients must deal with // any resulting errors and call /cashin-rate or /cashout-rate again // to use the new rates. conversion_rate: ConversionRate; @@ -91,7 +95,7 @@ is used by wallets for withdrawals that involve a currency conversion. deducted from their fiat bank account. or - + :query amount_credit: this is the amount that the user will receive in their regional bank account. @@ -100,7 +104,7 @@ is used by wallets for withdrawals that involve a currency conversion. :http:statuscode:`200 OK`: Response is a `CashinConversionResponse`. :http:statuscode:`400 Bad request`: - * ``TALER_EC_GENERIC_PARAMETER_MISSING`` : none of the parameters have been provided. + * ``TALER_EC_GENERIC_PARAMETER_MISSING`` : none of the parameters have been provided. * ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` : both of the parameters have been provided or one of them is not a valid Taler amount. * ``TALER_EC_GENERIC_CURRENCY_MISMATCH`` : the parameter is in the wrong currency. :http:statuscode:`409 Conflict`: @@ -137,7 +141,7 @@ is used by wallets for withdrawals that involve a currency conversion. deducted from their regional bank account. or - + :query amount_credit: this is the amount that the user will receive in their fiat bank account. @@ -146,7 +150,7 @@ is used by wallets for withdrawals that involve a currency conversion. :http:statuscode:`200 OK`: Response is a `CashoutConversionResponse`. :http:statuscode:`400 Bad request`: - * ``TALER_EC_GENERIC_PARAMETER_MISSING`` : none of the parameters have been provided. + * ``TALER_EC_GENERIC_PARAMETER_MISSING`` : none of the parameters have been provided. * ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` : both of the parameters have been provided or one of them is not a valid Taler amount. * ``TALER_EC_GENERIC_CURRENCY_MISMATCH`` : the parameter is in the wrong currency. :http:statuscode:`409 Conflict`: @@ -169,17 +173,17 @@ is used by wallets for withdrawals that involve a currency conversion. .. http:post:: /conversion-rate - This endpoint allows the administrator to update + This endpoint allows the administrator to update the exchange rate between the regional currency and the fiat currency of the banking system. **Request:** .. ts:def:: ConversionRate - + interface ConversionRate { // Exchange rate to buy regional currency from fiat - cashin_ratio: DecimalNumber; + cashin_ratio: DecimalNumber; // Regional amount fee to subtract after applying the cashin ratio. cashin_fee: Amount; @@ -194,7 +198,7 @@ is used by wallets for withdrawals that involve a currency conversion. cashin_rounding_mode: "zero" | "up" | "nearest"; // Exchange rate to sell regional currency for fiat - cashout_ratio: DecimalNumber; + cashout_ratio: DecimalNumber; // Fiat amount fee to subtract after applying the cashout ratio. cashout_fee: Amount; |