Contents

GET /monitoring/aml-holds#

Get a list of the wire transfers the exchange aggregated but did not execute.

The following query parameters are optional, and can be used to customise the response:

Request:

Query Parameters:

  • limit – A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20.

  • offset – An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX.

  • return_suppressed – A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false.

With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.

Response:

200 OK:

The auditor responds with a top level array of AmlHold objects. If no elements could be found, an empty array is returned

400 Bad request:

The request is malformed. Returned with an TALER_EC_GENERIC_PARAMETER_MALFORMED error code.

401 Unauthorized:

The request lacks valid authentication credentials. The response comes with a TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED.

500 Internal Server Error:

The server experienced an internal error. The response comes with a TALER_EC_GENERIC_DB_SETUP_FAILED or TALER_EC_GENERIC_DB_FETCH_FAILED error code.

Details:

interface AmlHold {

  // Unique row identifier
  row_id : Integer;

  // The wire transfer identifier the deposits were aggregated into.
  wtid : HashCode;

  // Hash of the payto:// URI of the account that should be credited.
  wire_target_h_payto : HashCode;

  // Full payto:// URI (RFC 8905) of the account that
  // should be credited.
  account : string;

  // What the exchange still owes on this wire transfer: the
  // deposits aggregated into it, minus refunds, minus deposit
  // fees. The wire fee is not yet deducted.
  amount : Amount;

  // Reason the exchange gave for not making the transfer:
  // "KYC" if a legitimization requirement against the recipient
  // is still open, "AMOUNT_TOO_SMALL" if the aggregate would not
  // cover the wire fee and the exchange is waiting for further
  // deposits, "NONE" if the exchange gave no reason at all.
  deferral_reason : "KYC" | "AMOUNT_TOO_SMALL" | "NONE";

  // The measure the exchange named as blocking the payout, or 0
  // if it named none. Note that the auditor checks whether that
  // measure is in fact open and raises a row inconsistency if it
  // is not, but still reports the hold as the exchange classified
  // it.
  legitimization_measure_serial_id : Integer;

  // When the auditor first saw this transfer being withheld.
  first_seen : Timestamp;

  // True if this diagnostic was suppressed.
  suppressed : boolean;

}

Note

This endpoint is still experimental. The endpoint will be further developed as needed.

Contents