get-monitoring-deposit-confirmations.rst (3622B)
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 Pagination follows the :ref:`row-id-pagination` convention. The non-zero signed 10 ``limit`` defaults to ``-20``. 11 12 :query limit: Optional non-zero signed number of records; negative values request descending row IDs. 13 :query offset: Optional :ts:type:`SafeUint64` row ID from which to begin. 14 :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. 15 16 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 17 18 **Response:** 19 20 :http:statuscode:`200 OK`: 21 The auditor responds with a :ts:type:`DepositConfirmationsResponse` object. Its ``records`` field is empty if no matching elements were found. 22 :http:statuscode:`400 Bad request`: 23 The request is malformed. Returned with an 24 ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. 25 :http:statuscode:`401 Unauthorized`: 26 The request lacks valid authentication credentials. 27 The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. 28 :http:statuscode:`500 Internal Server Error`: 29 The server experienced an internal error. 30 The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``, 31 ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or 32 ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code. 33 34 **Details:** 35 36 .. ts:def:: DepositConfirmationsResponse 37 38 interface DepositConfirmationsResponse { 39 40 records: DepositConfirmations[]; 41 42 } 43 44 .. ts:def:: DepositConfirmations 45 46 interface DepositConfirmations { 47 48 // Row id in the exchange database 49 deposit_confirmation_serial_id : SafeUint64; 50 51 // Hash over the contract for which this deposit is made. 52 h_contract_terms : HashCode; 53 54 // Hash over the policy concerning this deposit 55 h_policy : HashCode; 56 57 // Hash over the wiring information of the merchant. 58 h_wire : HashCode; 59 60 // Time when the deposit confirmation confirmation was generated. 61 exchange_timestamp : Timestamp; 62 63 // How much time does the merchant have to issue a refund 64 // request? Zero if refunds are not allowed. 65 refund_deadline : Timestamp; 66 67 // By what time does the exchange have to wire the funds? 68 wire_deadline : Timestamp; 69 70 // Amount to be deposited, excluding fee. Calculated from the 71 // amount with fee and the fee from the deposit request. 72 total_without_fee : Amount; 73 74 // Array of public keys of the deposited coins. 75 coin_pubs : EddsaPublicKey[]; 76 77 // Array of deposit signatures of the deposited coins. 78 // Must have the same length as coin_pubs. 79 coin_sigs : EddsaSignature[]; 80 81 // The Merchant's public key. Allows the merchant to later refund 82 // the transaction or to inquire about the wire transfer identifier. 83 merchant_pub : EddsaPublicKey; 84 85 // Signature from the exchange of type 86 // TALER_SIGNATURE_EXCHANGE_CONFIRM_DEPOSIT. 87 exchange_sig : EddsaSignature; 88 89 // Public signing key from the exchange matching exchange_sig. 90 exchange_pub : EddsaPublicKey; 91 92 // Exchange master signature over exchange_sig. 93 master_sig : EddsaSignature; 94 95 // True if this diagnostic was suppressed. 96 suppressed : boolean; 97 98 } 99 100 .. note:: 101 102 This endpoint is still experimental. The endpoint will be further developed as needed.