taler-docs

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

set-coin-suspended.rst (801B)

      1 .. ts:op:: setCoinSuspended
      2 
      3   Set a coin as (un-)suspended.  Suspended coins won't be used for
      4   payments.
      5 
      6   **Request:**
      7 
      8     The request must be a `SetCoinSuspendedRequest` object.
      9 
     10   **Response:**
     11 
     12     On success, the result is an empty object.
     13 
     14   **Side effects:**
     15 
     16     Marks the coin as (un-)suspended; suspended coins are excluded from
     17     payments.
     18 
     19   **Details:**
     20 
     21     Only fresh coins can be suspended, and only suspended coins can be
     22     un-suspended; requesting any other status transition is a no-op.
     23     An unknown ``coinPub`` is silently ignored (a warning is logged).
     24     Suspension updates the coin availability counters of the
     25     denomination accordingly.
     26 
     27 .. ts:def:: SetCoinSuspendedRequest
     28 
     29   interface SetCoinSuspendedRequest {
     30     coinPub: string;
     31     suspended: boolean;
     32   }