diff options
author | MS <ms@taler.net> | 2020-05-20 16:36:59 +0200 |
---|---|---|
committer | MS <ms@taler.net> | 2020-05-20 16:37:10 +0200 |
commit | 99886fe02ecf625f4d48202b3d796bd03e090ed8 (patch) | |
tree | 6a56a9ca78aeae407c9e24148cd187eb5794b7e0 /libeufin | |
parent | a02ca72db3c5c6d7b6afa6055f761a315b13fd44 (diff) | |
download | docs-99886fe02ecf625f4d48202b3d796bd03e090ed8.tar.gz docs-99886fe02ecf625f4d48202b3d796bd03e090ed8.tar.bz2 docs-99886fe02ecf625f4d48202b3d796bd03e090ed8.zip |
align docs to code
Diffstat (limited to 'libeufin')
-rw-r--r-- | libeufin/api-sandbox.rst | 118 |
1 files changed, 116 insertions, 2 deletions
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst index 015b8d59..bbb7568f 100644 --- a/libeufin/api-sandbox.rst +++ b/libeufin/api-sandbox.rst @@ -13,6 +13,25 @@ HTTP API Adds a new payment to the book. + **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 +39,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. |