[taler-docs] 02/03: more on Sandbox payments API

[gnunet]

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

ms pushed a commit to branch master
in repository docs.

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

    more on Sandbox payments API
---
 libeufin/api-sandbox.rst | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index a410b9e..6f1d152 100644
--- 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;

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