GET [/instances/$INSTANCES]/private/tokenfamilies/$TOKEN_FAMILY_SLUG

This is used to get detailed information about a specific token family.

Required permission: tokenfamilies-read

Response:

200 OK:

The merchant backend has successfully returned the detailed information about a specific token family. Returns a TokenFamilyDetails.

404 Not found:

The merchant backend is unaware of the token family or instance.

Details:

The TokenFamilyDetails object describes a configured token family.

 interface TokenFamilyDetails {

   // Identifier for the token family consisting of unreserved characters
   // according to RFC 3986.
   slug: string;

   // Human-readable name for the token family.
   name: string;

   // Human-readable description for the token family.
   description: string;

   // Optional map from IETF BCP 47 language tags to localized descriptions.
   description_i18n?: { [lang_tag: string]: string };

   // Additional meta data, such as the trusted_domains
   // or expected_domains. Depends on the kind.
   extra_data?: object;

   // Start time of the token family's validity period.
   // No token validities can start before this time
   // (but they could be sold before).
   valid_after: Timestamp;

   // End time of the token family's validity period.
   // No tokens will be accepted after this time.
   valid_before: Timestamp;

   // Validity duration of an issued token.
   duration: RelativeTime;

   // Rounding granularity for the start validity of keys.
   // The desired time is rounded down to a multiple of this
   // granularity and then the start_offset is added to
   // compute the actual start time of the token keys' validity.
   // The end is then computed by adding the duration.
   validity_granularity: RelativeTime;

   // Offset in seconds to subtract from the start time rounded to validity_granularity
   // to compute the actual start time for a key.
   start_offset: RelativeTime;

   // Kind of the token family.
   kind: TokenFamilyKind;

   // How many tokens have been issued for this family.
   issued: Integer;

   // How many tokens have been used for this family.
   used: Integer;

}