increase_refund.h (3134B)
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 src/include/merchant-database/increase_refund.h 18 * @brief implementation of the increase_refund function for Postgres 19 * @author Christian Grothoff 20 */ 21 #ifndef MERCHANT_DATABASE_INCREASE_REFUND_H 22 #define MERCHANT_DATABASE_INCREASE_REFUND_H 23 24 #include <taler/taler_util.h> 25 #include <taler/taler_json_lib.h> 26 #include "merchantdb_lib.h" 27 28 29 struct TALER_MERCHANTDB_PostgresContext; 30 /* Callback typedefs */ 31 /** 32 * Determines the maximum @a amount for a particular 33 * type of operation for a given @a exchange_url. 34 * 35 * @param cls closure 36 * @param exchange_url base URL of the exchange to get 37 * the limit for 38 * @param[in,out] amount lowered to the maximum amount 39 * allowed at the exchange 40 */ 41 typedef void 42 (*TALER_MERCHANTDB_OperationLimitCallback)( 43 void *cls, 44 const char *exchange_url, 45 struct TALER_Amount *amount); 46 47 /** 48 * Function called when some backoffice staff decides to award or 49 * increase the refund on an existing contract. This function 50 * MUST be called from within a transaction scope setup by the 51 * caller as it executes mulrewardle SQL statements. 52 * 53 * @param pg database context 54 * @param instance_id instance identifier 55 * @param order_id the order to increase the refund for 56 * @param refund maximum refund to return to the customer for this contract 57 * @param olc function to call to obtain legal refund 58 * limits per exchange, NULL for no limits 59 * @param olc_cls closure for @a olc 60 * @param reason 0-terminated UTF-8 string giving the reason why the customer 61 * got a refund (free form, business-specific) 62 * @return transaction status 63 * #GNUNET_DB_STATUS_SUCCESS_NO_RESULTS if @a refund is ABOVE the amount we 64 * were originally paid and thus the transaction failed; 65 * #GNUNET_DB_STATUS_SUCCESS_ONE_RESULT if the request is valid, 66 * regardless of whether it actually increased the refund beyond 67 * what was already refunded (idempotency!) 68 */ 69 enum TALER_MERCHANTDB_RefundStatus 70 TALER_MERCHANTDB_increase_refund (struct TALER_MERCHANTDB_PostgresContext *pg, 71 const char *instance_id, 72 const char *order_id, 73 const struct TALER_Amount *refund, 74 TALER_MERCHANTDB_OperationLimitCallback olc, 75 void *olc_cls, 76 const char *reason); 77 78 79 #endif