taler-docs

commit 085d99420a7aa23b04bd4ce1e256eec9e182c166
parent 3b86fb44cf603b63bfb5f132def4f963b83ab17b
Author: MS <ms@taler.net>
Date:   Fri,  4 Dec 2020 13:22:49 +0100

Sandbox API.

Endpoint to request a Camt document.

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

1 file changed, 25 insertions(+), 0 deletions(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
@@ -9,6 +9,31 @@ HTTP API
 ..
   Payments.
 
+
+.. http:post:: /admin/payments/camt
+
+  Return the history of one IBAN in Camt.053 format.
+
+  **Request**
+
+   .. code-block:: tsref
+
+     interface CamtParams {
+
+       // IBAN managed by the running Sandbox, for which
+       // the Camt.053 response is going to be generated.
+       iban: string;
+       
+       // The Camt type to return.  Only '53' is allowed
+       // at this moment.
+       type: number;
+     }
+
+  **Response**
+
+  The expected Camt.053 document.
+
+
 .. http:get:: /admin/payments
 
    Return the list of *all* the payments known by the sandbox.