diff options
| -rw-r--r-- | libeufin/api-nexus.rst | 56 |
1 files changed, 30 insertions, 26 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 43684ae7..a60bf4d1 100644 --- a/libeufin/api-nexus.rst +++ b/libeufin/api-nexus.rst @@ -425,32 +425,36 @@ tracks the initiations of payments. // should NOT expect it to grow continuously. index: string; - // money moved by the transaction - amount: string; - - // CRDT or DBIT - creditDebitIndicator: string - - // Two of the most used values are BOOK, or PENDING - status: string; - - // FIXME - bankTransactionCode: string; - - // FIXME - valueDate: string; - - // When this payment got booked. In the form YYYY-MM-DD - bookingDate: string; - - // FIXME - accountServicerRef: string; - - // FIXME - batches: { - // list of batched transactions - batchTransactions: BatchedTransaction[]; - }; + // Nexus representation of a transaction. The format is shaped + // around the CaMt terminology and its XML structure. + camtData: { + // money moved by the transaction + amount: string; + + // CRDT or DBIT + creditDebitIndicator: string + + // Two of the most used values are BOOK, or PENDING + status: string; + + // FIXME + bankTransactionCode: string; + + // FIXME + valueDate: string; + + // When this payment got booked. In the form YYYY-MM-DD + bookingDate: string; + + // FIXME + accountServicerRef: string; + + // FIXME + batches: { + // list of batched transactions + batchTransactions: BatchedTransaction[]; + }; + } } .. ts:def:: BatchedTransaction |