summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-12-04 13:07:12 +0100
committerMS <ms@taler.net>2020-12-04 15:00:23 +0100
commit3b86fb44cf603b63bfb5f132def4f963b83ab17b (patch)
treebac3509dc26a38220f39b40b9ae244a57b47934a /libeufin
parente41cdf846de639bbb49ffc01ea830689605bccb2 (diff)
downloaddocs-3b86fb44cf603b63bfb5f132def4f963b83ab17b.tar.gz
docs-3b86fb44cf603b63bfb5f132def4f963b83ab17b.tar.bz2
docs-3b86fb44cf603b63bfb5f132def4f963b83ab17b.zip
more on Sandbox payments API
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-sandbox.rst21
1 files 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;