taler-docs

commit 3b86fb44cf603b63bfb5f132def4f963b83ab17b
parent e41cdf846de639bbb49ffc01ea830689605bccb2
Author: MS <ms@taler.net>
Date:   Fri,  4 Dec 2020 13:07:12 +0100

more on Sandbox payments API

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

1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
@@ -9,16 +9,33 @@ HTTP API
 ..
   Payments.
 
+.. http:get:: /admin/payments
+
+   Return the list of *all* the payments known by the sandbox.
+
+   **Response**
+
+   .. code-block:: tsref
+
+     interface SandboxPayments {
+
+       // The list of all known payments, regardless
+       // of any IBAN involved in them.
+       payments: SandboxPayment[];
+     }
+
 .. http:post:: /admin/payments
 
    Adds a new payment to the book.  Mainly used for testing
    purposes.
 
    **Request:**
+   
+   One object of type `SandboxPayment`
 
-    .. ts:def:: PaymentRequest
+    .. ts:def:: SandboxPayment
 
-     interface PaymentRequest {
+     interface SandboxPayment {
 
        // IBAN that will receive the payment.
        creditorIban: string;