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.rst73
1 files changed, 67 insertions, 6 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index ce93f8b1..0fd08743 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -287,6 +287,15 @@ manages payment initiations of the account and tracks the initiations of payment
bankConnection: string;
}
+ **Response:** Tells how many new messages were downloaded from the bank,
+ in the following format:
+
+ .. code-block:: ts
+
+ interface NewMessages {
+ newMessages: number;
+ }
+
.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions
Shows which transactions are stored locally at nexus.
@@ -634,22 +643,74 @@ to the real bank.
nexusBankAccountId: string;
}
+
+.. http:get:: <nexus>/bank-connections/{connId}/messages
+
+ List *some* details of all the ISO2022 messages gotten from the bank. It
+ responds with a list of the following elements:
+
+ .. code-block:: ts
+
+ interface BankMessageInfo {
+
+ // the message type, typically how the containing layer
+ // (Ebics, for example) would label this information. For
+ // Camt.053 types, this value is "C53".
+ code: string;
+
+ // the unique identifier of the message.
+ messageId: string;
+
+ // bytes length of the message.
+ length: number;
+ }
+
+
+
+.. http:get:: <nexus>/bank-connections/{connId}/messages/{msgId}
+
+ Return the ISO20022 XML corresponding to ``msgId``.
+
+
Facades
-------
+.. http:get:: <nexus>/facades/{fcid}
+
+ **Response:** A `FacadeShowInfo` pointed to by ``fcid``.
+
+
.. http:get:: <nexus>/facades
- List available facades.
+ List available facades that belong to the requesting user.
-.. http:post:: {nexus}/facades
+ **Response:** A list of the following elements:
+
+.. ts:def:: FacadeShowInfo
+
+ interface FacadeShowInfo {
+
+ // Name of the facade, same as the "fcid" parameter.
+ name: string;
+
+ // Type of the facade.
+ // For example, "taler-wire-gateway".
+ type: string;
+
+ // Bas URL of the facade.
+ baseUrl: string;
- Create a new facade; it requires a `FacadeInfo` as the request's body.
+ // details depending on the facade type.
+ config: any;
+ }
+
+.. http:post:: {nexus}/facades
-.. http:get:: {nexus}/facades/${fcid}
+ Create a new facade.
- Get details about a facade.
+ **Request:**
- .. ts:def:: FacadeInfo
+ .. code-block:: ts
interface FacadeInfo {
// Name of the facade, same as the "fcid" parameter.