taler-docs

commit 8ed22e0a292e8b0cfbcbb19d9dd138239b833027
parent fb9a9a8bce1e69af8bb20323811c4d4eb4a609b7
Author: Antoine A <>
Date:   Sat,  2 Dec 2023 00:46:11 +0000

Update corebank API

Diffstat:
M
core/api-corebank.rst
 | 
29
+++++++++++++++++++++++++++++

1 file changed, 29 insertions(+), 0 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -642,6 +642,16 @@ Taler Withdrawals
   Does not require further authentication as knowledge of ``WITHDRAWAL_ID``
   serves as an authenticator.
 
+  **Request:**
+
+  :query long_poll_ms:
+    *Optional.*  If specified, the bank will wait up to ``long_poll_ms``
+    milliseconds for operationt state to be different from ``old_state`` before sending the HTTP
+    response.  A client must never rely on this behavior, as the bank may
+    return a response immediately.
+  :query old_state:
+    *Optional.* Default to "pending".
+
   **Response:**
 
   :http:statuscode:`200 Ok`:
@@ -654,8 +664,27 @@ Taler Withdrawals
   .. ts:def:: WithdrawalPublicInfo
 
     interface WithdrawalPublicInfo {
+      // Current status of the operation
+      // pending: the operation is pending parameters selection (exchange and reserve public key)
+      // selected: the operations has been selected and is pending confirmation
+      // aborted: the operation has been aborted
+      // confirmed: the transfer has been confirmed and registered by the bank
+      status: "pending" | "selected" | "aborted" | "confirmed";
+
+      // Amount that will be withdrawn with this operation
+      // (raw amount without fee considerations).
+      amount: Amount;
+
       // Account username
       username: string;
+
+      // Reserve public key selected by the exchange,
+      // only non-null if ``status`` is ``selected`` or ``confirmed``.
+      selected_reserve_pub?: string;
+
+      // Exchange account selected by the wallet
+      // only non-null if ``status`` is ``selected`` or ``confirmed``.
+      selected_exchange_account?: string;
     }
 
 Cashouts