[taler-docs] 18/36: add endpoint to delete bogus wire transfers

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

commit 2961b83cd565b81f6616ff779c65a9a7a6334f48
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Mon May 17 17:49:02 2021 +0200

    add endpoint to delete bogus wire transfers
---
 core/api-merchant.rst | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index c9d9ca5..ddd612c 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -2359,7 +2359,7 @@ Querying known wire transfers
       exchange_url: string;
 
       // Serial number identifying the transfer in the merchant backend.
-      // Used for filgering via ``offset``.
+      // Used for filtering via ``offset``.
       transfer_serial_id: number;
 
       // Time of the execution of the wire transfer by the exchange, according 
to the exchange
@@ -2378,6 +2378,30 @@ Querying known wire transfers
     }
 
 
+Deleting wire transfer
+----------------------
+
+Deleting a wire transfer can be useful in case of a data entry
+mistake. In particular, if the exchange base URL was entered
+badly, deleting the old entry and adding a correct one is a
+good idea. Note that deleting wire transfers is no longer possible
+once we got a reply from the exchange.
+
+.. http:delete:: [/instances/$INSTANCE]/private/transfers/$TID
+
+   Here, the TID ist the 'transfer_serial_id' of the transfer
+   to delete.
+
+  **Response:**
+
+  :http:statuscode:`204 No content`:
+    The transfer was deleted.
+  :http:statuscode:`404 Not found`:
+    The transfer was already unknown.
+  :http:statuscode:`409 Conflict`:
+    The transfer cannot be deleted anymore.
+
+
 --------------------
 Backend: Giving tips
 --------------------

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.