Adyen · JSON Structure

Checkout Apple Pay Details Structure

ApplePayDetails schema from Adyen API

Type: object Properties: 6 Required: 1
PaymentsFinancial ServicesFintech

ApplePayDetails is a JSON Structure definition published by Adyen, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

applePayToken checkoutAttemptId fundingSource recurringDetailReference storedPaymentMethodId 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-apple-pay-details-structure.json",
  "description": "ApplePayDetails schema from Adyen API",
  "type": "object",
  "properties": {
    "applePayToken": {
      "description": "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.",
      "maxLength": 10000,
      "type": "string"
    },
    "checkoutAttemptId": {
      "x-addedInVersion": "68",
      "description": "The checkout attempt identifier.",
      "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"
    },
    "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"
    },
    "storedPaymentMethodId": {
      "x-addedInVersion": "49",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "maxLength": 64,
      "type": "string"
    },
    "type": {
      "default": "applepay",
      "description": "**applepay**",
      "enum": [
        "applepay"
      ],
      "type": "string"
    }
  },
  "required": [
    "applePayToken"
  ],
  "additionalProperties": false,
  "name": "ApplePayDetails"
}