CardConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-card-configuration-schema.json",
  "title": "CardConfiguration",
  "description": "CardConfiguration schema from Adyen API",
  "type": "object",
  "properties": {
    "activation": {
      "description": "Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.",
      "type": "string"
    },
    "activationUrl": {
      "description": "Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. \n\nMaximum length: 255 characters.",
      "maxLength": 255,
      "type": "string"
    },
    "bulkAddress": {
      "description": "Overrides the shipment bulk address defined in the `configurationProfileId`.",
      "$ref": "#/components/schemas/BulkAddress"
    },
    "cardImageId": {
      "description": "The ID of the card image. This is the image that will be printed on the full front of the card.",
      "type": "string"
    },
    "carrier": {
      "description": "Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.",
      "type": "string"
    },
    "carrierImageId": {
      "description": "The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.",
      "type": "string"
    },
    "configurationProfileId": {
      "description": "The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them.\n\nFor example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.",
      "type": "string"
    },
    "currency": {
      "description": "The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.",
      "type": "string"
    },
    "envelope": {
      "description": "Overrides the envelope design ID defined in the `configurationProfileId`. ",
      "type": "string"
    },
    "insert": {
      "description": "Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.",
      "type": "string"
    },
    "language": {
      "description": "The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.",
      "type": "string"
    },
    "logoImageId": {
      "description": "The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.",
      "type": "string"
    },
    "pinMailer": {
      "description": "Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.",
      "type": "string"
    },
    "shipmentMethod": {
      "description": "Overrides the logistics company defined in the `configurationProfileId`.",
      "type": "string"
    }
  },
  "required": [
    "configurationProfileId"
  ]
}