Contents

PATCH [/instances/$INSTANCE]/private/tokenfamilies/$TOKEN_FAMILY_SLUG#

This is used to update a token family.

Required permission: tokenfamilies-write

Request:

The request must be a TokenFamilyUpdateRequest.

Response:

204 No Content:

The token family was successsful updated.

400 Bad Request:

The request body is malformed (e.g. valid_after >= valid_before). Returned with TALER_EC_GENERIC_PARAMETER_MALFORMED.

404 Not found:

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

500 Internal Server Error:

The server experienced an internal failure. Returned with TALER_EC_GENERIC_DB_STORE_FAILED or TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE.

Details:

 interface TokenFamilyUpdateRequest {

   // 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.
   valid_after: Timestamp;

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

}