merchant

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

lookup_transfer_details_by_order.h (2963B)


      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_transfer_details_by_order.h
     18  * @brief implementation of the lookup_transfer_details_by_order function for Postgres
     19  * @author Iván Ávalos
     20  */
     21 #ifndef MERCHANT_DATABASE_LOOKUP_TRANSFER_DETAILS_BY_ORDER_H
     22 #define MERCHANT_DATABASE_LOOKUP_TRANSFER_DETAILS_BY_ORDER_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  * Typically called by `lookup_transfer_details_by_order`.
     33  *
     34  * @param cls closure
     35  * @param wtid wire transfer subject of the wire transfer for the coin
     36  * @param exchange_url base URL of the exchange that made the payment
     37  * @param execution_time when was the payment made
     38  * @param deposit_value contribution of the coin to the total wire transfer value
     39  * @param deposit_fee deposit fee charged by the exchange for the coin
     40  * @param transfer_confirmed did the merchant confirm that a wire transfer with
     41  *        @a wtid over the total amount happened?
     42  * @param expected_credit_serial row of the expected wire transfer, usable
     43  *        as ``offset`` for the ``/private/incoming`` endpoint
     44  */
     45 typedef void
     46 (*TALER_MERCHANTDB_OrderTransferDetailsCallback)(
     47   void *cls,
     48   const struct TALER_WireTransferIdentifierRawP *wtid,
     49   const char *exchange_url,
     50   struct GNUNET_TIME_Timestamp execution_time,
     51   const struct TALER_Amount *deposit_value,
     52   const struct TALER_Amount *deposit_fee,
     53   bool transfer_confirmed,
     54   uint64_t expected_credit_serial);
     55 
     56 /**
     57  * Retrieve wire transfer details for all deposits associated with
     58  * a given @a order_serial.
     59  *
     60  * @param pg database context
     61  * @param order_serial identifies the order
     62  * @param cb function called with the wire transfer details
     63  * @param cb_cls closure for @a cb
     64  * @return transaction status
     65  */
     66 enum GNUNET_DB_QueryStatus
     67 TALER_MERCHANTDB_lookup_transfer_details_by_order (struct TALER_MERCHANTDB_PostgresContext *pg,
     68                                                    uint64_t order_serial,
     69                                                    TALER_MERCHANTDB_OrderTransferDetailsCallback
     70                                                    cb,
     71                                                    void *cb_cls);
     72 
     73 #endif