Adyen · Schema

Apple Pay

PaymentsFinancial ServicesFintech

Properties

Name Type Description
applePayToken string The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
checkoutAttemptId string The checkout attempt identifier.
fundingSource string 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**.
recurringDetailReference string This is the `recurringDetailReference` returned in the response when you created the token.
storedPaymentMethodId string This is the `recurringDetailReference` returned in the response when you created the token.
type string **applepay**
View JSON Schema on GitHub

JSON Schema

adyen-applepaydetails-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApplePayDetails",
  "title": "Apple Pay",
  "additionalProperties": false,
  "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"
  ],
  "type": "object"
}