merchant

Merchant backend to process payments, run by merchants
Log | Files | Refs | Submodules | README | LICENSE

pg_increase_refund.h (2365B)


      1 /*
      2    This file is part of TALER
      3    Copyright (C) 2022 Taler Systems SA
      4 
      5    TALER is free software; you can redistribute it and/or modify it under the
      6    terms of the GNU General Public License as published by the Free Software
      7    Foundation; either version 3, 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 General Public License for more details.
     12 
     13    You should have received a copy of the GNU General Public License along with
     14    TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15  */
     16 /**
     17  * @file backenddb/pg_increase_refund.h
     18  * @brief implementation of the increase_refund function for Postgres
     19  * @author Christian Grothoff
     20  */
     21 #ifndef PG_INCREASE_REFUND_H
     22 #define PG_INCREASE_REFUND_H
     23 
     24 #include <taler/taler_util.h>
     25 #include <taler/taler_json_lib.h>
     26 #include "taler_merchantdb_plugin.h"
     27 
     28 
     29 /**
     30  * Function called when some backoffice staff decides to award or
     31  * increase the refund on an existing contract.  This function
     32  * MUST be called from within a transaction scope setup by the
     33  * caller as it executes mulrewardle SQL statements.
     34  *
     35  * @param cls closure
     36  * @param instance_id instance identifier
     37  * @param order_id the order to increase the refund for
     38  * @param refund maximum refund to return to the customer for this contract
     39  * @param olc function to call to obtain legal refund
     40  *    limits per exchange, NULL for no limits
     41  * @param olc_cls closure for @a olc
     42  * @param reason 0-terminated UTF-8 string giving the reason why the customer
     43  *               got a refund (free form, business-specific)
     44  * @return transaction status
     45  *        #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS if @a refund is ABOVE the amount we
     46  *        were originally paid and thus the transaction failed;
     47  *        #GNUNET_DB_STATUS_SUCCESS_ONE_RESULT if the request is valid,
     48  *        regardless of whether it actually increased the refund beyond
     49  *        what was already refunded (idempotency!)
     50  */
     51 enum TALER_MERCHANTDB_RefundStatus
     52 TMH_PG_increase_refund (
     53   void *cls,
     54   const char *instance_id,
     55   const char *order_id,
     56   const struct TALER_Amount *refund,
     57   TALER_MERCHANTDB_OperationLimitCallback olc,
     58   void *olc_cls,
     59   const char *reason);
     60 
     61 
     62 #endif