Adyen · JSON Structure

Recurring Disable Request Structure

DisableRequest schema from Adyen API

Type: object Properties: 4 Required: 2
PaymentsFinancial ServicesFintech

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

Properties

contract merchantAccount recurringDetailReference shopperReference

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/recurring-disable-request-structure.json",
  "description": "DisableRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "contract": {
      "x-addedInVersion": "3",
      "description": "Specify the contract if you only want to disable a specific use.\n\nThis field can be set to one of the following values, or to their combination (comma-separated):\n* ONECLICK\n* RECURRING\n* PAYOUT",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account identifier with which you want to process the transaction.",
      "type": "string"
    },
    "recurringDetailReference": {
      "description": "The ID that uniquely identifies the recurring detail reference.\n\nIf it is not provided, the whole recurring contract of the `shopperReference` will be disabled, which includes all recurring details.",
      "type": "string"
    },
    "shopperReference": {
      "description": "The ID that uniquely identifies the shopper.\n\nThis `shopperReference` must be the same as the `shopperReference` used in the initial payment.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "shopperReference"
  ],
  "name": "DisableRequest"
}