summaryrefslogtreecommitdiff
path: root/libeufin/api-nexus.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-05-19 19:45:06 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-05-19 19:45:06 +0530
commit6a6d05514267cd04fdd10bc1414a327f7aa273e8 (patch)
tree1eb1d33d496603faf7924ff3d33047001dbf0894 /libeufin/api-nexus.rst
parentc28e9e12cf6e05214b1716dd492dde1cd272085e (diff)
downloaddocs-6a6d05514267cd04fdd10bc1414a327f7aa273e8.tar.gz
docs-6a6d05514267cd04fdd10bc1414a327f7aa273e8.tar.bz2
docs-6a6d05514267cd04fdd10bc1414a327f7aa273e8.zip
facades docs
Diffstat (limited to 'libeufin/api-nexus.rst')
-rw-r--r--libeufin/api-nexus.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 4b721eea..b0ea56c1 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -333,6 +333,47 @@ to the real bank.
LibEuFin accounts they are connected to.
+Facades
+-------
+
+.. http:get:: <nexus>/facades
+
+ List available facades.
+
+.. http:get:: <nexus>/facade/${fcid}
+
+ Get details about a facade.
+
+ .. ts:def:: FacadeInfo
+
+ interface FacadeInfo {
+ // Name of the facade, same as the "fcid" parameter.
+ name: string;
+
+ // Type of the facade.
+ // For example, "taler-wire-gateway".
+ type: string;
+
+ // Name of the user that created the facade.
+ // Whenever the facade accesses a resource it is allowed to
+ // access, the creator must *also* have access to that resource.
+ creator: string;
+
+ // Bank accounts that the facade has read/write
+ // access to.
+ bankAccountsRead: string[];
+ bankAccountsWrite: string[];
+
+ // Bank connections that the facade has read/write
+ // access to.
+ bankConnectionsRead: string[];
+ bankConnectionsWrite: string[];
+
+ // Facade-specific configuration details.
+ config: any;
+ }
+
+
EBICS-specific APIs
-------------------