taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-monitoring-deposit-confirmations.rst (2818B)

      1 .. http:get:: /monitoring/deposit-confirmations
      2 
      3   Get a list of deposit confirmations stored by the auditor.
      4 
      5   The following query parameters are optional, and can be used to customise the response:
      6 
      7   **Request:**
      8 
      9   :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20.
     10   :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX.
     11   :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false.
     12 
     13   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     14 
     15   **Response:**
     16 
     17   :http:statuscode:`200 OK`:
     18     The auditor responds with a top level array of :ts:type:`DepositConfirmations` objects.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: DepositConfirmations
     23 
     24     interface DepositConfirmations {
     25 
     26       // Row id in the exchange database
     27       deposit_confirmation_serial_id : Integer;
     28 
     29       // Hash over the contract for which this deposit is made.
     30       h_contract_terms : HashCode;
     31 
     32       // Hash over the policy concerning this deposit
     33       h_policy : HashCode;
     34 
     35       // Hash over the wiring information of the merchant.
     36       h_wire : HashCode;
     37 
     38       // Time when the deposit confirmation confirmation was generated.
     39       exchange_timestamp : Timestamp;
     40 
     41       // How much time does the merchant have to issue a refund
     42       // request?  Zero if refunds are not allowed.
     43       refund_deadline : Timestamp;
     44 
     45       // By what time does the exchange have to wire the funds?
     46       wire_deadline : Timestamp;
     47 
     48       // Amount to be deposited, excluding fee.  Calculated from the
     49       // amount with fee and the fee from the deposit request.
     50       total_without_fee : Amount;
     51 
     52       // Array of public keys of the deposited coins.
     53       coin_pubs : EddsaPublicKey[];
     54 
     55       // Array of deposit signatures of the deposited coins.
     56       // Must have the same length as coin_pubs.
     57       coin_sigs : EddsaSignature[];
     58 
     59       // The Merchant's public key.  Allows the merchant to later refund
     60       // the transaction or to inquire about the wire transfer identifier.
     61       merchant_pub : EddsaPublicKey;
     62 
     63       // Signature from the exchange of type
     64       // TALER_SIGNATURE_EXCHANGE_CONFIRM_DEPOSIT.
     65       exchange_sig : EddsaSignature;
     66 
     67       // Public signing key from the exchange matching exchange_sig.
     68       exchange_pub : EddsaPublicKey;
     69 
     70       // Exchange master signature over exchange_sig.
     71       master_sig : EddsaSignature;
     72 
     73       // True if this diagnostic was suppressed.
     74       suppressed : boolean;
     75 
     76     }
     77 
     78   .. note::
     79 
     80     This endpoint is still experimental. The endpoint will be further developed as needed.