taler-docs

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

get-monitoring-pending-deposits.rst (2430B)

      1 .. http:get:: /monitoring/pending-deposits
      2 
      3   Get a list of pending deposits.
      4   @since protocol **v2**.
      5 
      6   The following query parameters are optional, and can be used to customise the response:
      7 
      8   **Request:**
      9 
     10   Pagination follows the :ref:`row-id-pagination` convention.  The non-zero signed
     11   ``limit`` defaults to ``-20``.
     12 
     13   :query limit: Optional non-zero signed number of records; negative values request descending row IDs.
     14   :query offset: Optional :ts:type:`SafeUint64` row ID from which to begin.
     15   :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.
     16 
     17   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     18 
     19   **Response:**
     20 
     21   :http:statuscode:`200 OK`:
     22     The auditor responds with a :ts:type:`GetPendingDepositsResponse` object.
     23     Its ``records`` field is empty if no matching elements were found.
     24   :http:statuscode:`400 Bad request`:
     25     The request is malformed. Returned with an
     26     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     27   :http:statuscode:`401 Unauthorized`:
     28     The request lacks valid authentication credentials.
     29     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     30   :http:statuscode:`500 Internal Server Error`:
     31     The server experienced an internal error.
     32     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     33     ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or
     34     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     35 
     36   **Details:**
     37 
     38   .. ts:def:: GetPendingDepositsResponse
     39 
     40     interface GetPendingDepositsResponse {
     41 
     42       // Pending deposits.
     43       records: PendingDepositEntry[];
     44 
     45     }
     46 
     47   .. ts:def:: PendingDepositEntry
     48 
     49     interface PendingDepositEntry {
     50 
     51       // Unique row identifier in the auditor table
     52       row_id : SafeUint64;
     53 
     54       // Row identifier in the exchange's batch deposit table
     55       batch_deposit_serial_id : SafeUint64;
     56 
     57       // Amount that was aggregated early.
     58       total_amount : Amount;
     59 
     60       // Hash of the bank account that should have received the funds.
     61       h_wire : HashCode;
     62 
     63       // When was the deadline for the transfer.
     64       deadline : Timestamp;
     65 
     66       // True if this diagnostic was suppressed.
     67       suppressed : boolean;
     68 
     69     }
     70 
     71   .. note::
     72 
     73     This endpoint is still experimental. The endpoint will be further developed as needed.