CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.accountInfo(AccountInfo accountInfo) |
accountInfo
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.additionalAmount(Amount additionalAmount) |
additionalAmount
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.additionalData(Map<String,String> additionalData) |
This field contains additional data, which may be required for a particular payment request.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.addLineItemsItem(LineItem lineItemsItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.addSplitsItem(Split splitsItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.allowedPaymentMethods(List<String> allowedPaymentMethods) |
List of payment methods to be presented to the shopper.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.amount(Amount amount) |
amount
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.applicationInfo(ApplicationInfo applicationInfo) |
applicationInfo
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.authenticationData(AuthenticationData authenticationData) |
authenticationData
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.billingAddress(BillingAddress billingAddress) |
billingAddress
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.blockedPaymentMethods(List<String> blockedPaymentMethods) |
List of payment methods to be hidden from the shopper.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.captureDelayHours(Integer captureDelayHours) |
The delay between the authorisation and scheduled auto-capture, specified in hours.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.channel(CreateCheckoutSessionRequest.ChannelEnum channel) |
The platform where a payment transaction takes place.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.company(Company company) |
company
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.countryCode(String countryCode) |
The shopper's two-letter country code.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.dateOfBirth(LocalDate dateOfBirth) |
The shopper's date of birth.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.deliverAt(OffsetDateTime deliverAt) |
The date and time when the purchased goods should be delivered.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.deliveryAddress(DeliveryAddress deliveryAddress) |
deliveryAddress
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.enableOneClick(Boolean enableOneClick) |
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).
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.enablePayOut(Boolean enablePayOut) |
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.enableRecurring(Boolean enableRecurring) |
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.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.expiresAt(OffsetDateTime expiresAt) |
The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
static CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.fromJson(String jsonString) |
Create an instance of CreateCheckoutSessionRequest given an JSON string
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.fundOrigin(FundOrigin fundOrigin) |
fundOrigin
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.fundRecipient(FundRecipient fundRecipient) |
fundRecipient
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.installmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions) |
A set of key-value pairs that specifies the installment options available per payment method.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.lineItems(List<LineItem> lineItems) |
Price and product information about the purchased items, to be included on the invoice sent to the shopper.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.mandate(Mandate mandate) |
mandate
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.mcc(String mcc) |
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.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.merchantAccount(String merchantAccount) |
The merchant account identifier, with which you want to process the transaction.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.merchantOrderReference(String merchantOrderReference) |
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.metadata(Map<String,String> metadata) |
Metadata consists of entries, each of which includes a key and a value.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.mode(CreateCheckoutSessionRequest.ModeEnum mode) |
Indicates the type of front end integration.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.mpiData(ThreeDSecureData mpiData) |
mpiData
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) |
platformChargebackLogic
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.putAdditionalDataItem(String key,
String additionalDataItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.putInstallmentOptionsItem(String key,
CheckoutSessionInstallmentOption installmentOptionsItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.putMetadataItem(String key,
String metadataItem) |
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.recurringExpiry(String recurringExpiry) |
Date after which no further authorisations shall be performed.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.recurringFrequency(String recurringFrequency) |
Minimum number of days between authorisations.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.recurringProcessingModel(CreateCheckoutSessionRequest.RecurringProcessingModelEnum recurringProcessingModel) |
Defines a recurring payment type.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.redirectFromIssuerMethod(String redirectFromIssuerMethod) |
Specifies the redirect method (GET or POST) when redirecting back from the issuer.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.redirectToIssuerMethod(String redirectToIssuerMethod) |
Specifies the redirect method (GET or POST) when redirecting to the issuer.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.reference(String reference) |
The reference to uniquely identify a payment.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.returnUrl(String returnUrl) |
The URL to return to in case of a redirection.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.riskData(RiskData riskData) |
riskData
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperEmail(String shopperEmail) |
The shopper's email address.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperInteraction(CreateCheckoutSessionRequest.ShopperInteractionEnum shopperInteraction) |
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperIP(String shopperIP) |
The shopper's IP address.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperLocale(String shopperLocale) |
The combination of a language code and a country code to specify the language to be used in the payment.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperName(Name shopperName) |
shopperName
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperReference(String shopperReference) |
Your reference to uniquely identify this shopper, for example user ID or account ID.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.shopperStatement(String shopperStatement) |
The text to be shown on the shopper's bank statement.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.showInstallmentAmount(Boolean showInstallmentAmount) |
Set to true to show the payment amount per installment.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) |
Set to **true** to show a button that lets the shopper remove a stored payment method.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.socialSecurityNumber(String socialSecurityNumber) |
The shopper's social security number.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.splitCardFundingSources(Boolean splitCardFundingSources) |
Boolean value indicating whether the card payment method should be split into separate debit and credit options.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.splits(List<Split> splits) |
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).
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.store(String store) |
Required for Adyen for Platforms integrations if you are a platform model.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.storeFiltrationMode(CreateCheckoutSessionRequest.StoreFiltrationModeEnum storeFiltrationMode) |
Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returned
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.storePaymentMethod(Boolean storePaymentMethod) |
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).
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.storePaymentMethodMode(CreateCheckoutSessionRequest.StorePaymentMethodModeEnum storePaymentMethodMode) |
Indicates if the details of the payment method will be stored for the shopper.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.telephoneNumber(String telephoneNumber) |
The shopper's telephone number.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.themeId(String themeId) |
Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.threeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData) |
threeDS2RequestData
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) |
Deprecated.
|
CreateCheckoutSessionRequest |
CreateCheckoutSessionRequest.trustedShopper(Boolean trustedShopper) |
Set to true if the payment should be routed to a trusted MID.
|