RecurringDetail is a JSON Structure definition published by Adyen, describing 17 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/recurring-recurring-detail-structure.json",
"description": "RecurringDetail schema from Adyen API",
"type": "object",
"properties": {
"additionalData": {
"x-addedInVersion": "5",
"additionalProperties": {
"type": "string"
},
"description": "This field contains additional data, which may be returned in a particular response.\n\nThe additionalData object consists of entries, each of which includes the key and value.",
"type": "object"
},
"alias": {
"x-addedInVersion": "4",
"description": "The alias of the credit card number.\n\nApplies only to recurring contracts storing credit card details",
"type": "string"
},
"aliasType": {
"x-addedInVersion": "4",
"description": "The alias type of the credit card number.\n\nApplies only to recurring contracts storing credit card details.",
"type": "string"
},
"bank": {
"description": "A container for bank account data.",
"$ref": "#/components/schemas/BankAccount"
},
"billingAddress": {
"x-addedInVersion": "4",
"description": "The billing address.",
"$ref": "#/components/schemas/Address"
},
"card": {
"description": "A container for card data.",
"$ref": "#/components/schemas/Card"
},
"contractTypes": {
"x-addedInVersion": "12",
"description": "Types of recurring contracts.",
"items": {
"type": "string"
},
"type": "array"
},
"creationDate": {
"description": "The date when the recurring details were created.",
"type": "datetime"
},
"firstPspReference": {
"x-addedInVersion": "4",
"description": "The `pspReference` of the first recurring payment that created the recurring detail.",
"type": "string"
},
"name": {
"description": "An optional descriptive name for this recurring detail.",
"type": "string"
},
"networkTxReference": {
"x-addedInVersion": "68",
"description": "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.",
"type": "string"
},
"paymentMethodVariant": {
"x-addedInVersion": "2",
"description": "The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).",
"type": "string"
},
"recurringDetailReference": {
"description": "The reference that uniquely identifies the recurring detail.",
"type": "string"
},
"shopperName": {
"x-addedInVersion": "4",
"description": "The name of the shopper.",
"$ref": "#/components/schemas/Name"
},
"socialSecurityNumber": {
"x-addedInVersion": "4",
"description": "A shopper's social security number (only in countries where it is legal to collect).",
"type": "string"
},
"tokenDetails": {
"x-addedInVersion": "2",
"$ref": "#/components/schemas/TokenDetails"
},
"variant": {
"description": "The payment method, such as \u201cmc\", \"visa\", \"ideal\", \"paypal\".",
"type": "string"
}
},
"required": [
"recurringDetailReference",
"variant"
],
"name": "RecurringDetail"
}