Adyen · Schema
CreateCheckoutSessionRequest
CreateCheckoutSessionRequest schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| accountInfo | object | Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow. |
| additionalAmount | object | If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while th |
| 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 | array | 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: `"allowedPay |
| amount | object | The amount of the payment. |
| applicationInfo | object | Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). |
| authenticationData | object | Configuration data for 3DS payments. |
| billingAddress | object | The address where to send the invoice. |
| blockedPaymentMethods | array | 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: `"blockedPaym |
| captureDelayHours | integer | The delay between the authorisation and scheduled auto-capture, specified in hours. |
| channel | string | 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 |
| company | object | Information regarding the company. |
| countryCode | string | The shopper's two-letter country code. |
| dateOfBirth | string | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD |
| deliverAt | string | 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 | object | The address where the purchased goods should be delivered. |
| 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. |
| 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 tokenized for recurring payments. |
| expiresAt | string | 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 th |
| fundOrigin | object | The person or entity funding the money. |
| fundRecipient | object | the person or entity receiving the money |
| 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 f |
| lineItems | array | 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 Zi |
| mandate | object | The mandate details to initiate recurring transaction. |
| 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 activi |
| merchantAccount | string | 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 sho |
| 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 | string | Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration |
| mpiData | object | Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires). |
| platformChargebackLogic | object | Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). |
| 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 | string | 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 schedu |
| 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 | The reference to uniquely identify a payment. |
| returnUrl | string | The URL to return to when a redirect payment is completed. |
| riskData | object | Any risk-related settings to apply to the payment. |
| shopperEmail | string | The shopper's email address. |
| shopperIP | string | The shopper's IP address. In general, 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). > For 3D Se |
| shopperInteraction | string | 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 b |
| shopperLocale | string | The combination of a language code and a country code to specify the language to be used in the payment. |
| shopperName | object | The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program. |
| shopperReference | string | Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for exam |
| 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, |
| 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 | array | An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Plat |
| store | string | Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-referen |
| storePaymentMethod | boolean | When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. |
| storePaymentMethodMode | string | 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 |
| telephoneNumber | string | The shopper's telephone number. |
| 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 |
| threeDSAuthenticationOnly | boolean | If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. |
| trustedShopper | boolean | Set to true if the payment should be routed to a trusted MID. |