taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

api-bank-revenue.rst (1739B)


      1 ..
      2   This file is part of GNU TALER.
      3   Copyright (C) 2021-2023 Taler Systems SA
      4 
      5   TALER is free software; you can redistribute it and/or modify it under the
      6   terms of the GNU Affero General Public License as published by the Free Software
      7   Foundation; either version 2.1, or (at your option) any later version.
      8 
      9   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
     10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11   A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.
     12 
     13   You should have received a copy of the GNU Affero General Public License along with
     14   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15 
     16 .. _taler-bank-merchant-http-api:
     17 
     18 ===========================
     19 Taler Bank Revenue HTTP API
     20 ===========================
     21 
     22 This section describes an API offered by libeufin-nexus and libeufin-bank. The API is
     23 used by the merchant (or other parties) to query for incoming transactions to their account.
     24 
     25 
     26 ---------------
     27 Version History
     28 ---------------
     29 
     30 The current protocol version is **v1**.
     31 
     32 * The merchant is currently targeting protocol version **v1**.
     33 
     34 **Version history:**
     35 
     36 * ``v1``: pagination API consistency fixes
     37 
     38 **Upcoming versions:**
     39 
     40 * None anticipated.
     41 
     42 **Ideas for future version:**
     43 
     44 * ``vXXX``: marker for features not yet targeted for release
     45 
     46 
     47 .. include:: bank-revenue/get-config.rst
     48 
     49 
     50 --------------
     51 Authentication
     52 --------------
     53 
     54 The bank library authenticates requests to the bank merchant API using
     55 `HTTP basic auth <https://tools.ietf.org/html/rfc7617>`_.
     56 
     57 --------------------------------
     58 Querying the transaction history
     59 --------------------------------
     60 
     61 .. include:: bank-revenue/get-history.rst