CostEstimateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CostEstimateRequest",
  "title": "CostEstimateRequest",
  "properties": {
    "amount": {
      "description": "The transaction amount used as a base for the cost estimation.",
      "$ref": "#/components/schemas/Amount"
    },
    "assumptions": {
      "description": "Assumptions made for the expected characteristics of the transaction, for which the charges are being estimated.",
      "$ref": "#/components/schemas/CostEstimateAssumptions"
    },
    "cardNumber": {
      "description": "The card number (4-19 characters) for PCI compliant use cases. Do not use any separators.\n\n> Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.",
      "maxLength": 19,
      "minLength": 4,
      "type": "string"
    },
    "encryptedCardNumber": {
      "description": "Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field.\n\n> Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account identifier you want to process the (transaction) request with.",
      "type": "string"
    },
    "merchantDetails": {
      "description": "Additional data for merchants who don't use Adyen as the payment authorisation gateway.",
      "$ref": "#/components/schemas/MerchantDetails"
    },
    "recurring": {
      "description": "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/online-payments/tokenization).",
      "$ref": "#/components/schemas/Recurring"
    },
    "selectedRecurringDetailReference": {
      "description": "The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.",
      "type": "string"
    },
    "shopperInteraction": {
      "description": "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
      "enum": [
        "Ecommerce",
        "ContAuth",
        "Moto",
        "POS"
      ],
      "type": "string"
    },
    "shopperReference": {
      "description": "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.",
      "type": "string"
    }
  },
  "required": [
    "amount",
    "merchantAccount"
  ],
  "type": "object"
}