update core-bank api for per account cashout minimum amount

2 files changed, 51 insertions, 27 deletions

diff --git a/core/api-bank-conversion-info.rst b/core/api-bank-conversion-info.rst
index 322e9403..63856142 100644
--- a/core/api-bank-conversion-info.rst
+++ b/core/api-bank-conversion-info.rst
@@ -108,7 +108,7 @@ is used by wallets for withdrawals that involve a currency conversion.
     * ``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`:
-    The amount is too small to be converted, either because it produces produce an amount less than zero, or because the server requires a higher minimum amount than that supplied.
+    The amount is too small to be converted because it produces an amount less than zero.
   :http:statuscode:`501 Not implemented`:
     This server does not support conversion, client should check config response.
 
@@ -154,7 +154,7 @@ is used by wallets for withdrawals that involve a currency conversion.
     * ``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`:
-    The amount is too small to be converted, either because it produces produce an amount less than zero, or because the server requires a higher minimum amount than that supplied.
+    The amount is too small to be converted because it produces an amount less than zero.
   :http:statuscode:`501 Not implemented`:
     This server does not support conversion, client should check config response.
 
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
index 4a0288a4..f9ab7caa 100644
--- a/core/api-corebank.rst
+++ b/core/api-corebank.rst
@@ -188,6 +188,11 @@ Account Management
       // Only admin can set this property.
       debit_threshold?: Amount;
 
+      // If present, set a custom minimum cashout amount for this account.
+      // Only admin can set this property
+      // @since v4
+      min_cashout?: Amount;
+
       // If present, enables 2FA and set the TAN channel used for challenges
       // Only admin can set this property, other user can reconfig their account
       // after creation.
@@ -220,6 +225,7 @@ Account Management
     * ``TALER_EC_BANK_UNALLOWED_DEBIT`` : admin account does not have sufficient funds to grant bonus.
     * ``TALER_EC_BANK_RESERVED_USERNAME_CONFLICT`` : a reserved username was attempted, like ``admin`` or ``bank``
     * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT`` : a non-admin user has tried to create an account with a customer debt limit.
+    * ``TALER_EC_BANK_NON_ADMIN_SET_MIN_CASHOUT`` : a non-admin user has tried to create an account with a custom min cashout amount.
     * ``TALER_EC_BANK_NON_ADMIN_SET_TAN_CHANNEL`` : a non-admin user has tried to create an account with 2fa.
     * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED``: ``tan_channel`` is not supported, check bank config to find supported ones.
     * ``TALER_EC_BANK_MISSING_TAN_INFO``: the user did not share any contact data where to send the TAN via ``tan_channel``.
@@ -233,28 +239,6 @@ Account Management
       internal_payto_uri: string;
     }
 
-.. _delete-account:
-
-.. http:delete:: /accounts/$USERNAME
-
-  Delete the account whose username is ``$USERNAME``.  The deletion
-  succeeds only if the balance is *zero*.  Typically only available to
-  the administrator, but can be configured to allow ordinary users too.
-
-  **Response:**
-
-  :http:statuscode:`202 Accepted`:
-    2FA is required for this operation. This returns the `Challenge` response.
-  :http:statuscode:`204 No content`:
-    The account was successfully deleted.
-  :http:statuscode:`401 Unauthorized`:
-    Invalid credentials or missing rights.
-  :http:statuscode:`404 Not found`:
-    The account pointed by ``$USERNAME`` was not found.
-  :http:statuscode:`409 Conflict`:
-    * ``TALER_EC_BANK_RESERVED_USERNAME_CONFLICT`` : a reserved username was attempted, like ``admin`` or ``bank``.
-    * ``TALER_EC_BANK_ACCOUNT_BALANCE_NOT_ZERO``: the account balance was not zero.
-
 .. _account-reconfig:
 
 .. http:patch:: /accounts/$USERNAME
@@ -288,6 +272,11 @@ Account Management
       // Only admin can change this property.
       debit_threshold?: Amount;
 
+      // If present, change the custom minimum cashout amount for this account.
+      // Only admin can set this property
+      // @since v4
+      min_cashout?: Amount;
+
       // If present, enables 2FA and set the TAN channel used for challenges
       tan_channel?: TanChannel;
     }
@@ -306,6 +295,7 @@ Account Management
     * ``TALER_EC_BANK_NON_ADMIN_PATCH_LEGAL_NAME`` : a non-admin user has tried to change their legal name.
     * ``TALER_EC_BANK_NON_ADMIN_PATCH_CASHOUT`` : a non-admin user has tried to change their cashout account.
     * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT`` : a non-admin user has tried to change their debt limit.
+    * ``TALER_EC_BANK_NON_ADMIN_SET_MIN_CASHOUT`` : a non-admin user has tried to change their custom min cashout amount.
     * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED`` : ``tan_channel`` is not supported, check bank config to find supported ones.
     * ``TALER_EC_BANK_MISSING_TAN_INFO`` : the user did not share any contact data where to send the TAN via ``tan_channel``.
 
@@ -343,6 +333,29 @@ Account Management
     * ``TALER_EC_BANK_NON_ADMIN_PATCH_MISSING_OLD_PASSWORD``: a non-admin user has tried to change their password whihout providing the current one.
     * ``TALER_EC_BANK_PATCH_BAD_OLD_PASSWORD`` : provided old password does not match current password.
 
+
+.. _delete-account:
+
+.. http:delete:: /accounts/$USERNAME
+
+  Delete the account whose username is ``$USERNAME``.  The deletion
+  succeeds only if the balance is *zero*.  Typically only available to
+  the administrator, but can be configured to allow ordinary users too.
+
+  **Response:**
+
+  :http:statuscode:`202 Accepted`:
+    2FA is required for this operation. This returns the `Challenge` response.
+  :http:statuscode:`204 No content`:
+    The account was successfully deleted.
+  :http:statuscode:`401 Unauthorized`:
+    Invalid credentials or missing rights.
+  :http:statuscode:`404 Not found`:
+    The account pointed by ``$USERNAME`` was not found.
+  :http:statuscode:`409 Conflict`:
+    * ``TALER_EC_BANK_RESERVED_USERNAME_CONFLICT`` : a reserved username was attempted, like ``admin`` or ``bank``.
+    * ``TALER_EC_BANK_ACCOUNT_BALANCE_NOT_ZERO``: the account balance was not zero.
+
 .. _account-list:
 
 .. http:get:: /public-accounts
@@ -460,6 +473,11 @@ Account Management
       // Number indicating the max debit allowed for the requesting user.
       debit_threshold: Amount;
 
+      // Custom minimum cashout amount for this account.
+      // If null or absent, the global conversion fee is used.
+      // @since v4
+      min_cashout?: Amount;
+
       // Is this account visible to anyone?
       is_public: boolean;
 
@@ -513,6 +531,11 @@ Account Management
       // Number indicating the max debit allowed for the requesting user.
       debit_threshold: Amount;
 
+      // Custom minimum cashout amount for this account.
+      // If null or absent, the global conversion fee is used.
+      // @since v4
+      min_cashout?: Amount;
+
       // Addresses where to send the TAN for transactions.
       // Currently only used for cashouts.
       // If missing, cashouts will fail.
@@ -883,9 +906,10 @@ Cashouts
     The account pointed by ``$USERNAME`` was not found.
   :http:statuscode:`409 Conflict`:
     * ``TALER_EC_BANK_TRANSFER_REQUEST_UID_REUSED``: an operation with the same ``request_uid`` but different details has been submitted before.
-    * ``TALER_EC_BANK_BAD_CONVERSION`` : exchange rate was calculated incorrectly by the client.
-    * ``TALER_EC_BANK_UNALLOWED_DEBIT`` : the account does not have sufficient funds.
-    * ``TALER_EC_BANK_CONFIRM_INCOMPLETE`` : the user did not share any cashout payto to uri where to wire funds.
+    * ``TALER_EC_BANK_BAD_CONVERSION``: exchange rate was calculated incorrectly by the client.
+    * ``TALER_EC_BANK_BANK_CONVERSION_AMOUNT_TO_SMALL``: the amount of the cashout is too small.
+    * ``TALER_EC_BANK_UNALLOWED_DEBIT``: the account does not have sufficient funds.
+    * ``TALER_EC_BANK_CONFIRM_INCOMPLETE``: the user did not share any cashout payto to uri where to wire funds.
   :http:statuscode:`501 Not Implemented`:
     * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED``: the chosen ``tan_channel`` is not currently supported.
     * This server does not support conversion, client should check config response.