taler-docs

commit f1d0199a830e6b354c5d49b4dd8b0e1bea0c828e
parent e4d9639bcb53cdf7968bd5eb87bd94f33bb73ccd
Author: MS <ms@taler.net>
Date:   Thu,  3 Dec 2020 15:47:54 +0100

Align specs to code.

Diffstat:
M
libeufin/api-nexus.rst
 | 
72
++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------

1 file changed, 56 insertions(+), 16 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
@@ -303,28 +303,68 @@ manages payment initiations of the account and tracks the initiations of payment
   .. ts:def:: Transaction
 
      interface Transaction {
-       // local bank account involved in the transaction.
-       account: string;
 
-       // counterpart IBAN
-       counterpartIban: string;
+       // money moved by the transaction
+       amount: string;
 
-       // counterpart BIC
-       counterpartBic: string;
+       // CRDT or DBIT
+       creditDebitIndicator: string
 
-       // counterpart holder name
-       counterpartName: string;
+       // Two of the most used values are BOOK, or PENDING
+       status: string;
 
-       // amount, in the format [-]CURRENCY:XX.YY,
-       // where the minus sign as prefix indicates
-       // a debit for the user's bank account.
-       amount: string;
+       // FIXME
+       bankTransactionCode: string;
 
-       // Dashed date YYYY-MM(01-12)-DD(01-31) of the transaction.
-       date: string;
+       // FIXME
+       valueDate: string;
+       
+       // When this payment got booked.  In the form YYYY-MM-DD
+       bookingDate: string;
 
-       // Payment subject.
-       subject: string;
+       // FIXME
+       accountServicerRef: string;
+
+       // FIXME
+       batches: {
+         // list of batched transactions
+         batchTransactions: [BatchedTransaction]
+       };
+     }
+
+  .. ts:def:: BatchedTransaction
+     interface BatchedTransaction {
+       // FIXME
+       amount: string;
+       // FIXME
+       creditDebitIndicator: string;
+       // FIXME
+       details {
+         debtor: {
+           name: string;
+         };
+         debtorAccount: {
+           iban: string;
+         };
+         // Missing, when the payment is DBIT.
+         debtorAgent: {
+           bic: string;
+         };
+         creditor: {
+           name: string;
+         };
+         creditorAccount: {
+           iban: string;
+         };
+         // Missing, when the payment is CRDT.
+         creditorAgent: {
+           iban: string;
+         };
+         // FIXME
+         endToEndId: string;
+         // FIXME
+         unstructuredRemittanceInformation: string;
+       }
      }