diff options
author | Florian Dold <florian.dold@gmail.com> | 2020-05-19 18:52:04 +0530 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2020-05-19 18:52:04 +0530 |
commit | c28e9e12cf6e05214b1716dd492dde1cd272085e (patch) | |
tree | 79ccf240cb1205edb0a37b85f72592ff809ef828 | |
parent | 5f6914013ddb7e074d9cbaa170b9e895c43f2081 (diff) | |
download | docs-c28e9e12cf6e05214b1716dd492dde1cd272085e.tar.gz docs-c28e9e12cf6e05214b1716dd492dde1cd272085e.tar.bz2 docs-c28e9e12cf6e05214b1716dd492dde1cd272085e.zip |
libeufin docs
-rw-r--r-- | libeufin/api-nexus.rst | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 88ddde3d..4b721eea 100644 --- a/libeufin/api-nexus.rst +++ b/libeufin/api-nexus.rst @@ -168,7 +168,7 @@ Bank Account Management uuid: string; } -.. http:post:: {nexus}/bank-accounts/{acctid}/download-transactions +.. http:post:: {nexusBase}/bank-accounts/{acctid}/transactions/fetch Nexus will download bank transactions using the given connection. @@ -179,7 +179,7 @@ Bank Account Management interface CollectedTransaction { // Optional field to specify the bank connection to // use for such operation. - bankConnection: connection; + bankConnection?: string; // dashed date (YYYY-MM-DD) of the earliest payment // in the result. Optional, defaults to "earliest // possible" date. @@ -190,7 +190,7 @@ Bank Account Management end: string; } -.. http:get:: <nexus>/bank-accounts/<my-acct>/transactions +.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions Shows which transactions are stored locally at nexus. @@ -319,6 +319,19 @@ to the real bank. Initialize the connection by talking to the bank. +.. http:post:: {nexusBase}/bank-connections/{connid}/export-backup + + Make a passphrase-encrypted backup of this connection. + +.. http:post:: {nexusBase}/bank-connections/{connid}/accounts/fetch + + Update accounts that are accessible via this bank connection. + +.. http:get:: {nexusBase}/bank-connections/{connid}/accounts + + list accounts that are accessible via this bank connection and what + LibEuFin accounts they are connected to. + EBICS-specific APIs ------------------- @@ -326,7 +339,7 @@ EBICS-specific APIs The following endpoints are only available for EBICS bank connections. They are namespaced under the ``/ebics/`` sub-resource. -.. http:post:: {nexusBase}/bank-connections/<connection-name>/ebics/download/{msg} +.. http:post:: {nexusBase}/bank-connections/{connection-name}/ebics/download/{msg} .. warning:: @@ -337,7 +350,7 @@ They are namespaced under the ``/ebics/`` sub-resource. in the nexus database. It will just make a request to the bank and return the answer. -.. http:post:: {nexusBase}/bank-connections/<connection-name>/ebics/upload/{msg} +.. http:post:: {nexusBase}/bank-connections/{connection-name}/ebics/upload/{msg} .. warning:: |