Adyen · JSON Structure

Checkout Card Donations Structure

CardDonations schema from Adyen API

Type: object Properties: 19
PaymentsFinancial ServicesFintech

CardDonations is a JSON Structure definition published by Adyen, describing 19 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

brand checkoutAttemptId cupsecureplus.smscode cvc encryptedCardNumber encryptedExpiryMonth encryptedExpiryYear encryptedSecurityCode expiryMonth expiryYear fundingSource holderName networkPaymentReference number recurringDetailReference shopperNotificationReference storedPaymentMethodId threeDS2SdkVersion type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-card-donations-structure.json",
  "description": "CardDonations schema from Adyen API",
  "type": "object",
  "properties": {
    "brand": {
      "description": "Secondary brand of the card. For example: **plastix**, **hmclub**.",
      "type": "string"
    },
    "checkoutAttemptId": {
      "x-addedInVersion": "68",
      "description": "The checkout attempt identifier.",
      "type": "string"
    },
    "cupsecureplus.smscode": {
      "deprecated": true,
      "type": "string"
    },
    "cvc": {
      "description": "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
      "type": "string"
    },
    "encryptedCardNumber": {
      "description": "The encrypted card number.",
      "maxLength": 15000,
      "type": "string"
    },
    "encryptedExpiryMonth": {
      "description": "The encrypted card expiry month.",
      "maxLength": 15000,
      "type": "string"
    },
    "encryptedExpiryYear": {
      "description": "The encrypted card expiry year.",
      "maxLength": 15000,
      "type": "string"
    },
    "encryptedSecurityCode": {
      "description": "The encrypted card verification code.",
      "maxLength": 15000,
      "type": "string"
    },
    "expiryMonth": {
      "description": "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
      "type": "string"
    },
    "expiryYear": {
      "description": "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
      "type": "string"
    },
    "fundingSource": {
      "description": "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
      "enum": [
        "credit",
        "debit"
      ],
      "type": "string"
    },
    "holderName": {
      "description": "The name of the card holder.",
      "type": "string"
    },
    "networkPaymentReference": {
      "description": "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.",
      "type": "string"
    },
    "number": {
      "description": "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
      "type": "string"
    },
    "recurringDetailReference": {
      "deprecated": true,
      "x-deprecatedInVersion": "49",
      "x-deprecatedMessage": "Use `storedPaymentMethodId` instead.",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "type": "string"
    },
    "shopperNotificationReference": {
      "description": "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.",
      "type": "string"
    },
    "storedPaymentMethodId": {
      "x-addedInVersion": "49",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "maxLength": 64,
      "type": "string"
    },
    "threeDS2SdkVersion": {
      "description": "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.",
      "maxLength": 12,
      "type": "string"
    },
    "type": {
      "default": "scheme",
      "description": "Default payment method details. Common for scheme payment methods, and for simple payment method details.",
      "enum": [
        "bcmc",
        "scheme",
        "networkToken",
        "giftcard",
        "card"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false,
  "name": "CardDonations"
}