[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 01/02: Circuit API.
From: |
gnunet |
Subject: |
[taler-docs] 01/02: Circuit API. |
Date: |
Fri, 20 Jan 2023 15:41:44 +0100 |
This is an automated email from the git hooks/post-receive script.
ms pushed a commit to branch master
in repository docs.
commit 804439a53c9d0c574ac1765942c779a580e5f4ad
Author: MS <ms@taler.net>
AuthorDate: Fri Jan 20 15:39:48 2023 +0100
Circuit API.
More details around a cash-out operation, and
offering a "GET /cashouts" to get the list of
all of them.
---
libeufin/api-sandbox.rst | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 88e1bdc..60d1185 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -423,6 +423,26 @@ Cashouts
the terms 'sell out' and 'cashout' may be used interchangeably.
+.. http:get:: /cashouts
+
+ Returns the list of all the (pending and confirmed) cash-out operations.
+
+ **Response:**
+
+ .. ts:def:: Cashouts
+
+ interface Cashouts {
+ // Every string represents a cash-out operation UUID.
+ cashouts: string[];
+ }
+
+ :http:statuscode:`204 No Content`:
+ No cash-out operations were found at the bank
+
+ :http:statuscode:`200 OK`:
+ At least one cash-out operation was found.
+
+
.. http:get:: /cashouts/$cashoutId
Informs about the status of the ``$cashoutId`` operation.
@@ -439,6 +459,18 @@ Cashouts
interface CashoutStatusResponse {
status: CashoutStatus;
+ // Amount debited to the circuit bank account.
+ amount_debit: Amount;
+ // Amount credited to the external bank account.
+ amount_credit: Amount;
+ // Transaction subject.
+ subject: string;
+ // Circuit bank account that created the cash-out.
+ account: string;
+ // Time when the cash-out was created.
+ creation_time: number; // milliseconds since the Unix epoch
+ // Time when the cash-out was confirmed via its TAN.
+ confirmation_time: number; // milliseconds since the Unix epoch
}
.. ts:def:: CashoutStatus
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.