taler-docs

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

get-private-tokenfamilies-TOKEN_FAMILY_SLUG.rst (2421B)

      1 .. http:get:: [/instances/$INSTANCES]/private/tokenfamilies/$TOKEN_FAMILY_SLUG
      2 
      3   This is used to get detailed information about a specific token family.
      4 
      5   **Required permission:** ``tokenfamilies-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The merchant backend has successfully returned the detailed information
     11     about a specific token family. Returns a `TokenFamilyDetails`.
     12 
     13   :http:statuscode:`404 Not found`:
     14     The merchant backend is unaware of the token family or instance.
     15 
     16   **Details:**
     17 
     18   The `TokenFamilyDetails` object describes a configured token family.
     19 
     20   .. ts:def:: TokenFamilyDetails
     21 
     22     interface TokenFamilyDetails {
     23 
     24       // Identifier for the token family consisting of unreserved characters
     25       // according to RFC 3986.
     26       slug: string;
     27 
     28       // Human-readable name for the token family.
     29       name: string;
     30 
     31       // Human-readable description for the token family.
     32       description: string;
     33 
     34       // Optional map from IETF BCP 47 language tags to localized descriptions.
     35       description_i18n?: { [lang_tag: string]: string };
     36 
     37       // Additional meta data, such as the ``trusted_domains``
     38       // or ``expected_domains``. Depends on the ``kind``.
     39       extra_data?: object;
     40 
     41       // Start time of the token family's validity period.
     42       // No token validities can start before this time
     43       // (but they could be sold before).
     44       valid_after: Timestamp;
     45 
     46       // End time of the token family's validity period.
     47       // No tokens will be accepted after this time.
     48       valid_before: Timestamp;
     49 
     50       // Validity duration of an issued token.
     51       duration: RelativeTime;
     52 
     53       // Rounding granularity for the start validity of keys.
     54       // The desired time is rounded down to a multiple of this
     55       // granularity and then the ``start_offset`` is added to
     56       // compute the actual start time of the token keys' validity.
     57       // The end is then computed by adding the ``duration``.
     58       validity_granularity: RelativeTime;
     59 
     60       // Offset in seconds to subtract from the start time rounded to ``validity_granularity``
     61       // to compute the actual start time for a key.
     62       start_offset: RelativeTime;
     63 
     64       // Kind of the token family.
     65       kind: TokenFamilyKind;
     66 
     67       // How many tokens have been issued for this family.
     68       issued: Integer;
     69 
     70       // How many tokens have been used for this family.
     71       used: Integer;
     72 
     73    }