get-monitoring-kycauth-in-inconsistency.rst (2629B)
1 .. http:get:: /monitoring/kycauth-in-inconsistency 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 :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 14 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 15 16 **Response:** 17 18 :http:statuscode:`200 OK`: 19 The auditor responds with a top level array of :ts:type:`KycauthInInconsistency` objects. 20 :http:statuscode:`400 Bad request`: 21 The request is malformed. Returned with an 22 ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. 23 :http:statuscode:`401 Unauthorized`: 24 The request lacks valid authentication credentials. 25 The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. 26 :http:statuscode:`500 Internal Server Error`: 27 The server experienced an internal error. 28 The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or 29 ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code. 30 31 **Details:** 32 33 .. ts:def:: KycauthInInconsistency 34 35 interface KycauthInInconsistency { 36 37 // Unique row identifier 38 row_id : Integer; 39 40 // Row of the wire transfer in the bank's credit history. This is 41 // what the two sides are matched on. 42 bank_row_id : Integer; 43 44 // Amount the exchange booked for this transfer, zero if the 45 // exchange has no record of it at all. 46 amount_exchange_expected : Amount; 47 48 // Amount the bank reports for this transfer, zero if the bank does 49 // not report it at all. 50 amount_wired : Amount; 51 52 // Account public key the transfer established, as known to 53 // whichever side did report the transfer. 54 account_pub : EddsaPublicKey; 55 56 // Time of the transfer 57 timestamp : Timestamp; 58 59 // Bank account that was debited, as known to whichever side did 60 // report the transfer. 61 account : string; 62 63 // Human readable diagnostic of the problem 64 diagnostic : string; 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.