cash2ecash

bank_api_get_config.h (5222B)

---

 /*
   This file is part of TALER cash2ecash
   Copyright (C) 2026 GNUnet e.V.
 
   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as
   published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.
 
   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
 /**
  * @file bank_api_get_config.h
  * @brief Implementation of the GET /config request of the bank's HTTP API
  * @author Reto Tellenbach
  */
 
 #ifndef BANK_API_GET_CONFIG_H
 #define BANK_API_GET_CONFIG_H
 
 #include "bank_api_curl_defaults.h"
 #include "../taler/taler_digitizer_service.h"
 
 /**
  * Handle for the get config request.
  */
 struct TALER_BANK_GetConfigHandle;
 
 /**
  * @brief Information we get from the bank about itself. and is needed for the digitizer
  */
 struct TALER_BANK_ConfigInformation
 {
 
   /**
    * Supported Taler protocol version by the bank.
    * String in the format current:revision:age using the
    * semantics of GNU libtool.  See
    * https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
    */
   const char *version;
 
   /**
    * Currency used by this bank.
    */
   const char *currency;
 
   /**
    * Minimum wire transfer amount allowed. Only applies to bank transactions and withdrawals.
    */
   struct TALER_Amount min_wire_transfer_amount;
 
   /**
    * Maximum wire transfer amount allowed. Only applies to bank transactions and withdrawals.
   */
   struct TALER_Amount max_wire_transfer_amount;
 
   /**
    * How the bank SPA should render this currency.
    */
   struct TALER_CurrencySpecification currency_specification;
 
     /**
    * Bank display name to be used in user interfaces.
    * For consistency use "Taler Bank" if missing.
    */
   const char *bank_name;
 
   /**
    * Wire transfer execution fees. Only applies to bank transactions and withdrawals.
    */
   struct TALER_Amount wire_transfer_fees;
 
   // /**
   //  * Name of api
   //  */
   // const char *api_name;
 
 
   // /**
   //  * Advertised base URL to use when you sharing an URL with another program.
   //  */
   // const char *base_url;
 
   // /** If 'true' the server provides local currency conversion support
   //  * If 'false' some parts of the API are not supported and return 501
   //  */
   // const bool allow_conversion;
 
   // /** If 'true' anyone can register
   //  * If 'false' only admin can
   //  */
   // const bool allow_registrations;
 
   // /**
   //  * If 'true' account can delete themselves
   //  * If 'false' only admin can delete accounts
   // */
   // const bool allow_deletions;
 
   // /**
   //  * If 'true' anyone can edit their name
   //  * If 'false' only admin can
   //  */
   // const bool allow_edit_name;
 
   // /**
   //  * If 'true' anyone can edit their cashout account
   //  * If 'false' only admin can
   //  */
   // const bool allow_edit_cashout_payto_uri;
 
   // /**
   //  * Default debt limit for newly created accounts
   //  */
   // const struct TALER_AmountNBO default_debit_threshold; 
 
   // /**
   //  * Stand in  string for the TAN channel. Not used in the callbacks
   //  * when used needs to be addapted
   //  * TAN channels supported by the server
   //  */
   // const char *supported_tan_channels;
 
   // /**
   //  * Wire transfer type supported by the bank.
   //  * Defaults to 'iban' is missing
   //  */
   // const char *wire_type;
 
 };
 
 /**
  * Response details for a config request
  */
 struct TALER_BANK_ConfigResponse
 {
 
   /**
    * HTTP response
    */
   struct TALER_BANK_HttpResponse hr;
 
   /**
    * Details returned depending on the @e http_status.
    */
   union
   {
 
     /**
      * Details if status was request was succesfull
      */
     struct
     {
 
       /**
        * Protocol compatibility evaluation.
        */
       enum TALER_BANK_VersionCompatibility version_compa;
 
       /**
        * Config data returned by /config.
        */
       struct TALER_BANK_ConfigInformation configi;
 
     } ok;
 
   } details;
 
 };
 
 
 /**
  * Function called with information about the bank.
  *
  * @param cls closure
  * @param vr response data
  */
 typedef void
 (*TALER_BANK_ConfigCallback) (
   void *cls,
   const struct TALER_BANK_ConfigResponse *vr);
 
 
 /**
  * Handle for the get config request.
  */
 struct TALER_BANK_GetConfigHandle;
 
 
 /**
  * Obtain config inforamtion about the connected Bank
  * @param ctx
  * @param url
  * @return NULL on failure
  */
 struct TALER_BANK_GetConfigHandle *
 TALER_BANK_get_config ( struct GNUNET_CURL_Context *ctx,
                         const char *url,
                         TALER_BANK_ConfigCallback config_cb,
                         void *config_cb_cls);
 
 /**
  * Cancel config request. Handles the GNUNet canelation.
  */
 void
 TALER_BANK_get_config_cancel ( struct TALER_BANK_GetConfigHandle *bank);
 
 
 #endif //BANK_API_GET_CONFIG_H