taler-docs

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

get-monitoring-aml-holds.rst (3154B)

      1 .. http:get:: /monitoring/aml-holds
      2 
      3   Get a list of the wire transfers the exchange aggregated but did not execute.
      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:`AmlHold` objects. If no elements could be found, an empty array is returned
     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 
     32 
     33   **Details:**
     34 
     35   .. ts:def:: AmlHold
     36 
     37     interface AmlHold {
     38 
     39       // Unique row identifier
     40       row_id : Integer;
     41 
     42       // The wire transfer identifier the deposits were aggregated into.
     43       wtid : HashCode;
     44 
     45       // Hash of the payto:// URI of the account that should be credited.
     46       wire_target_h_payto : HashCode;
     47 
     48       // Full payto:// URI (RFC 8905) of the account that
     49       // should be credited.
     50       account : string;
     51 
     52       // What the exchange still owes on this wire transfer: the
     53       // deposits aggregated into it, minus refunds, minus deposit
     54       // fees. The wire fee is not yet deducted.
     55       amount : Amount;
     56 
     57       // Reason the exchange gave for not making the transfer:
     58       // "KYC" if a legitimization requirement against the recipient
     59       // is still open, "AMOUNT_TOO_SMALL" if the aggregate would not
     60       // cover the wire fee and the exchange is waiting for further
     61       // deposits, "NONE" if the exchange gave no reason at all.
     62       deferral_reason : "KYC" | "AMOUNT_TOO_SMALL" | "NONE";
     63 
     64       // The measure the exchange named as blocking the payout, or 0
     65       // if it named none. Note that the auditor checks whether that
     66       // measure is in fact open and raises a row inconsistency if it
     67       // is not, but still reports the hold as the exchange classified
     68       // it.
     69       legitimization_measure_serial_id : Integer;
     70 
     71       // When the auditor first saw this transfer being withheld.
     72       first_seen : Timestamp;
     73 
     74       // True if this diagnostic was suppressed.
     75       suppressed : boolean;
     76 
     77     }
     78 
     79   .. note::
     80 
     81     This endpoint is still experimental. The endpoint will be further developed as needed.