Deactivate Card Definition

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Transitions the card definition to INACTIVE status.

Allowed transitions: ACTIVE -> INACTIVE.

POST /v2/loyalties/card-definitions/{id}/deactivate

Deactivate Card Definition

cURL

curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/card-definitions/{id}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "type": "INDIVIDUAL",
  "code_config": {
    "pattern": "<string>",
    "length": 123,
    "charset": "<string>",
    "prefix": "<string>",
    "postfix": "<string>"
  },
  "points_expiration": {
    "rolling_expiration": {
      "period": {
        "value": 2
      },
      "rounding": {
        "value": 6
      }
    },
    "calendar_expiration": {
      "expiration_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ],
      "period": {
        "value": 2
      }
    }
  },
  "pending_points": {
    "period_based": {
      "period": {
        "value": 2
      }
    },
    "fixed_dates": {
      "dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "event_based": {
      "event_types": [
        "<string>"
      ],
      "cancel_period": {
        "value": 2
      }
    }
  },
  "earning_limits": {
    "global": {
      "limits": [
        {
          "max": 2,
          "period": {
            "type": "CURRENT_PERIOD",
            "current_period": {}
          },
          "points": {
            "max": 1073741824
          }
        }
      ]
    },
    "transactions": {
      "limits": [
        {
          "max": 2,
          "min_amount": 2
        }
      ]
    }
  },
  "spending_limits": {
    "global": {
      "limits": [
        {
          "max": 2,
          "period": {
            "type": "CURRENT_PERIOD",
            "current_period": {}
          },
          "points": {
            "max": 1073741824
          }
        }
      ]
    },
    "transactions": {
      "limits": [
        {
          "type": "POINTS",
          "max": 2
        }
      ]
    }
  },
  "refunds": {
    "spent_points": {
      "methods": [
        {
          "type": "RETURN_POINTS"
        }
      ]
    },
    "earned_points": {
      "methods": [
        {}
      ]
    }
  },
  "balance_settings": {
    "allow_negative": true
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique card definition identifier.

Response

200

application/json

Deactivated card definition

Full card definition DTO returned by all CRUD endpoints.

id · string · required

name · string · required

type · enum<string> · required

Available options: INDIVIDUAL

status · enum<string> · required

Available options: DRAFT, ACTIVE, INACTIVE, DELETED

code_config · object · required

Show child attributes

points_expiration · object · required

Show child attributes

pending_points · object · required

Show child attributes

earning_limits · object · required

Show child attributes

spending_limits · object · required

Show child attributes

refunds · object · required

Show child attributes

balance_settings · object · required

Show child attributes

metadata · object · required

created_at · string<date-time> · required

object · string · required

Allowed value: "card_definition"

updated_at · string<date-time> | null