---
title: "Create a payment session"
method: POST
path: "/sessions"
tags: ["Payments"]
---

# Create a payment session

`POST /sessions`

Creates a payment session for [Drop-in](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Drop-in), [Components](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Components), and [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Hosted+Checkout) integrations.

The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow.

You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.

## Headers

- `Idempotency-Key` string

## Request body

- CreateCheckoutSessionRequest
  - `accountInfo` AccountInfo
    - `accountAgeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `accountChangeDate` string, date-time — Date when the shopper's account was last changed.
    - `accountChangeIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `accountCreationDate` string, date-time — Date when the shopper's account was created.
    - `accountType` 'notApplicable' | 'credit' | 'debit' — Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit
    - `addCardAttemptsDay` integer — Number of attempts the shopper tried to add a card to their account in the last day.
    - `deliveryAddressUsageDate` string, date-time — Date the selected delivery address was first used.
    - `deliveryAddressUsageIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `homePhone` string — Shopper's home phone number (including the country code).
    - `mobilePhone` string — Shopper's mobile phone number (including the country code).
    - `passwordChangeDate` string, date-time — Date when the shopper last changed their password.
    - `passwordChangeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `pastTransactionsDay` integer — Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.
    - `pastTransactionsYear` integer — Number of all transactions (successful and abandoned) from this shopper in the past year.
    - `paymentAccountAge` string, date-time — Date this payment method was added to the shopper's account.
    - `paymentAccountIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `purchasesLast6Months` integer — Number of successful purchases in the last six months.
    - `suspiciousActivity` boolean — Whether suspicious activity was recorded on this account.
    - `workPhone` string — Shopper's work phone number (including the country code).
  - `additionalAmount` Amount
    - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
    - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
  - `additionalData` object — This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
  - `allowedPaymentMethods` string[] — List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPaymentMethods":["ideal","applepay"]`
  - `amount` Amount, required
    - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
    - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
  - `applicationInfo` ApplicationInfo
    - `adyenLibrary` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `adyenPaymentSource` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `externalPlatform` ExternalPlatform
      - `integrator` string — External platform integrator.
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `merchantApplication` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `merchantDevice` MerchantDevice
      - `os` string — Operating system running on the merchant device.
      - `osVersion` string — Version of the operating system on the merchant device.
      - `reference` string — Merchant device reference.
    - `shopperInteractionDevice` ShopperInteractionDevice
      - `locale` string — Locale on the shopper interaction device.
      - `os` string — Operating system running on the shopper interaction device.
      - `osVersion` string — Version of the operating system on the shopper interaction device.
  - `authenticationData` AuthenticationData
    - `attemptAuthentication` 'always' | 'never' — Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). Possible values: * **always**: Perform 3D Secure authentication. * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.
    - `authenticationOnly` boolean — Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. Default: **false**.
    - `threeDSRequestData` ThreeDSRequestData
      - `challengeWindowSize` '01' | '02' | '03' | '04' | '05' — Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
      - `dataOnly` 'false' | 'true' — Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
      - `nativeThreeDS` 'preferred' | 'disabled' — Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
      - `threeDSVersion` '2.1.0' | '2.2.0' — The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
  - `billingAddress` BillingAddress
    - `city` string, required — The name of the city. Maximum length: 3000 characters.
    - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
    - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - `blockedPaymentMethods` string[] — List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaymentMethods":["ideal","applepay"]`
  - `captureDelayHours` integer — The delay between the authorisation and scheduled auto-capture, specified in hours.
  - `channel` 'iOS' | 'Android' | 'Web' — The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * **iOS** * **Android** * **Web**
  - `company` Company
    - `homepage` string — The company website's home page.
    - `name` string — The company name.
    - `registrationNumber` string — Registration number of the company.
    - `registryLocation` string — Registry location of the company.
    - `taxId` string — Tax ID of the company.
    - `type` string — The company type.
  - `countryCode` string — The shopper's two-letter country code.
  - `dateOfBirth` string, date — The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
  - `deliverAt` string, date-time — The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
  - `deliveryAddress` DeliveryAddress
    - `city` string, required — The name of the city. Maximum length: 3000 characters.
    - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    - `firstName` string
    - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
    - `lastName` string
    - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - `enableOneClick` boolean — When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
  - `enablePayOut` boolean — When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
  - `enableRecurring` boolean — When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
  - `expiresAt` string, date-time — The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation.
  - `fundOrigin` FundOrigin
    - `billingAddress` Address
      - `city` string, required — The name of the city. Maximum length: 3000 characters.
      - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
      - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
      - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
      - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
      - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    - `shopperEmail` string — The email address of the person funding the money.
    - `shopperName` Name
      - `firstName` string, required — The first name.
      - `lastName` string, required — The last name.
    - `telephoneNumber` string — The phone number of the person funding the money.
    - `walletIdentifier` string — The unique identifier of the wallet where the funds are coming from.
  - `fundRecipient` FundRecipient
    - `IBAN` string — The IBAN of the bank account where the funds are being transferred to.
    - `billingAddress` Address
      - `city` string, required — The name of the city. Maximum length: 3000 characters.
      - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
      - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
      - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
      - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
      - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    - `paymentMethod` CardDetails
      - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
      - `brand` string — Secondary brand of the card. For example: **plastix**, **hmclub**.
      - `checkoutAttemptId` string — The checkout attempt identifier.
      - `cupsecureplus.smscode` string
      - `cvc` string — The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `encryptedCard` string — Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
      - `encryptedCardNumber` string — The encrypted card number.
      - `encryptedExpiryMonth` string — The encrypted card expiry month.
      - `encryptedExpiryYear` string — The encrypted card expiry year.
      - `encryptedPassword` string — This field contains an encrypted, one-time password or an authentication code provided by the cardholder.
      - `encryptedSecurityCode` string — The encrypted card verification code.
      - `expiryMonth` string — The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `expiryYear` string — The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `fastlaneData` string — The encoded fastlane data blob
      - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
      - `holderName` string — The name of the card holder.
      - `networkPaymentReference` string — The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
      - `number` string — The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token.
      - `sdkData` string — Base64-encoded JSON object containing SDK related parameters required by the SDK
      - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
      - `srcCorrelationId` string — An identifier used for the Click to Pay transaction.
      - `srcDigitalCardId` string — The SRC reference for the Click to Pay token.
      - `srcScheme` string — The scheme that is being used for Click to Pay.
      - `srcTokenReference` string — The reference for the Click to Pay token.
      - `storedPaymentMethodId` string — This is the `recurringDetailReference` returned in the response when you created the token.
      - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
      - `type` 'bcmc' | 'scheme' | 'networkToken' | 'giftcard' | 'card' | 'clicktopay' — Default payment method details. Common for scheme payment methods, and for simple payment method details.
    - `shopperEmail` string — The email address of the shopper.
    - `shopperName` Name
      - `firstName` string, required — The first name.
      - `lastName` string, required — The last name.
    - `shopperReference` string — Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    - `storedPaymentMethodId` string — This is the `recurringDetailReference` returned in the response when you created the token.
    - `subMerchant` SubMerchant
      - `city` string — The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters
      - `country` string — The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters
      - `mcc` string — The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits
      - `name` string — The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters
      - `taxId` string — The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ
    - `telephoneNumber` string — The telephone number of the shopper.
    - `walletIdentifier` string — The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier.
    - `walletOwnerTaxId` string — The tax identifier of the person receiving the funds.
    - `walletPurpose` 'identifiedBoleto' | 'transferDifferentWallet' | 'transferOwnWallet' | 'transferSameWallet' | 'unidentifiedBoleto' — The purpose of a digital wallet transaction.
  - `installmentOptions` object — A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
  - `lineItems` LineItem[] — Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
    - `amountExcludingTax` integer — Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `amountIncludingTax` integer — Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `brand` string — Brand of the item.
    - `color` string — Color of the item.
    - `description` string — Description of the line item.
    - `id` string — ID of the line item.
    - `imageUrl` string — Link to the picture of the purchased item.
    - `itemCategory` string — Item category, used by the payment methods PayPal and Ratepay.
    - `manufacturer` string — Manufacturer of the item.
    - `marketplaceSellerId` string — Marketplace seller id.
    - `productUrl` string — Link to the purchased item.
    - `quantity` integer — Number of items.
    - `receiverEmail` string — Email associated with the given product in the basket (usually in electronic gift cards).
    - `size` string — Size of the item.
    - `sku` string — Stock keeping unit.
    - `taxAmount` integer — Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `taxPercentage` integer — Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent)
    - `upc` string — Universal Product Code.
  - `mandate` Mandate
    - `amount` string, required — The billing amount (in minor units) of the recurring transactions.
    - `amountRule` 'max' | 'exact' — The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
    - `billingAttemptsRule` 'on' | 'before' | 'after' — The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
    - `billingDay` string — The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
    - `count` string — The number of transactions that can be performed within the given frequency.
    - `endsAt` string, required — End date of the billing plan, in YYYY-MM-DD format.
    - `frequency` 'adhoc' | 'daily' | 'weekly' | 'biWeekly' | 'monthly' | 'quarterly' | 'halfYearly' | 'yearly', required — The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
    - `remarks` string — The message shown by UPI to the shopper on the approval screen.
    - `startsAt` string — Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
  - `mcc` string — The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
  - `merchantAccount` string, required — The merchant account identifier, with which you want to process the transaction.
  - `merchantOrderReference` string — This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.
  - `metadata` object — Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. * Maximum 20 characters per key. * Maximum 80 characters per value.
  - `mode` 'embedded' | 'hosted' — Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration
  - `mpiData` ThreeDSecureData
    - `authenticationResponse` 'Y' | 'N' | 'U' | 'A' — In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
    - `cavv` string, byte — The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
    - `cavvAlgorithm` string — The CAVV algorithm used. Include this only for 3D Secure 1.
    - `challengeCancel` '01' | '02' | '03' | '04' | '05' | '06' | '07' — 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).
    - `directoryResponse` 'A' | 'C' | 'D' | 'I' | 'N' | 'R' | 'U' | 'Y' — In 3D Secure 2, this is the `transStatus` from the `ARes`.
    - `dsTransID` string — Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
    - `eci` string — The electronic commerce indicator.
    - `riskScore` string — Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
    - `threeDSVersion` string — The version of the 3D Secure protocol.
    - `tokenAuthenticationVerificationValue` string, byte — Network token authentication verification value (TAVV). The network token cryptogram.
    - `transStatusReason` string — 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).
    - `xid` string, byte — Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
  - `platformChargebackLogic` PlatformChargebackLogic
    - `behavior` 'deductFromOneBalanceAccount' | 'deductAccordingToSplitRatio' | 'deductFromLiableAccount' — The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
    - `costAllocationAccount` string — 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.
    - `targetAccount` string — The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**.
  - `recurringExpiry` string — Date after which no further authorisations shall be performed. Only for 3D Secure 2.
  - `recurringFrequency` string — Minimum number of days between authorisations. Only for 3D Secure 2.
  - `recurringProcessingModel` 'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile' — Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
  - `redirectFromIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting back from the issuer.
  - `redirectToIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting to the issuer.
  - `reference` string, required — The reference to uniquely identify a payment.
  - `returnUrl` string, required — The URL to return to in case of a redirection. The format depends on the channel. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.example.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
  - `riskData` RiskData
    - `clientData` string — Contains client-side data, like the device fingerprint, cookies, and specific browser settings.
    - `customFields` object — Any custom fields used as part of the input to configured risk rules.
    - `fraudOffset` integer — An integer value that is added to the normal fraud score. The value can be either positive or negative.
    - `profileReference` string — The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.
  - `shopperConversionId` string — Use this if you made a `/paymentMethods` request to get the payment methods for the shopper's checkout session. A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.
  - `shopperEmail` string — The shopper's email address.
  - `shopperIP` string — The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
  - `shopperInteraction` 'Ecommerce' | 'ContAuth' | 'Moto' | 'POS' — Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `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. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder 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). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
  - `shopperLocale` string — The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
  - `shopperName` ShopperName
    - `firstName` string, required — The first name.
    - `lastName` string, required — The last name.
  - `shopperReference` string — Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
  - `shopperStatement` string — The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.
  - `showInstallmentAmount` boolean — Set to true to show the payment amount per installment.
  - `showRemovePaymentMethodButton` boolean — Set to **true** to show a button that lets the shopper remove a stored payment method.
  - `socialSecurityNumber` string — The shopper's social security number.
  - `splitCardFundingSources` boolean — Boolean value indicating whether the card payment method should be split into separate debit and credit options.
  - `splits` Split[] — An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    - `account` string — The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): 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.
    - `amount` SplitAmount
      - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.
      - `value` integer, required — The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
    - `description` string — Your description for the split item.
    - `reference` string — Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For 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` 'AcquiringFees' | 'AdyenCommission' | 'AdyenFees' | 'AdyenMarkup' | 'BalanceAccount' | 'Commission' | 'Default' | 'Interchange' | 'MarketPlace' | 'PaymentFee' | 'Remainder' | 'SchemeFee' | 'Surcharge' | 'Tip' | 'TopUp' | 'VAT', required — The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of the payment (specified in `amount`) to the specified `account`. * Transaction fees types that you can book to the specified `account`: * **AcquiringFees**: The aggregated amount of the interchange and scheme fees. * **PaymentFee**: The aggregated amount of all transaction fees. * **AdyenFees**: The aggregated amount of Adyen's commission and markup fees. * **AdyenCommission**: The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **Interchange**: The fees paid to the issuer for each payment made with the card network. * **SchemeFee**: The fees paid to the card scheme for using their network. * **Commission**: Your platform's commission on the payment (specified in `amount`), booked to your liable balance account. * **Remainder**: The amount left over after a currency conversion, booked to the specified `account`. * **Surcharge**: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * **TopUp**: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * **VAT**: The value-added tax charged on the payment, booked to your platforms liable balance account. * **Default**: In very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**.
  - `store` string — Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
  - `storeFiltrationMode` 'exclusive' | 'inclusive' | 'skipFilter' — Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
  - `storePaymentMethod` boolean — When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
  - `storePaymentMethodMode` 'askForConsent' | 'disabled' | 'enabled' — Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the Drop-in/Component shows a checkbox where the shopper can select to store their payment details for card payments. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent.
  - `telephoneNumber` string — The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
  - `themeId` string — Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area.
  - `thirdPartyTokenRedundancyInfo` ThirdPartyTokenRedundancyInfo
    - `requestParameters` object — Request-specific parameter values to populate the template placeholders. Each key must match a placeholder defined in the template referenced by `requestTemplateCode`.
    - `requestTemplateCode` string, required — Identifier for the third-party token request template configured in your Adyen account. This template defines the structure and endpoint for token requests.
  - `threeDS2RequestData` CheckoutSessionThreeDS2RequestData
    - `homePhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
    - `mobilePhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
    - `threeDSRequestorChallengeInd` '01' | '02' | '03' | '04' | '05' | '06' — Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
    - `workPhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
  - `threeDSAuthenticationOnly` boolean — Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.
  - `trustedShopper` boolean — Set to true if the payment should be routed to a trusted MID.

## Response `201`

Created - the request has been fulfilled and has resulted in one or more new resources being created.

- CreateCheckoutSessionResponse
  - `accountInfo` AccountInfo
    - `accountAgeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `accountChangeDate` string, date-time — Date when the shopper's account was last changed.
    - `accountChangeIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `accountCreationDate` string, date-time — Date when the shopper's account was created.
    - `accountType` 'notApplicable' | 'credit' | 'debit' — Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit
    - `addCardAttemptsDay` integer — Number of attempts the shopper tried to add a card to their account in the last day.
    - `deliveryAddressUsageDate` string, date-time — Date the selected delivery address was first used.
    - `deliveryAddressUsageIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `homePhone` string — Shopper's home phone number (including the country code).
    - `mobilePhone` string — Shopper's mobile phone number (including the country code).
    - `passwordChangeDate` string, date-time — Date when the shopper last changed their password.
    - `passwordChangeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `pastTransactionsDay` integer — Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.
    - `pastTransactionsYear` integer — Number of all transactions (successful and abandoned) from this shopper in the past year.
    - `paymentAccountAge` string, date-time — Date this payment method was added to the shopper's account.
    - `paymentAccountIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days
    - `purchasesLast6Months` integer — Number of successful purchases in the last six months.
    - `suspiciousActivity` boolean — Whether suspicious activity was recorded on this account.
    - `workPhone` string — Shopper's work phone number (including the country code).
  - `additionalAmount` Amount
    - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
    - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
  - `additionalData` object — This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
  - `allowedPaymentMethods` string[] — List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPaymentMethods":["ideal","applepay"]`
  - `amount` Amount, required
    - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
    - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
  - `applicationInfo` ApplicationInfo
    - `adyenLibrary` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `adyenPaymentSource` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `externalPlatform` ExternalPlatform
      - `integrator` string — External platform integrator.
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `merchantApplication` CommonField
      - `name` string — Name of the field. For example, Name of External Platform.
      - `version` string — Version of the field. For example, Version of External Platform.
    - `merchantDevice` MerchantDevice
      - `os` string — Operating system running on the merchant device.
      - `osVersion` string — Version of the operating system on the merchant device.
      - `reference` string — Merchant device reference.
    - `shopperInteractionDevice` ShopperInteractionDevice
      - `locale` string — Locale on the shopper interaction device.
      - `os` string — Operating system running on the shopper interaction device.
      - `osVersion` string — Version of the operating system on the shopper interaction device.
  - `authenticationData` AuthenticationData
    - `attemptAuthentication` 'always' | 'never' — Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). Possible values: * **always**: Perform 3D Secure authentication. * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.
    - `authenticationOnly` boolean — Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. Default: **false**.
    - `threeDSRequestData` ThreeDSRequestData
      - `challengeWindowSize` '01' | '02' | '03' | '04' | '05' — Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen
      - `dataOnly` 'false' | 'true' — Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible.
      - `nativeThreeDS` 'preferred' | 'disabled' — Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.
      - `threeDSVersion` '2.1.0' | '2.2.0' — The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**
  - `billingAddress` BillingAddress
    - `city` string, required — The name of the city. Maximum length: 3000 characters.
    - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
    - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - `blockedPaymentMethods` string[] — List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaymentMethods":["ideal","applepay"]`
  - `captureDelayHours` integer — The delay between the authorisation and scheduled auto-capture, specified in hours.
  - `channel` 'iOS' | 'Android' | 'Web' — The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * **iOS** * **Android** * **Web**
  - `company` Company
    - `homepage` string — The company website's home page.
    - `name` string — The company name.
    - `registrationNumber` string — Registration number of the company.
    - `registryLocation` string — Registry location of the company.
    - `taxId` string — Tax ID of the company.
    - `type` string — The company type.
  - `countryCode` string — The shopper's two-letter country code.
  - `dateOfBirth` string, date-time — The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
  - `deliverAt` string, date-time — The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.
  - `deliveryAddress` DeliveryAddress
    - `city` string, required — The name of the city. Maximum length: 3000 characters.
    - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
    - `firstName` string
    - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
    - `lastName` string
    - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
    - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
    - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
  - `enableOneClick` boolean — When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
  - `enablePayOut` boolean — When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
  - `enableRecurring` boolean — When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
  - `expiresAt` string, date-time, required — The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation.
  - `fundOrigin` FundOrigin
    - `billingAddress` Address
      - `city` string, required — The name of the city. Maximum length: 3000 characters.
      - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
      - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
      - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
      - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
      - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    - `shopperEmail` string — The email address of the person funding the money.
    - `shopperName` Name
      - `firstName` string, required — The first name.
      - `lastName` string, required — The last name.
    - `telephoneNumber` string — The phone number of the person funding the money.
    - `walletIdentifier` string — The unique identifier of the wallet where the funds are coming from.
  - `fundRecipient` FundRecipient
    - `IBAN` string — The IBAN of the bank account where the funds are being transferred to.
    - `billingAddress` Address
      - `city` string, required — The name of the city. Maximum length: 3000 characters.
      - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
      - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters.
      - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
      - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
      - `street` string, required — The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.
    - `paymentMethod` CardDetails
      - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
      - `brand` string — Secondary brand of the card. For example: **plastix**, **hmclub**.
      - `checkoutAttemptId` string — The checkout attempt identifier.
      - `cupsecureplus.smscode` string
      - `cvc` string — The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `encryptedCard` string — Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details.
      - `encryptedCardNumber` string — The encrypted card number.
      - `encryptedExpiryMonth` string — The encrypted card expiry month.
      - `encryptedExpiryYear` string — The encrypted card expiry year.
      - `encryptedPassword` string — This field contains an encrypted, one-time password or an authentication code provided by the cardholder.
      - `encryptedSecurityCode` string — The encrypted card verification code.
      - `expiryMonth` string — The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `expiryYear` string — The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `fastlaneData` string — The encoded fastlane data blob
      - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
      - `holderName` string — The name of the card holder.
      - `networkPaymentReference` string — The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
      - `number` string — The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
      - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token.
      - `sdkData` string — Base64-encoded JSON object containing SDK related parameters required by the SDK
      - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
      - `srcCorrelationId` string — An identifier used for the Click to Pay transaction.
      - `srcDigitalCardId` string — The SRC reference for the Click to Pay token.
      - `srcScheme` string — The scheme that is being used for Click to Pay.
      - `srcTokenReference` string — The reference for the Click to Pay token.
      - `storedPaymentMethodId` string — This is the `recurringDetailReference` returned in the response when you created the token.
      - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
      - `type` 'bcmc' | 'scheme' | 'networkToken' | 'giftcard' | 'card' | 'clicktopay' — Default payment method details. Common for scheme payment methods, and for simple payment method details.
    - `shopperEmail` string — The email address of the shopper.
    - `shopperName` Name
      - `firstName` string, required — The first name.
      - `lastName` string, required — The last name.
    - `shopperReference` string — Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
    - `storedPaymentMethodId` string — This is the `recurringDetailReference` returned in the response when you created the token.
    - `subMerchant` SubMerchant
      - `city` string — The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters
      - `country` string — The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters
      - `mcc` string — The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits
      - `name` string — The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters
      - `taxId` string — The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ
    - `telephoneNumber` string — The telephone number of the shopper.
    - `walletIdentifier` string — The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier.
    - `walletOwnerTaxId` string — The tax identifier of the person receiving the funds.
    - `walletPurpose` 'identifiedBoleto' | 'transferDifferentWallet' | 'transferOwnWallet' | 'transferSameWallet' | 'unidentifiedBoleto' — The purpose of a digital wallet transaction.
  - `id` string, required — A unique identifier of the session.
  - `installmentOptions` object — A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
  - `lineItems` LineItem[] — Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
    - `amountExcludingTax` integer — Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `amountIncludingTax` integer — Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `brand` string — Brand of the item.
    - `color` string — Color of the item.
    - `description` string — Description of the line item.
    - `id` string — ID of the line item.
    - `imageUrl` string — Link to the picture of the purchased item.
    - `itemCategory` string — Item category, used by the payment methods PayPal and Ratepay.
    - `manufacturer` string — Manufacturer of the item.
    - `marketplaceSellerId` string — Marketplace seller id.
    - `productUrl` string — Link to the purchased item.
    - `quantity` integer — Number of items.
    - `receiverEmail` string — Email associated with the given product in the basket (usually in electronic gift cards).
    - `size` string — Size of the item.
    - `sku` string — Stock keeping unit.
    - `taxAmount` integer — Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units).
    - `taxPercentage` integer — Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent)
    - `upc` string — Universal Product Code.
  - `mandate` Mandate
    - `amount` string, required — The billing amount (in minor units) of the recurring transactions.
    - `amountRule` 'max' | 'exact' — The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`.
    - `billingAttemptsRule` 'on' | 'before' | 'after' — The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date.
    - `billingDay` string — The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.
    - `count` string — The number of transactions that can be performed within the given frequency.
    - `endsAt` string, required — End date of the billing plan, in YYYY-MM-DD format.
    - `frequency` 'adhoc' | 'daily' | 'weekly' | 'biWeekly' | 'monthly' | 'quarterly' | 'halfYearly' | 'yearly', required — The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.
    - `remarks` string — The message shown by UPI to the shopper on the approval screen.
    - `startsAt` string — Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
  - `mcc` string — The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
  - `merchantAccount` string, required — The merchant account identifier, with which you want to process the transaction.
  - `merchantOrderReference` string — This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.
  - `metadata` object — Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. * Maximum 20 characters per key. * Maximum 80 characters per value.
  - `mode` 'embedded' | 'hosted' — Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration
  - `mpiData` ThreeDSecureData
    - `authenticationResponse` 'Y' | 'N' | 'U' | 'A' — In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.
    - `cavv` string, byte — The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
    - `cavvAlgorithm` string — The CAVV algorithm used. Include this only for 3D Secure 1.
    - `challengeCancel` '01' | '02' | '03' | '04' | '05' | '06' | '07' — 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).
    - `directoryResponse` 'A' | 'C' | 'D' | 'I' | 'N' | 'R' | 'U' | 'Y' — In 3D Secure 2, this is the `transStatus` from the `ARes`.
    - `dsTransID` string — Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
    - `eci` string — The electronic commerce indicator.
    - `riskScore` string — Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
    - `threeDSVersion` string — The version of the 3D Secure protocol.
    - `tokenAuthenticationVerificationValue` string, byte — Network token authentication verification value (TAVV). The network token cryptogram.
    - `transStatusReason` string — 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).
    - `xid` string, byte — Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
  - `platformChargebackLogic` PlatformChargebackLogic
    - `behavior` 'deductFromOneBalanceAccount' | 'deductAccordingToSplitRatio' | 'deductFromLiableAccount' — The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.
    - `costAllocationAccount` string — 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.
    - `targetAccount` string — The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**.
  - `recurringExpiry` string — Date after which no further authorisations shall be performed. Only for 3D Secure 2.
  - `recurringFrequency` string — Minimum number of days between authorisations. Only for 3D Secure 2.
  - `recurringProcessingModel` 'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile' — Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
  - `redirectFromIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting back from the issuer.
  - `redirectToIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting to the issuer.
  - `reference` string, required — The reference to uniquely identify a payment.
  - `returnUrl` string, required — The URL to return to in case of a redirection. The format depends on the channel. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.example.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
  - `riskData` RiskData
    - `clientData` string — Contains client-side data, like the device fingerprint, cookies, and specific browser settings.
    - `customFields` object — Any custom fields used as part of the input to configured risk rules.
    - `fraudOffset` integer — An integer value that is added to the normal fraud score. The value can be either positive or negative.
    - `profileReference` string — The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.
  - `sessionData` string — The payment session data you need to pass to your front end.
  - `shopperEmail` string — The shopper's email address.
  - `shopperIP` string — The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
  - `shopperInteraction` 'Ecommerce' | 'ContAuth' | 'Moto' | 'POS' — Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `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. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder 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). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
  - `shopperLocale` string — The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.
  - `shopperName` ShopperName
    - `firstName` string, required — The first name.
    - `lastName` string, required — The last name.
  - `shopperReference` string — Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.
  - `shopperStatement` string — The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**.
  - `showInstallmentAmount` boolean — Set to true to show the payment amount per installment.
  - `showRemovePaymentMethodButton` boolean — Set to **true** to show a button that lets the shopper remove a stored payment method.
  - `socialSecurityNumber` string — The shopper's social security number.
  - `splitCardFundingSources` boolean — Boolean value indicating whether the card payment method should be split into separate debit and credit options.
  - `splits` Split[] — An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    - `account` string — The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): 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.
    - `amount` SplitAmount
      - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.
      - `value` integer, required — The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
    - `description` string — Your description for the split item.
    - `reference` string — Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For 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` 'AcquiringFees' | 'AdyenCommission' | 'AdyenFees' | 'AdyenMarkup' | 'BalanceAccount' | 'Commission' | 'Default' | 'Interchange' | 'MarketPlace' | 'PaymentFee' | 'Remainder' | 'SchemeFee' | 'Surcharge' | 'Tip' | 'TopUp' | 'VAT', required — The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of the payment (specified in `amount`) to the specified `account`. * Transaction fees types that you can book to the specified `account`: * **AcquiringFees**: The aggregated amount of the interchange and scheme fees. * **PaymentFee**: The aggregated amount of all transaction fees. * **AdyenFees**: The aggregated amount of Adyen's commission and markup fees. * **AdyenCommission**: The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **Interchange**: The fees paid to the issuer for each payment made with the card network. * **SchemeFee**: The fees paid to the card scheme for using their network. * **Commission**: Your platform's commission on the payment (specified in `amount`), booked to your liable balance account. * **Remainder**: The amount left over after a currency conversion, booked to the specified `account`. * **Surcharge**: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * **TopUp**: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * **VAT**: The value-added tax charged on the payment, booked to your platforms liable balance account. * **Default**: In very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**.
  - `store` string — Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
  - `storeFiltrationMode` 'exclusive' | 'inclusive' | 'skipFilter' — Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.
  - `storePaymentMethod` boolean — When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
  - `storePaymentMethodMode` 'askForConsent' | 'disabled' | 'enabled' — Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the Drop-in/Component shows a checkbox where the shopper can select to store their payment details for card payments. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent.
  - `telephoneNumber` string — The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`.
  - `themeId` string — Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area.
  - `thirdPartyTokenRedundancyInfo` ThirdPartyTokenRedundancyInfo
    - `requestParameters` object — Request-specific parameter values to populate the template placeholders. Each key must match a placeholder defined in the template referenced by `requestTemplateCode`.
    - `requestTemplateCode` string, required — Identifier for the third-party token request template configured in your Adyen account. This template defines the structure and endpoint for token requests.
  - `threeDS2RequestData` CheckoutSessionThreeDS2RequestData
    - `homePhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
    - `mobilePhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
    - `threeDSRequestorChallengeInd` '01' | '02' | '03' | '04' | '05' | '06' — Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only
    - `workPhone` Phone
      - `cc` string — Country code. Length: 1–3 digits.
      - `subscriber` string — Subscriber number. Length: 4-15 digits.
  - `threeDSAuthenticationOnly` boolean — Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.
  - `trustedShopper` boolean — Set to true if the payment should be routed to a trusted MID.
  - `url` string — The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment.

---

[API](https://skmtc.net/adyen/apis/adyen-checkout-api.md) · [All operations](https://skmtc.net/adyen/apis/adyen-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/adyen-checkout-api/versions/a2d1f411288c/schema)