lookup_refunds_detailed.h (2880B)
1 /* 2 This file is part of TALER 3 Copyright (C) 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 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/lookup_refunds_detailed.h 18 * @brief implementation of the lookup_refunds_detailed function for Postgres 19 * @author Iván Ávalos 20 */ 21 #ifndef MERCHANT_DATABASE_LOOKUP_REFUNDS_DETAILED_H 22 #define MERCHANT_DATABASE_LOOKUP_REFUNDS_DETAILED_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 * Function called with detailed information about a refund. 33 * 34 * @param cls closure 35 * @param refund_serial unique serial number of the refund 36 * @param timestamp time of the refund (for grouping of refunds in the wallet UI) 37 * @param coin_pub public coin from which the refund comes from 38 * @param exchange_url URL of the exchange that issued @a coin_pub 39 * @param rtransaction_id identificator of the refund 40 * @param reason human-readable explanation of the refund 41 * @param refund_amount refund amount which is being taken from @a coin_pub 42 * @param pending true if the this refund was not yet processed by the wallet/exchange 43 */ 44 typedef void 45 (*TALER_MERCHANTDB_RefundDetailCallback)( 46 void *cls, 47 uint64_t refund_serial, 48 struct GNUNET_TIME_Timestamp timestamp, 49 const struct TALER_CoinSpendPublicKeyP *coin_pub, 50 const char *exchange_url, 51 uint64_t rtransaction_id, 52 const char *reason, 53 const struct TALER_Amount *refund_amount, 54 bool pending); 55 56 /** 57 * Obtain detailed refund data associated with a contract. 58 * 59 * @param pg database context 60 * @param instance_id instance to lookup refunds for 61 * @param h_contract_terms hash code of the contract 62 * @param rc function to call for each coin on which there is a refund 63 * @param rc_cls closure for @a rc 64 * @return transaction status 65 */ 66 enum GNUNET_DB_QueryStatus 67 TALER_MERCHANTDB_lookup_refunds_detailed (struct TALER_MERCHANTDB_PostgresContext *pg, 68 const char *instance_id, 69 const struct TALER_PrivateContractHashP *h_contract_terms, 70 TALER_MERCHANTDB_RefundDetailCallback rc, 71 void *rc_cls); 72 73 #endif