[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated (eb85a80 -> 085d994)
From: |
gnunet |
Subject: |
[taler-docs] branch master updated (eb85a80 -> 085d994) |
Date: |
Fri, 04 Dec 2020 15:00:28 +0100 |
This is an automated email from the git hooks/post-receive script.
ms pushed a change to branch master
in repository docs.
from eb85a80 delete spurious indentation (11 instances)
new e41cdf8 Align specs to code.
new 3b86fb4 more on Sandbox payments API
new 085d994 Sandbox API.
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
libeufin/api-sandbox.rst | 59 ++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 57 insertions(+), 2 deletions(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index d848ba4..d1214d5 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -9,28 +9,83 @@ 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.
+
+ **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;
+ // FIXME
+ creditorBic: string;
+ // FIXME
+ creditorName: string;
// IBAN that will send the payment.
debitorIban: string;
+ // FIXME
+ debitorBic: string;
+ // FIXME
+ debitorName: string;
amount: string;
currency: string;
// subject of the payment.
subject: string;
+
+ // Whether the payment is credit or debit *for* the
+ // account being managed *by* the running sandbox.
+ // Can take the values: "CRDT" or "DBIT".
+ direction: string;
}
..
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (eb85a80 -> 085d994),
gnunet <=