commit 73ba2c708184ba4b00500ca21e6941ee02e6fb9c parent 5e346486121afcacdf3d0e56ba080ae5d6a81084 Author: Florian Dold <florian@dold.me> Date: Thu, 21 Sep 2023 13:11:32 +0200 remove EBICS management API from libeufin-bank API Diffstat:
| M | core/api-libeufin-bank.rst | | | 111 | +++++-------------------------------------------------------------------------- |
1 file changed, 6 insertions(+), 105 deletions(-)
diff --git a/core/api-libeufin-bank.rst b/core/api-libeufin-bank.rst @@ -914,115 +914,16 @@ Taler Revenue API All endpoints under this prefix are specified by the :doc:`GNU Taler Revenue API </core/api-bank-revenue>`. -EBICS Host Management ---------------------- +EBICS Host +---------- -The libeufin-bank can be configured to serve the -bank account transactions via the EBICS protocol. +The Taler bank can be configured to serve bank account transactions and allow +payment initiations via the EBICS protocol. -The API for this is served under ``/ebics``. +This is an optional feature, not all implementations of the API support it. -.. http:post:: /ebics/request +.. http:post:: /ebicshost EBICS base URL. This URL allows clients to make EBICS requests to one of the configured EBICS hosts. -.. http:post:: /ebics/hosts - - Create a new EBICS host. - - **Request:** - - .. ts:def:: EbicsHostRequest - - interface EbicsHostRequest { - - // Ebics version. - host_id: string; - - // Name of the host. - ebics_version: string; - } - - -.. http:get:: /ebics/hosts - - Shows the list of all the hosts 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. - ebics_hosts: string[]; - } - -.. http:post:: /ebics/hosts/$HOST_ID/rotate-keys - - Overwrite the bank's Ebics keys with random ones. This is entirely - meant for tests (as the Sandbox itself is) and no backup will be - produced along this operation. - -.. http:post:: /ebics/subscribers - - Allows (only) the ``admin`` user create an EBICS - subscriber associated to a bank account. - - **Request:** - - .. ts:def:: SubscriberRequest - - interface SubscriberRequest { - - // EBICS HostID - host_id: string; - - // EBICS UserID - user_id: string; - - // EBICS PartnerID - partner_id: string; - - // Optional EBICS SystemID - system_id?: string; - - // Username of the bank account to associate with - // this subscriber. - account_username: string; - } - - -.. http:get:: /ebics/subscribers - - Shows the list of all the subscribers in the system. - - **Response:** - - .. ts:def:: SubscribersResponse - - interface SubscribersResponse { - - subscribers: Subscriber[] - } - - .. ts:def:: Subscriber - - interface Subscriber { - - // userID - user_id: string; - - // partnerID - partner_id: string; - - // hostID - host_id: string; - - // Label of the bank account - // associated with this Ebics subscriber. - account_username: string; - }