{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-cancel-request-schema.json",
  "title": "CancelRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-cancel-api-openapi.yml#/components/schemas/CancelRequest",
  "properties": {
    "additionalData": {
      "additionalProperties": {
        "type": "string"
      },
      "x-anyOf": [
        {
          "$ref": "#/$defs/AdditionalData3DSecure"
        },
        {
          "$ref": "#/$defs/AdditionalDataAirline"
        },
        {
          "$ref": "#/$defs/AdditionalDataCarRental"
        },
        {
          "$ref": "#/$defs/AdditionalDataCommon"
        },
        {
          "$ref": "#/$defs/AdditionalDataLevel23"
        },
        {
          "$ref": "#/$defs/AdditionalDataLodging"
        },
        {
          "$ref": "#/$defs/AdditionalDataModifications"
        },
        {
          "$ref": "#/$defs/AdditionalDataOpenInvoice"
        },
        {
          "$ref": "#/$defs/AdditionalDataOpi"
        },
        {
          "$ref": "#/$defs/AdditionalDataRatepay"
        },
        {
          "$ref": "#/$defs/AdditionalDataRetry"
        },
        {
          "$ref": "#/$defs/AdditionalDataRisk"
        },
        {
          "$ref": "#/$defs/AdditionalDataRiskStandalone"
        },
        {
          "$ref": "#/$defs/AdditionalDataSubMerchant"
        },
        {
          "$ref": "#/$defs/AdditionalDataTemporaryServices"
        },
        {
          "$ref": "#/$defs/AdditionalDataWallets"
        }
      ],
      "description": "This field contains additional data, which may be required for a particular modification request.\n\nThe additionalData object consists of entries, each of which includes the key and value.",
      "type": "object"
    },
    "merchantAccount": {
      "description": "The merchant account that is used to process the payment.",
      "type": "string"
    },
    "mpiData": {
      "x-addedInVersion": "46",
      "description": "Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).",
      "$ref": "#/$defs/ThreeDSecureData"
    },
    "originalMerchantReference": {
      "x-addedInVersion": "30",
      "description": "The original merchant reference to cancel.",
      "type": "string"
    },
    "originalReference": {
      "description": "The original pspReference of the payment to modify.\nThis reference is returned in:\n* authorisation response\n* authorisation notification\n\n",
      "type": "string"
    },
    "platformChargebackLogic": {
      "x-addedInVersion": "68",
      "description": "Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).",
      "$ref": "#/$defs/PlatformChargebackLogic"
    },
    "reference": {
      "description": "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters.",
      "type": "string"
    },
    "splits": {
      "x-addedInVersion": "37",
      "description": "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).",
      "items": {
        "$ref": "#/$defs/Split"
      },
      "type": "array"
    },
    "tenderReference": {
      "x-addedInVersion": "25",
      "description": "The transaction reference provided by the PED. For point-of-sale integrations only.",
      "type": "string"
    },
    "uniqueTerminalId": {
      "x-addedInVersion": "25",
      "description": "Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.",
      "type": "string"
    }
  },
  "required": [
    "merchantAccount",
    "originalReference"
  ],
  "type": "object",
  "$defs": {
    "AdditionalData3DSecure": {
      "properties": {
        "allow3DS2": {
          "description": "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n",
          "type": "string"
        },
        "challengeWindowSize": {
          "description": "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05"
          ],
          "type": "string"
        },
        "executeThreeD": {
          "description": "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive  or other, national regulations. \n",
          "type": "string"
        },
        "mpiImplementationType": {
          "description": "In case of Secure+, this field must be set to **CUPSecurePlus**.",
          "type": "string"
        },
        "scaExemption": {
          "description": "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ",
          "type": "string"
        },
        "threeDSVersion": {
          "description": "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataAirline": {
      "properties": {
        "airline.agency_invoice_number": {
          "description": "The reference number for the invoice, issued by the agency.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 6 characters",
          "type": "string"
        },
        "airline.agency_plan_name": {
          "description": "The two-letter agency plan identifier.\n* Encoding: ASCII\n* minLength: 2 characters\n* maxLength: 2 characters",
          "type": "string"
        },
        "airline.airline_code": {
          "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.airline_designator_code": {
          "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.boarding_fee": {
          "description": "The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1 character\n* maxLength: 18 characters",
          "type": "string"
        },
        "airline.computerized_reservation_system": {
          "description": "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Encoding: ASCII\n* minLength: 4 characters\n* maxLength: 4 characters",
          "type": "string"
        },
        "airline.customer_reference_number": {
          "description": "The alphanumeric customer reference number.\n* Encoding: ASCII\n* maxLength: 20 characters\n* If you send more than 20 characters, the customer reference number is truncated\n* Must not be all spaces",
          "type": "string"
        },
        "airline.document_type": {
          "description": "A code that identifies the type of item bought. The description of the code can appear on credit card statements.\n* Encoding: ASCII\n* Example: Passenger ticket = 01\n* minLength: 2 characters\n* maxLength: 2 characters",
          "type": "string"
        },
        "airline.flight_date": {
          "description": "The flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10 characters\n* maxLength: 16 characters",
          "type": "string"
        },
        "airline.leg.carrier_code": {
          "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.class_of_travel": {
          "description": "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.date_of_travel": {
          "description": "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n* maxLength: 16 characters",
          "type": "string"
        },
        "airline.leg.depart_airport": {
          "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.depart_tax": {
          "description": "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.destination_code": {
          "description": "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.fare_base_code": {
          "description": "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.flight_number": {
          "description": "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.leg.stop_over_code": {
          "description": "A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character",
          "type": "string"
        },
        "airline.passenger.date_of_birth": {
          "description": "The passenger's date of birth.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10",
          "type": "string"
        },
        "airline.passenger.first_name": {
          "description": "The passenger's first name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII",
          "type": "string"
        },
        "airline.passenger.last_name": {
          "description": "The passenger's last name.\n> This field is required if the airline data includes passenger details or leg details.\n* Encoding: ASCII",
          "type": "string"
        },
        "airline.passenger.telephone_number": {
          "description": "The passenger's telephone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 30 characters",
          "type": "string"
        },
        "airline.passenger.traveller_type": {
          "description": "The IATA passenger type code (PTC).\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 6 characters",
          "type": "string"
        },
        "airline.passenger_name": {
          "description": "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.",
          "type": "string"
        },
        "airline.ticket_issue_address": {
          "description": "The address of the organization that issued the ticket.\n* minLength: 0 characters\n* maxLength: 16 characters",
          "type": "string"
        },
        "airline.ticket_number": {
          "description": "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.travel_agency_code": {
          "description": "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "airline.travel_agency_name": {
          "description": "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        }
      },
      "required": [
        "airline.passenger_name"
      ],
      "type": "object"
    },
    "AdditionalDataCarRental": {
      "properties": {
        "carRental.checkOutDate": {
          "description": "The pick-up date.\n* Date format: `yyyyMMdd`",
          "type": "string"
        },
        "carRental.customerServiceTollFreeNumber": {
          "description": "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.daysRented": {
          "description": "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces",
          "type": "string"
        },
        "carRental.fuelCharges": {
          "description": "Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12",
          "type": "string"
        },
        "carRental.insuranceCharges": {
          "description": "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.locationCity": {
          "description": "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.locationCountry": {
          "description": "The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n* Format: Alphanumeric\n* maxLength: 2",
          "type": "string"
        },
        "carRental.locationStateProvince": {
          "description": "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.noShowIndicator": {
          "description": "Indicates if the customer didn't pick up their rental car.\n* Y - Customer did not pick up their car\n* N - Not applicable",
          "type": "string"
        },
        "carRental.oneWayDropOffCharges": {
          "description": "The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* maxLength: 12",
          "type": "string"
        },
        "carRental.rate": {
          "description": "The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Alphanumeric\n* maxLength: 12",
          "type": "string"
        },
        "carRental.rateIndicator": {
          "description": "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate\n* W - Weekly rate",
          "type": "string"
        },
        "carRental.rentalAgreementNumber": {
          "description": "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.rentalClassId": {
          "description": "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.renterName": {
          "description": "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.returnCity": {
          "description": "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.returnCountry": {
          "description": "The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n* Format: Alphanumeric\n* maxLength: 2",
          "type": "string"
        },
        "carRental.returnDate": {
          "description": "The last date to return the car by.\n* Date format: `yyyyMMdd`\n* maxLength: 8",
          "type": "string"
        },
        "carRental.returnLocationId": {
          "description": "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.returnStateProvince": {
          "description": "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.",
          "type": "string"
        },
        "carRental.taxExemptIndicator": {
          "description": "Indicates if the goods or services were tax-exempt, or if tax was not paid on them.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
          "type": "string"
        },
        "travelEntertainmentAuthData.duration": {
          "description": "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4",
          "type": "string"
        },
        "travelEntertainmentAuthData.market": {
          "description": "Indicates what market-specific dataset will be submitted or is being submitted. Value should be 'A' for car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataCommon": {
      "properties": {
        "RequestedTestErrorResponseCode": {
          "description": "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.",
          "type": "string"
        },
        "allowPartialAuth": {
          "description": "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team.",
          "type": "string"
        },
        "authorisationType": {
          "description": "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.",
          "type": "string"
        },
        "customRoutingFlag": {
          "description": "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).",
          "type": "string"
        },
        "industryUsage": {
          "description": "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.",
          "enum": [
            "NoShow",
            "DelayedCharge"
          ],
          "type": "string"
        },
        "manualCapture": {
          "description": "Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.",
          "type": "string"
        },
        "networkTxReference": {
          "description": "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.",
          "type": "string"
        },
        "overwriteBrand": {
          "description": "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.",
          "type": "string"
        },
        "subMerchantCity": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.",
          "type": "string"
        },
        "subMerchantCountry": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.",
          "type": "string"
        },
        "subMerchantID": {
          "description": "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.",
          "type": "string"
        },
        "subMerchantName": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.",
          "type": "string"
        },
        "subMerchantPostalCode": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.",
          "type": "string"
        },
        "subMerchantState": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.",
          "type": "string"
        },
        "subMerchantStreet": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.",
          "type": "string"
        },
        "subMerchantTaxId": {
          "description": "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataLevel23": {
      "properties": {
        "enhancedSchemeData.customerReference": {
          "description": "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.destinationCountryCode": {
          "description": "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters",
          "type": "string"
        },
        "enhancedSchemeData.destinationPostalCode": {
          "description": "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space",
          "type": "string"
        },
        "enhancedSchemeData.destinationStateProvinceCode": {
          "description": "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space",
          "type": "string"
        },
        "enhancedSchemeData.dutyAmount": {
          "description": "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters",
          "type": "string"
        },
        "enhancedSchemeData.freightAmount": {
          "description": "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].commodityCode": {
          "description": "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].description": {
          "description": "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].discountAmount": {
          "description": "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].productCode": {
          "description": "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].quantity": {
          "description": "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].totalAmount": {
          "description": "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure": {
          "description": "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.itemDetailLine[itemNr].unitPrice": {
          "description": "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.orderDate": {
          "description": "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters",
          "type": "string"
        },
        "enhancedSchemeData.shipFromPostalCode": {
          "description": "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.totalTaxAmount": {
          "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataLodging": {
      "properties": {
        "lodging.checkInDate": {
          "description": "The arrival date.\n* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.",
          "type": "string"
        },
        "lodging.checkOutDate": {
          "description": "The departure date.\n* Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.",
          "type": "string"
        },
        "lodging.customerServiceTollFreeNumber": {
          "description": "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.",
          "type": "string"
        },
        "lodging.fireSafetyActIndicator": {
          "description": "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'.\n* Format: alphabetic\n* Max length: 1 character",
          "type": "string"
        },
        "lodging.folioCashAdvances": {
          "description": "The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters",
          "type": "string"
        },
        "lodging.folioNumber": {
          "description": "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.",
          "type": "string"
        },
        "lodging.foodBeverageCharges": {
          "description": "Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters",
          "type": "string"
        },
        "lodging.noShowIndicator": {
          "description": "Indicates if the customer didn't check in for their booking.\n Possible values: \n* **Y**: the customer didn't check in \n* **N**: the customer checked in",
          "type": "string"
        },
        "lodging.prepaidExpenses": {
          "description": "The prepaid expenses for the booking.\n* Format: numeric\n* Max length: 12 characters",
          "type": "string"
        },
        "lodging.propertyPhoneNumber": {
          "description": "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.",
          "type": "string"
        },
        "lodging.room1.numberOfNights": {
          "description": "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters",
          "type": "string"
        },
        "lodging.room1.rate": {
          "description": "The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number",
          "type": "string"
        },
        "lodging.totalRoomTax": {
          "description": "The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number",
          "type": "string"
        },
        "lodging.totalTax": {
          "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: numeric\n* Max length: 12 characters\n* Must not be a negative number",
          "type": "string"
        },
        "travelEntertainmentAuthData.duration": {
          "description": "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters",
          "type": "string"
        },
        "travelEntertainmentAuthData.market": {
          "description": "Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message.\n\n* Format: alphanumeric\n* Max length: 1 character",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataModifications": {
      "properties": {
        "installmentPaymentData.selectedInstallmentOption": {
          "description": "This is the installment option selected by the shopper. It is required only if specified by the user.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataOpenInvoice": {
      "properties": {
        "openinvoicedata.merchantData": {
          "description": "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.",
          "type": "string"
        },
        "openinvoicedata.numberOfLines": {
          "description": "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.",
          "type": "string"
        },
        "openinvoicedata.recipientFirstName": {
          "description": "First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.",
          "type": "string"
        },
        "openinvoicedata.recipientLastName": {
          "description": "Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].currencyCode": {
          "description": "The three-character ISO currency code.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].description": {
          "description": "A text description of the product the invoice line refers to.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].itemAmount": {
          "description": "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].itemId": {
          "description": "A unique id for this item. Required for RatePay if the description of each item is not unique.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].itemVatAmount": {
          "description": "The VAT due for one item in the invoice line, represented in minor units.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].itemVatPercentage": {
          "description": "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].numberOfItems": {
          "description": "The number of units purchased of a specific product.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].returnShippingCompany": {
          "description": "Name of the shipping company handling the the return shipment.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].returnTrackingNumber": {
          "description": "The tracking number for the return of the shipment.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].returnTrackingUri": {
          "description": "URI where the customer can track the return of their shipment.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].shippingCompany": {
          "description": "Name of the shipping company handling the delivery.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].shippingMethod": {
          "description": "Shipping method.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].trackingNumber": {
          "description": "The tracking number for the shipment.",
          "type": "string"
        },
        "openinvoicedataLine[itemNr].trackingUri": {
          "description": "URI where the customer can track their shipment.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataOpi": {
      "properties": {
        "opi.includeTransToken": {
          "description": "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataRatepay": {
      "properties": {
        "ratepay.installmentAmount": {
          "description": "Amount the customer has to pay each month.",
          "type": "string"
        },
        "ratepay.interestRate": {
          "description": "Interest rate of this installment.",
          "type": "string"
        },
        "ratepay.lastInstallmentAmount": {
          "description": "Amount of the last installment.",
          "type": "string"
        },
        "ratepay.paymentFirstday": {
          "description": "Calendar day of the first payment.",
          "type": "string"
        },
        "ratepaydata.deliveryDate": {
          "description": "Date the merchant delivered the goods to the customer.",
          "type": "string"
        },
        "ratepaydata.dueDate": {
          "description": "Date by which the customer must settle the payment.",
          "type": "string"
        },
        "ratepaydata.invoiceDate": {
          "description": "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.",
          "type": "string"
        },
        "ratepaydata.invoiceId": {
          "description": "Identification name or number for the invoice, defined by the merchant.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataRetry": {
      "properties": {
        "retry.chainAttemptNumber": {
          "description": "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
          "type": "string"
        },
        "retry.orderAttemptNumber": {
          "description": "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
          "type": "string"
        },
        "retry.skipRetry": {
          "description": "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataRisk": {
      "properties": {
        "riskdata.[customFieldName]": {
          "description": "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].amountPerItem": {
          "description": "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].brand": {
          "description": "Brand of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].category": {
          "description": "Category of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].color": {
          "description": "Color of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].currency": {
          "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].itemID": {
          "description": "ID of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].manufacturer": {
          "description": "Manufacturer of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].productTitle": {
          "description": "A text description of the product the invoice line refers to.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].quantity": {
          "description": "Quantity of the item purchased.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].receiverEmail": {
          "description": "Email associated with the given product in the basket (usually in electronic gift cards).",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].size": {
          "description": "Size of the item.",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].sku": {
          "description": "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).",
          "type": "string"
        },
        "riskdata.basket.item[itemNr].upc": {
          "description": "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).",
          "type": "string"
        },
        "riskdata.promotions.promotion[itemNr].promotionCode": {
          "description": "Code of the promotion.",
          "type": "string"
        },
        "riskdata.promotions.promotion[itemNr].promotionDiscountAmount": {
          "description": "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
          "type": "string"
        },
        "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency": {
          "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
          "type": "string"
        },
        "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage": {
          "description": "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.",
          "type": "string"
        },
        "riskdata.promotions.promotion[itemNr].promotionName": {
          "description": "Name of the promotion.",
          "type": "string"
        },
        "riskdata.riskProfileReference": {
          "description": "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).",
          "type": "string"
        },
        "riskdata.skipRisk": {
          "description": "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataRiskStandalone": {
      "properties": {
        "PayPal.CountryCode": {
          "description": "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.",
          "type": "string"
        },
        "PayPal.EmailId": {
          "description": "Shopper's email.",
          "type": "string"
        },
        "PayPal.FirstName": {
          "description": "Shopper's first name.",
          "type": "string"
        },
        "PayPal.LastName": {
          "description": "Shopper's last name.",
          "type": "string"
        },
        "PayPal.PayerId": {
          "description": "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.",
          "type": "string"
        },
        "PayPal.Phone": {
          "description": "Shopper's phone number.",
          "type": "string"
        },
        "PayPal.ProtectionEligibility": {
          "description": "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.",
          "type": "string"
        },
        "PayPal.TransactionId": {
          "description": "Unique transaction ID of the payment.",
          "type": "string"
        },
        "avsResultRaw": {
          "description": "Raw AVS result received from the acquirer, where available. Example: D",
          "type": "string"
        },
        "bin": {
          "description": "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).",
          "type": "string"
        },
        "cvcResultRaw": {
          "description": "Raw CVC result received from the acquirer, where available. Example: 1",
          "type": "string"
        },
        "riskToken": {
          "description": "Unique identifier or token for the shopper's card details.",
          "type": "string"
        },
        "threeDAuthenticated": {
          "description": "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true",
          "type": "string"
        },
        "threeDOffered": {
          "description": "A Boolean value indicating whether 3DS was offered for this payment. Example: true",
          "type": "string"
        },
        "tokenDataType": {
          "description": "Required for PayPal payments only. The only supported value is: **paypal**.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataSubMerchant": {
      "properties": {
        "subMerchant.numberOfSubSellers": {
          "description": "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].city": {
          "description": "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].country": {
          "description": "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].id": {
          "description": "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].mcc": {
          "description": "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].name": {
          "description": "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement  that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].postalCode": {
          "description": "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].state": {
          "description": "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].street": {
          "description": "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters",
          "type": "string"
        },
        "subMerchant.subSeller[subSellerNr].taxId": {
          "description": "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataTemporaryServices": {
      "properties": {
        "enhancedSchemeData.customerReference": {
          "description": "The customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25",
          "type": "string"
        },
        "enhancedSchemeData.employeeName": {
          "description": "The name or ID of the person working in a temporary capacity.\n* maxLength: 40.  \n* Must not be all spaces. \n*Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.jobDescription": {
          "description": "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.",
          "type": "string"
        },
        "enhancedSchemeData.regularHoursRate": {
          "description": "The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* maxLength: 7\n* Must not be empty\n* Can be all zeros",
          "type": "string"
        },
        "enhancedSchemeData.regularHoursWorked": {
          "description": "The hours worked.\n* maxLength: 7\n* Must not be empty\n* Can be all zeros",
          "type": "string"
        },
        "enhancedSchemeData.requestName": {
          "description": "The name of the person requesting temporary services.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces",
          "type": "string"
        },
        "enhancedSchemeData.tempStartDate": {
          "description": "The billing period start date.\n* Format: ddMMyy\n* maxLength: 6",
          "type": "string"
        },
        "enhancedSchemeData.tempWeekEnding": {
          "description": "The billing period end date.\n* Format: ddMMyy\n* maxLength: 6",
          "type": "string"
        },
        "enhancedSchemeData.totalTaxAmount": {
          "description": "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00\n* maxLength: 12",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AdditionalDataWallets": {
      "properties": {
        "androidpay.token": {
          "description": "The Android Pay token retrieved from the SDK.",
          "type": "string"
        },
        "masterpass.transactionId": {
          "description": "The Mastercard Masterpass Transaction ID retrieved from the SDK.",
          "type": "string"
        },
        "payment.token": {
          "description": "The Apple Pay token retrieved from the SDK.",
          "type": "string"
        },
        "paywithgoogle.token": {
          "description": "The Google Pay token retrieved from the SDK.",
          "type": "string"
        },
        "samsungpay.token": {
          "description": "The Samsung Pay token retrieved from the SDK.",
          "type": "string"
        },
        "visacheckout.callId": {
          "description": "The Visa Checkout Call ID retrieved from the SDK.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "PlatformChargebackLogic": {
      "properties": {
        "behavior": {
          "x-addedInVersion": "68",
          "description": "The method of handling the chargeback.\n\nPossible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.",
          "enum": [
            "deductAccordingToSplitRatio",
            "deductFromLiableAccount",
            "deductFromOneBalanceAccount"
          ],
          "type": "string"
        },
        "costAllocationAccount": {
          "x-addedInVersion": "68",
          "description": "The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account.",
          "type": "string"
        },
        "targetAccount": {
          "x-addedInVersion": "68",
          "description": "The unique identifier of the balance account against which the disputed amount is booked.\n\nRequired if `behavior` is **deductFromOneBalanceAccount**.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Split": {
      "properties": {
        "account": {
          "description": "The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.",
          "type": "string"
        },
        "amount": {
          "description": "The amount of the split item.\n\n* Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).\n* Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.",
          "$ref": "#/$defs/SplitAmount"
        },
        "description": {
          "description": "Your description for the split item.",
          "type": "string"
        },
        "reference": {
          "description": "Your unique reference for the split item.\n\nThis is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).\n\nFor the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.",
          "type": "string"
        },
        "type": {
          "description": "The type of the split item.\n\nPossible values:\n\n* [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.\n* [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.",
          "enum": [
            "BalanceAccount",
            "Commission",
            "Default",
            "MarketPlace",
            "PaymentFee",
            "Remainder",
            "Surcharge",
            "Tip",
            "VAT"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "SplitAmount": {
      "properties": {
        "currency": {
          "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.",
          "maxLength": 3,
          "minLength": 3,
          "type": "string"
        },
        "value": {
          "description": "The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "ThreeDSecureData": {
      "properties": {
        "authenticationResponse": {
          "description": "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.",
          "enum": [
            "Y",
            "N",
            "U",
            "A"
          ],
          "type": "string"
        },
        "cavv": {
          "description": "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).",
          "format": "byte",
          "type": "string"
        },
        "cavvAlgorithm": {
          "description": "The CAVV algorithm used. Include this only for 3D Secure 1.",
          "type": "string"
        },
        "challengeCancel": {
          "x-addedInVersion": "67",
          "description": "Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).",
          "enum": [
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "07"
          ],
          "type": "string"
        },
        "directoryResponse": {
          "description": "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.",
          "enum": [
            "A",
            "C",
            "D",
            "I",
            "N",
            "R",
            "U",
            "Y"
          ],
          "type": "string"
        },
        "dsTransID": {
          "x-addedInVersion": "40",
          "description": "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.",
          "type": "string"
        },
        "eci": {
          "description": "The electronic commerce indicator.",
          "type": "string"
        },
        "riskScore": {
          "x-addedInVersion": "67",
          "description": "Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.",
          "type": "string"
        },
        "threeDSVersion": {
          "x-addedInVersion": "40",
          "description": "The version of the 3D Secure protocol.",
          "type": "string"
        },
        "tokenAuthenticationVerificationValue": {
          "x-addedInVersion": "68",
          "description": "Network token authentication verification value (TAVV). The network token cryptogram.",
          "format": "byte",
          "type": "string"
        },
        "transStatusReason": {
          "x-addedInVersion": "67",
          "description": "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).",
          "type": "string"
        },
        "xid": {
          "description": "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).",
          "format": "byte",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}