From f1d0199a830e6b354c5d49b4dd8b0e1bea0c828e Mon Sep 17 00:00:00 2001 From: MS Date: Thu, 3 Dec 2020 15:47:54 +0100 Subject: Align specs to code. --- libeufin/api-nexus.rst | 72 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 56 insertions(+), 16 deletions(-) (limited to 'libeufin') diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index b7186f16..67ac3c3e 100644 --- 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; + } } -- cgit v1.2.3