taler-docs

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

get-monitoring-kycauth-in-inconsistency.rst (2917B)

      1 .. http:get:: /monitoring/kycauth-in-inconsistencies
      2 
      3   Get a list of KYCAUTH in inconsistencies 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 
     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:`KycauthInInconsistencyResponse` object. Its ``records`` field is empty if no matching elements were found.
     23   :http:statuscode:`400 Bad request`:
     24     The request is malformed. Returned with an
     25     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     26   :http:statuscode:`401 Unauthorized`:
     27     The request lacks valid authentication credentials.
     28     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     29   :http:statuscode:`500 Internal Server Error`:
     30     The server experienced an internal error.
     31     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED``,
     32     ``TALER_EC_GENERIC_DB_FETCH_FAILED``, or
     33     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE`` error code.
     34 
     35   **Details:**
     36 
     37   .. ts:def:: KycauthInInconsistencyResponse
     38 
     39     interface KycauthInInconsistencyResponse {
     40 
     41       records: KycauthInInconsistency[];
     42 
     43     }
     44 
     45   .. ts:def:: KycauthInInconsistency
     46 
     47     interface KycauthInInconsistency {
     48 
     49       // Unique row identifier
     50       row_id : SafeUint64;
     51 
     52       // Row of the wire transfer in the bank's credit history.  This is
     53       // what the two sides are matched on.
     54       bank_row_id : SafeUint64;
     55 
     56       // Amount the exchange booked for this transfer, zero if the
     57       // exchange has no record of it at all.
     58       amount_exchange_expected : Amount;
     59 
     60       // Amount the bank reports for this transfer, zero if the bank does
     61       // not report it at all.
     62       amount_wired : Amount;
     63 
     64       // Account public key the transfer established, as known to
     65       // whichever side did report the transfer.
     66       account_pub : EddsaPublicKey;
     67 
     68       // Time of the transfer
     69       timestamp : Timestamp;
     70 
     71       // Bank account that was debited, as known to whichever side did
     72       // report the transfer.
     73       account : string;
     74 
     75       // Human readable diagnostic of the problem
     76       diagnostic : string;
     77 
     78       // True if this diagnostic was suppressed.
     79       suppressed : boolean;
     80 
     81     }
     82 
     83   .. note::
     84 
     85     This endpoint is still experimental. The endpoint will be further developed as needed.