taler-docs

commit e0731ef55d002931eccda006c3c112afeed1ab57
parent 73b79526e5db660b2a39aeea3d04714b3dce7852
Author: Antoine A <>
Date:   Mon, 20 Jan 2025 14:05:17 +0100

wg: add account check

Diffstat:
M
core/api-bank-wire.rst
 | 
42
++++++++++++++++++++++++++++++++++++++++--

1 file changed, 40 insertions(+), 2 deletions(-)
diff --git a/core/api-bank-wire.rst b/core/api-bank-wire.rst
@@ -1,6 +1,6 @@
 ..
   This file is part of GNU TALER.
-  Copyright (C) 2019-2023 Taler Systems SA
+  Copyright (C) 2019-2025 Taler Systems SA
 
   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU Affero General Public License as published by the Free Software
@@ -29,7 +29,7 @@ LibEuFin.
 .. http:get:: /config
 
   Return the protocol version and configuration information about the bank.
-  This specification corresponds to ``current`` protocol being version **3**.
+  This specification corresponds to ``current`` protocol being version **4**.
 
   **Response:**
 
@@ -56,6 +56,9 @@ LibEuFin.
       // URN of the implementation (needed to interpret 'revision' in version).
       // @since v0, may become mandatory in the future.
       implementation?: string;
+
+      // Wether implementation support account existence check
+      support_account_check: boolean;
     }
 
 --------------
@@ -499,6 +502,41 @@ accounts are merged into a single history.
     }
 
 
+-----------------
+Wire Account APIs
+-----------------
+
+.. http:get:: /account/check
+
+  Check account existence.
+
+  Since protocol **v4**.
+
+  **Request:**
+
+  :query account:
+    Payto URI of the account.
+
+  **Response:**
+
+  :http:statuscode:`200 OK`:
+    JSON object of type `AccountInfo`.
+  :http:statuscode:`400 Bad request`:
+    Request malformed. The bank replies with an `ErrorDetail` object.
+  :http:statuscode:`401 Unauthorized`:
+    Authentication failed, likely the credentials are wrong.
+  :http:statuscode:`404 Not found`:
+    * ``TALER_EC_BANK_UNKNOWN_ACCOUNT``: unknown account.
+  :http:statuscode:`501 Not Implemented`:
+    This server does not support account check.
+
+  **Details:**
+
+  .. ts:def:: AccountInfo
+
+    interface AccountInfo {
+    }
+
 -----------------------
 Wire Transfer Test APIs
 -----------------------