Adyen · JSON Structure

Checkout Pay Pal Details Structure

PayPalDetails schema from Adyen API

Type: object Properties: 9 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

checkoutAttemptId orderID payeePreferred payerID payerSelected recurringDetailReference storedPaymentMethodId subtype 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-pay-pal-details-structure.json",
  "description": "PayPalDetails schema from Adyen API",
  "type": "object",
  "properties": {
    "checkoutAttemptId": {
      "x-addedInVersion": "68",
      "description": "The checkout attempt identifier.",
      "type": "string"
    },
    "orderID": {
      "description": "The unique ID associated with the order.",
      "type": "string"
    },
    "payeePreferred": {
      "description": "IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED",
      "type": "string"
    },
    "payerID": {
      "description": "The unique ID associated with the payer.",
      "type": "string"
    },
    "payerSelected": {
      "description": "PAYPAL or PAYPAL_CREDIT",
      "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"
    },
    "subtype": {
      "description": "The type of flow to initiate.",
      "enum": [
        "redirect",
        "sdk"
      ],
      "type": "string"
    },
    "type": {
      "default": "paypal",
      "description": "**paypal**",
      "enum": [
        "paypal"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "name": "PayPalDetails"
}