iterate_external_refunds.h (2472B)
1 /* 2 This file is part of TALER 3 Copyright (C) 2026 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/iterate_external_refunds.h 18 * @brief implementation of the iterate_external_refunds function for Postgres 19 * @author Bohdan Potuzhnyi 20 * @author Volodymyr Potuzhnyi 21 */ 22 #ifndef MERCHANT_DATABASE_ITERATE_EXTERNAL_REFUNDS_H 23 #define MERCHANT_DATABASE_ITERATE_EXTERNAL_REFUNDS_H 24 25 #include <taler/taler_util.h> 26 #include <taler/taler_json_lib.h> 27 #include "merchantdb_lib.h" 28 29 30 struct TALER_MERCHANTDB_PostgresContext; 31 32 /** 33 * Function called with detailed information about an external refund. 34 * 35 * @param cls closure 36 * @param refund_id identifier of the refund within the order 37 * @param refund_timestamp when was the refund recorded 38 * @param method external payment method used for the refund 39 * @param payment_id id of the original external payment entry this 40 * refund reverses, NULL if none 41 * @param amount amount returned to the customer 42 * @param reason human-readable refund justification 43 */ 44 typedef void 45 (*TALER_MERCHANTDB_ExternalRefundCallback)( 46 void *cls, 47 const char *refund_id, 48 struct GNUNET_TIME_Timestamp refund_timestamp, 49 const char *method, 50 const char *payment_id, 51 const struct TALER_Amount *amount, 52 const char *reason); 53 54 55 /** 56 * Retrieve the external refunds recorded for the given @a order_id. 57 * 58 * @param pg database context 59 * @param instance_id instance's identifier 60 * @param order_id order to look up external refunds for 61 * @param cb function to call with each external refund 62 * @param cb_cls closure for @a cb 63 * @return transaction status 64 */ 65 enum GNUNET_DB_QueryStatus 66 TALER_MERCHANTDB_iterate_external_refunds ( 67 struct TALER_MERCHANTDB_PostgresContext *pg, 68 const char *instance_id, 69 const char *order_id, 70 TALER_MERCHANTDB_ExternalRefundCallback cb, 71 void *cb_cls); 72 73 #endif