summaryrefslogtreecommitdiff
path: root/libeufin/api-nexus.rst
diff options
context:
space:
mode:
authorMS <ms@taler.net>2023-04-20 14:29:16 +0200
committerMS <ms@taler.net>2023-04-21 16:30:28 +0200
commitf981811b9b8fc7a6f43e144051b8b3e2c00fa903 (patch)
tree0827e204ad9426b7724c8a0c56d5c043564b2d21 /libeufin/api-nexus.rst
parent8824cfbccdd9c12af23e8bd7017caf99e9ca25a0 (diff)
downloaddocs-f981811b9b8fc7a6f43e144051b8b3e2c00fa903.tar.gz
docs-f981811b9b8fc7a6f43e144051b8b3e2c00fa903.tar.bz2
docs-f981811b9b8fc7a6f43e144051b8b3e2c00fa903.zip
API Nexus, GET /transactions.
Avoiding mixing CaMt and custom data in one format.
Diffstat (limited to 'libeufin/api-nexus.rst')
-rw-r--r--libeufin/api-nexus.rst56
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