diff options
author | Christian Grothoff <christian@grothoff.org> | 2020-05-21 22:40:23 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2020-05-21 22:40:23 +0200 |
commit | 5c47aa937e3ff53fcc55efad4b5118878ecc6adf (patch) | |
tree | a18ad685f52105100b98f5d19f9275564adf7fcb /libeufin | |
parent | 510d563bdf14457bc5dd3cc6e1288b6131b886ea (diff) | |
parent | be62971d6d8ba546f1099a5a183e3d3c1ed51d3b (diff) | |
download | docs-5c47aa937e3ff53fcc55efad4b5118878ecc6adf.tar.gz docs-5c47aa937e3ff53fcc55efad4b5118878ecc6adf.tar.bz2 docs-5c47aa937e3ff53fcc55efad4b5118878ecc6adf.zip |
Merge branch 'master' of git+ssh://git.taler.net/docs
Diffstat (limited to 'libeufin')
-rw-r--r-- | libeufin/api-nexus.rst | 2 | ||||
-rw-r--r-- | libeufin/api-sandbox.rst | 121 |
2 files changed, 119 insertions, 4 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 7624e9a6..7c11c2c9 100644 --- a/libeufin/api-nexus.rst +++ b/libeufin/api-nexus.rst @@ -168,7 +168,7 @@ Bank Account Management uuid: string; } -.. http:post:: {nexusBase}/bank-accounts/{acctid}/transactions/fetch +.. http:post:: {nexusBase}/bank-accounts/{acctid}/fetch-transactions Nexus will download bank transactions using the given connection. diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst index 015b8d59..6a970962 100644 --- a/libeufin/api-sandbox.rst +++ b/libeufin/api-sandbox.rst @@ -11,7 +11,27 @@ HTTP API .. http:post:: /admin/payments - Adds a new payment to the book. + Adds a new payment to the book. Mainly used for testing + purposes. + + **Request:** + + .. ts:def:: PaymentRequest + + interface PaymentRequest { + + // IBAN that will reveice the payment. + creditorIban: string; + + // IBAN that will send the payment. + debitorIban: string; + + // amount in the CURRENCY:X.Y form. + amount: string; + + // subject of the payment. + subject: string; + } .. Host management. @@ -20,26 +40,121 @@ HTTP API Creates a new Ebics host. + **Request:** + + .. ts:def:: EbicsHostRequest + + interface EbicsHostRequest { + + // Ebics version. + hostID: string; + + // Name of the host. + ebicsVersion: string; + } + + .. http:get:: /admin/ebics/hosts Shows the list of all the hosts existing in the system. + **Response:** + + .. ts:def:: EbicsHostResponse + + interface EbicsHostResponse { + + // shows the host IDs that are active in the system. + // The Ebics version *is* missing, but it's still available + // via the HEV message. + ebicsHosts: string[]; + } + + .. Subscriber management. .. http:post:: /admin/ebics/subscribers - Creates a new subscriber. + Creates a new Ebics subscriber. + + **Request:** + + .. ts:def:: SubscriberRequest + + interface SubscriberRequest { + + // hostID + hostID: string; + + // userID + userID: string; + + // partnerID + partnerID: string; + + // systemID + systemID: string; + + } + .. http:get:: /admin/ebics/subscribers Shows the list of all the subscribers existing in the system. + **Response:** + + .. ts:def:: SubscribersResponse + + interface SubscribersResponse { + + subscribers: Subscriber[] + } + + .. ts:def:: Subscriber + + interface Subscriber { + + // userID + userID: string; + + // partnerID + partnerID: string; + + // hostID + hostID: string; + + } + .. http:post:: /admin/ebics/bank-accounts - Associates a new bank account to an existing subscriber. + Associates a new bank account to an existing subscriber. + + **Request:** + + .. ts:def:: BankAccountRequest + + interface BankAccountRequest { + + // Ebics subscriber + subscriber: string; + + // IBAN + iban: string; + + // BIC + bic: string; + + // human name + name: string; + + // bank account label + label: string; + + } .. Main EBICS service. |