summaryrefslogtreecommitdiff
path: root/libeufin/api-nexus.rst
diff options
context:
space:
mode:
Diffstat (limited to 'libeufin/api-nexus.rst')
-rw-r--r--libeufin/api-nexus.rst92
1 files changed, 75 insertions, 17 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 01e8e92..f47101f 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -103,6 +103,22 @@ User Management
Return list of users.
+Test API
+--------
+
+.. http:post:: {nexusBase}/bank-accounts/{acctid}/test-camt-ingestion/{type}
+
+ This call allows tests to **directly** give Nexus a Camt document. After
+ the processing, all the payment(s) details should be ingested as if the
+ Camt came normally from a bank / the Sandbox. ``acctid`` must match the
+ label of a locally imported bank account, and ``type`` for now can only be
+ ``C53``.
+
+ **Response**
+
+ The successful case should respond with a ``200 OK`` and a empty JSON body.
+
+
Bank Accounts
-------------
@@ -281,33 +297,75 @@ manages payment initiations of the account and tracks the initiations of payment
Optional, defaults to "earliest possible" date.
- **Response:** A list of `Transaction` objects.
+ **Response:** A object with a unique field named ``transactions``
+ that contains a list of `Transaction` objects.
.. 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;
+ }
}