RecurringDetailsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-recurring-details-request-schema.json",
  "title": "RecurringDetailsRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-listrecurringdetails-api-openapi.yml#/components/schemas/RecurringDetailsRequest",
  "properties": {
    "merchantAccount": {
      "description": "The merchant account identifier you want to process the (transaction) request with.",
      "type": "string"
    },
    "recurring": {
      "description": "A container for the type of a recurring contract to be retrieved.\n\nThe contract value needs to match the contract value submitted in the payment transaction used to create a recurring contract.\nHowever, if `ONECLICK,RECURRING` is the original contract definition in the initial payment, then `contract` should take either `ONECLICK` or `RECURRING`, depending on whether or not you want the shopper to enter their card's security code when they finalize their purchase.",
      "$ref": "#/$defs/Recurring"
    },
    "shopperReference": {
      "description": "The reference you use to uniquely identify the shopper (e.g. user ID or account ID).",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "shopperReference"
  ],
  "type": "object",
  "$defs": {
    "Recurring": {
      "properties": {
        "contract": {
          "description": "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).",
          "enum": [
            "ONECLICK",
            "RECURRING",
            "PAYOUT"
          ],
          "type": "string"
        },
        "recurringDetailName": {
          "description": "A descriptive name for this detail.",
          "type": "string"
        },
        "recurringExpiry": {
          "x-addedInVersion": "40",
          "description": "Date after which no further authorisations shall be performed. Only for 3D Secure 2.",
          "format": "date-time",
          "type": "string"
        },
        "recurringFrequency": {
          "x-addedInVersion": "40",
          "description": "Minimum number of days between authorisations. Only for 3D Secure 2.",
          "type": "string"
        },
        "tokenService": {
          "x-addedInVersion": "25",
          "description": "The name of the token service.",
          "enum": [
            "VISATOKENSERVICE",
            "MCTOKENSERVICE",
            "AMEXTOKENSERVICE",
            "TOKEN_SHARING"
          ],
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}