Adyen · JSON Structure

Checkout Apple Pay Session Request Structure

ApplePaySessionRequest schema from Adyen API

Type: object Properties: 3 Required: 3
PaymentsFinancial ServicesFintech

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

Properties

displayName domainName merchantIdentifier

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-session-request-structure.json",
  "description": "ApplePaySessionRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "displayName": {
      "description": "This is the name that your shoppers will see in the Apple Pay interface.\n\nThe value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.",
      "type": "string"
    },
    "domainName": {
      "description": "The domain name you provided when you added Apple Pay in your Customer Area.\n\nThis must match the `window.location.hostname` of the web shop.",
      "type": "string"
    },
    "merchantIdentifier": {
      "description": "Your merchant identifier registered with Apple Pay.\n\nUse the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.",
      "type": "string"
    }
  },
  "required": [
    "domainName",
    "merchantIdentifier",
    "displayName"
  ],
  "name": "ApplePaySessionRequest"
}