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

This is used to list all configured token families for an instance.

Required permission: tokenfamilies-read

Response:

200 OK:

The merchant backend has successfully returned all token families. Returns a TokenFamiliesList.

404 Not found:

The merchant backend is unaware of the instance.

Details:

 // TODO: Add pagination

 interface TokenFamiliesList {

   // All configured token families of this instance.
   token_families: TokenFamilySummary[];

}

 interface TokenFamilySummary {
   // 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.
   // @since protocol **v23**.
   description: string;

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

   // Start time of the token family's validity period.
   valid_after: Timestamp;

   // End time of the token family's validity period.
   valid_before: Timestamp;

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