Card Definitions

Create Card Definition

Changed on
<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

Creates a new card definition. Only name and type are required; all other sections default server-side as follows:

  • code_config: 10-character alphanumeric code pattern (##########)
  • points_expiration: NO_EXPIRATION
  • pending_points: IMMEDIATE
  • earning_limits: global NO_LIMIT, transactions NO_LIMIT
  • spending_limits: global NO_LIMIT, transactions NO_LIMIT
  • refunds: spent points NONE, earned points NONE
  • balance_settings: allow_negative: false
  • pay_with_points: NO_PAYMENTS

Cross-field rules:

  • balance_settings.allow_negative can only be true when points_expiration.type is NO_EXPIRATION. Additionally, the earned points refund mode REVOKE_BELOW_ZERO requires balance_settings.allow_negative to be true.
  • The earned points refund method REVOKE_FROM_PENDING requires pending_points.type to be one of PERIOD_BASED, FIXED_DATES, EVENT_BASED.
post/v2/loyalties/card-definitions

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/card-definitions
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Request body

namestring required

Card definition name.

type'INDIVIDUAL' required

Card definition type. Currently only INDIVIDUAL is supported.

status'DRAFT' | 'ACTIVE' | 'null' nullable

Initial status. Allowed values on create are DRAFT and ACTIVE. Defaults to DRAFT when omitted.

metadataobject nullable

Arbitrary key-value metadata attached to the card definition.

Response

The created card definition.

idstring required

Unique card definition ID.

namestring required

Card definition name.

type'INDIVIDUAL' required

Card definition type.

status'DRAFT' | 'ACTIVE' | 'DELETED' required

Current card definition status.

metadataobject required

Arbitrary key-value metadata. Empty object when not set.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

Last update timestamp (ISO 8601). null when the card definition has never been updated.

object'card_definition' required

Object type marker. Always card_definition.

Changes

  • v2d29b33490051Revision changes
    • breaking

      added to the ////////////// request property allOf list

    • breaking

      added to the ////////////// request property allOf list

    • breaking

      added subschema #2 to the ///////////// request property allOf list

    • breaking

      added to the ////////////////// request property allOf list

    • breaking

      added to the ////////////////// request property allOf list

    • breaking

      the ////////////////// request property type changed from object to no type

    • breaking

      the ////////////// request property type changed from object to no type

    • breaking

      the ////////////// request property type changed from object to no type

    • breaking

      the ///////////// request property type changed from object to no type

    • breaking

      the ////////////////// request property type changed from object to no type

    • breaking

      the ///// response's property type changed from object to no type for status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • warning

      removed the request property ///////////////////

    • warning

      removed the request property ///////////////

    • warning

      removed the request property ///////////////

    • warning

      removed the request property ///////////////

    • warning

      removed the request property ///////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property ///////////////////

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added subschema #2 to the ///// response property allOf list for the response status

  • v2be14b3318eb3Revision changes
    • breaking

      added the new required request property ///////////////////

    • breaking

      added the new required request property ///////////////

    • breaking

      added the new required request property ///////////////

    • breaking

      added the new required request property ///////////////

    • breaking

      added the new required request property ///////////////

    • breaking

      added the new required request property //////////////

    • breaking

      added the new required request property ///////////////////

    • breaking

      the ////////////////// request property type changed from no type to object

    • breaking

      the ////////////// request property type changed from no type to object

    • breaking

      the ////////////// request property type changed from no type to object

    • breaking

      the ///////////// request property type changed from no type to object

    • breaking

      the ////////////////// request property type changed from no type to object

    • breaking

      the ///// response's property type changed from no type to object for status

    • warning

      removed from the ////////////// request property allOf list

    • warning

      removed from the ////////////// request property allOf list

    • warning

      removed subschema #2 from the ///////////// request property allOf list

    • warning

      removed from the ////////////////// request property allOf list

    • warning

      removed from the ////////////////// request property allOf list

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status