Circuit API.

More details around a cash-out operation, and
offering a "GET /cashouts" to get the list of
all of them.

1 files changed, 32 insertions, 0 deletions

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 88e1bdcd..60d11858 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