taler-docs

commit dcce2185ad430a33d6dd5c1aab232ee21b8161e1
parent 52d0c23f9276c5e08e9c4ab75ac2713bdfcfb416
Author: MS <ms@taler.net>
Date:   Wed, 14 Dec 2022 16:21:12 +0100

circuit API: patch accounts.

Diffstat:
M
libeufin/api-sandbox.rst
 | 
39
++++++++++++++++++++++++++++++++++++++-

1 file changed, 38 insertions(+), 1 deletion(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
@@ -37,6 +37,9 @@ For brevity, the list of response statuses for each endpoint may not be exhausti
 
 The following endpoints are served under ``/demobanks/default/circuit-api``.
 
+Accounts
+--------
+
 .. http:post:: /accounts
 
    Create a new bank account.  Only the administrator is allowed.
@@ -119,7 +122,38 @@ The following endpoints are served under ``/demobanks/default/circuit-api``.
   :http:statuscode:`412 Precondition failed`:
     The balance was not zero.
 
-.. _customer-password-modification:
+
+.. http:patch:: /accounts/$username
+
+   Allows the administrator and the user to reconfigure
+   the account data of ``$username``.
+
+   **Request:**
+
+   .. ts:def:: CircuitAccountReconfiguration
+     
+     interface CircuitAccountReconfiguration {
+
+       // Addresses where to send the TAN.  If
+       // this field is missing, then the cashout
+       // won't succeed.
+       contact_data?: CircuitContactData;
+
+       // 'payto' address pointing the bank account
+       // where to send payments, in case the user
+       // wants to convert the local currency back
+       // to fiat.
+       cashout_address: string;
+     }
+
+   **Response:**
+
+   :http:statuscode:`204 No content`:
+     Operation successful.
+
+   :http:statuscode:`404 Not found`:
+     The account pointed by ``$username``
+     was not found.
 
 .. http:patch:: /accounts/$username/auth
 
@@ -205,6 +239,9 @@ The following endpoints are served under ``/demobanks/default/circuit-api``.
    :http:statuscode:`403 Forbidden`:
      Unallowed user tried the operation.
 
+Cashouts
+--------
+
 .. http:post:: /cashouts
 
    Initiates a conversion to fiat currency.  The target account