Package com.adyen.model.checkout
Class CreateCheckoutSessionResponse
- java.lang.Object
-
- com.adyen.model.checkout.CreateCheckoutSessionResponse
-
public class CreateCheckoutSessionResponse extends Object
CreateCheckoutSessionResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCreateCheckoutSessionResponse.ChannelEnumThe platform where a payment transaction takes place.static classCreateCheckoutSessionResponse.ModeEnumIndicates the type of front end integration.static classCreateCheckoutSessionResponse.RecurringProcessingModelEnumDefines a recurring payment type.static classCreateCheckoutSessionResponse.ShopperInteractionEnumSpecifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.static classCreateCheckoutSessionResponse.StoreFiltrationModeEnumSpecifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returnedstatic classCreateCheckoutSessionResponse.StorePaymentMethodModeEnumIndicates if the details of the payment method will be stored for the shopper.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description CreateCheckoutSessionResponse()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CreateCheckoutSessionResponseaccountInfo(AccountInfo accountInfo)accountInfoCreateCheckoutSessionResponseaddAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)CreateCheckoutSessionResponseaddBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)CreateCheckoutSessionResponseadditionalAmount(Amount additionalAmount)additionalAmountCreateCheckoutSessionResponseadditionalData(Map<String,String> additionalData)This field contains additional data, which may be required for a particular payment request.CreateCheckoutSessionResponseaddLineItemsItem(LineItem lineItemsItem)CreateCheckoutSessionResponseaddSplitsItem(Split splitsItem)CreateCheckoutSessionResponseallowedPaymentMethods(List<String> allowedPaymentMethods)List of payment methods to be presented to the shopper.CreateCheckoutSessionResponseamount(Amount amount)amountCreateCheckoutSessionResponseapplicationInfo(ApplicationInfo applicationInfo)applicationInfoCreateCheckoutSessionResponseauthenticationData(AuthenticationData authenticationData)authenticationDataCreateCheckoutSessionResponsebillingAddress(BillingAddress billingAddress)billingAddressCreateCheckoutSessionResponseblockedPaymentMethods(List<String> blockedPaymentMethods)List of payment methods to be hidden from the shopper.CreateCheckoutSessionResponsecaptureDelayHours(Integer captureDelayHours)The delay between the authorisation and scheduled auto-capture, specified in hours.CreateCheckoutSessionResponsechannel(CreateCheckoutSessionResponse.ChannelEnum channel)The platform where a payment transaction takes place.CreateCheckoutSessionResponsecompany(Company company)companyCreateCheckoutSessionResponsecountryCode(String countryCode)The shopper's two-letter country code.CreateCheckoutSessionResponsedateOfBirth(OffsetDateTime dateOfBirth)The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.CreateCheckoutSessionResponsedeliverAt(OffsetDateTime deliverAt)The date and time when the purchased goods should be delivered.CreateCheckoutSessionResponsedeliveryAddress(DeliveryAddress deliveryAddress)deliveryAddressCreateCheckoutSessionResponseenableOneClick(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).CreateCheckoutSessionResponseenablePayOut(Boolean enablePayOut)When true and `shopperReference` is provided, the payment details will be tokenized for payouts.CreateCheckoutSessionResponseenableRecurring(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.booleanequals(Object o)Return true if this CreateCheckoutSessionResponse object is equal to o.CreateCheckoutSessionResponseexpiresAt(OffsetDateTime expiresAt)The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.static CreateCheckoutSessionResponsefromJson(String jsonString)Create an instance of CreateCheckoutSessionResponse given an JSON stringCreateCheckoutSessionResponsefundOrigin(FundOrigin fundOrigin)fundOriginCreateCheckoutSessionResponsefundRecipient(FundRecipient fundRecipient)fundRecipientAccountInfogetAccountInfo()accountInfoAmountgetAdditionalAmount()additionalAmountMap<String,String>getAdditionalData()This field contains additional data, which may be required for a particular payment request.List<String>getAllowedPaymentMethods()List of payment methods to be presented to the shopper.AmountgetAmount()amountApplicationInfogetApplicationInfo()applicationInfoAuthenticationDatagetAuthenticationData()authenticationDataBillingAddressgetBillingAddress()billingAddressList<String>getBlockedPaymentMethods()List of payment methods to be hidden from the shopper.IntegergetCaptureDelayHours()The delay between the authorisation and scheduled auto-capture, specified in hours.CreateCheckoutSessionResponse.ChannelEnumgetChannel()The platform where a payment transaction takes place.CompanygetCompany()companyStringgetCountryCode()The shopper's two-letter country code.OffsetDateTimegetDateOfBirth()The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.OffsetDateTimegetDeliverAt()The date and time when the purchased goods should be delivered.DeliveryAddressgetDeliveryAddress()deliveryAddressBooleangetEnableOneClick()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).BooleangetEnablePayOut()When true and `shopperReference` is provided, the payment details will be tokenized for payouts.BooleangetEnableRecurring()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.OffsetDateTimegetExpiresAt()The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.FundOrigingetFundOrigin()fundOriginFundRecipientgetFundRecipient()fundRecipientStringgetId()A unique identifier of the session.Map<String,CheckoutSessionInstallmentOption>getInstallmentOptions()A set of key-value pairs that specifies the installment options available per payment method.List<LineItem>getLineItems()Price and product information about the purchased items, to be included on the invoice sent to the shopper.MandategetMandate()mandateStringgetMcc()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.StringgetMerchantAccount()The merchant account identifier, with which you want to process the transaction.StringgetMerchantOrderReference()This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).Map<String,String>getMetadata()Metadata consists of entries, each of which includes a key and a value.CreateCheckoutSessionResponse.ModeEnumgetMode()Indicates the type of front end integration.ThreeDSecureDatagetMpiData()mpiDataPlatformChargebackLogicgetPlatformChargebackLogic()platformChargebackLogicStringgetRecurringExpiry()Date after which no further authorisations shall be performed.StringgetRecurringFrequency()Minimum number of days between authorisations.CreateCheckoutSessionResponse.RecurringProcessingModelEnumgetRecurringProcessingModel()Defines a recurring payment type.StringgetRedirectFromIssuerMethod()Specifies the redirect method (GET or POST) when redirecting back from the issuer.StringgetRedirectToIssuerMethod()Specifies the redirect method (GET or POST) when redirecting to the issuer.StringgetReference()The reference to uniquely identify a payment.StringgetReturnUrl()The URL to return to in case of a redirection.RiskDatagetRiskData()riskDataStringgetSessionData()The payment session data you need to pass to your front end.StringgetShopperEmail()The shopper's email address.CreateCheckoutSessionResponse.ShopperInteractionEnumgetShopperInteraction()Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.StringgetShopperIP()The shopper's IP address.StringgetShopperLocale()The combination of a language code and a country code to specify the language to be used in the payment.NamegetShopperName()shopperNameStringgetShopperReference()Your reference to uniquely identify this shopper, for example user ID or account ID.StringgetShopperStatement()The text to be shown on the shopper's bank statement.BooleangetShowInstallmentAmount()Set to true to show the payment amount per installment.BooleangetShowRemovePaymentMethodButton()Set to **true** to show a button that lets the shopper remove a stored payment method.StringgetSocialSecurityNumber()The shopper's social security number.BooleangetSplitCardFundingSources()Boolean value indicating whether the card payment method should be split into separate debit and credit options.List<Split>getSplits()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).StringgetStore()Required for Adyen for Platforms integrations if you are a platform model.CreateCheckoutSessionResponse.StoreFiltrationModeEnumgetStoreFiltrationMode()Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returnedBooleangetStorePaymentMethod()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).CreateCheckoutSessionResponse.StorePaymentMethodModeEnumgetStorePaymentMethodMode()Indicates if the details of the payment method will be stored for the shopper.StringgetTelephoneNumber()The shopper's telephone number.StringgetThemeId()Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?CheckoutSessionThreeDS2RequestDatagetThreeDS2RequestData()threeDS2RequestDataBooleangetThreeDSAuthenticationOnly()Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.BooleangetTrustedShopper()Set to true if the payment should be routed to a trusted MID.StringgetUrl()The URL for the Hosted Checkout page.inthashCode()CreateCheckoutSessionResponseid(String id)A unique identifier of the session.CreateCheckoutSessionResponseinstallmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions)A set of key-value pairs that specifies the installment options available per payment method.CreateCheckoutSessionResponselineItems(List<LineItem> lineItems)Price and product information about the purchased items, to be included on the invoice sent to the shopper.CreateCheckoutSessionResponsemandate(Mandate mandate)mandateCreateCheckoutSessionResponsemcc(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.CreateCheckoutSessionResponsemerchantAccount(String merchantAccount)The merchant account identifier, with which you want to process the transaction.CreateCheckoutSessionResponsemerchantOrderReference(String merchantOrderReference)This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).CreateCheckoutSessionResponsemetadata(Map<String,String> metadata)Metadata consists of entries, each of which includes a key and a value.CreateCheckoutSessionResponsemode(CreateCheckoutSessionResponse.ModeEnum mode)Indicates the type of front end integration.CreateCheckoutSessionResponsempiData(ThreeDSecureData mpiData)mpiDataCreateCheckoutSessionResponseplatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)platformChargebackLogicCreateCheckoutSessionResponseputAdditionalDataItem(String key, String additionalDataItem)CreateCheckoutSessionResponseputInstallmentOptionsItem(String key, CheckoutSessionInstallmentOption installmentOptionsItem)CreateCheckoutSessionResponseputMetadataItem(String key, String metadataItem)CreateCheckoutSessionResponserecurringExpiry(String recurringExpiry)Date after which no further authorisations shall be performed.CreateCheckoutSessionResponserecurringFrequency(String recurringFrequency)Minimum number of days between authorisations.CreateCheckoutSessionResponserecurringProcessingModel(CreateCheckoutSessionResponse.RecurringProcessingModelEnum recurringProcessingModel)Defines a recurring payment type.CreateCheckoutSessionResponseredirectFromIssuerMethod(String redirectFromIssuerMethod)Specifies the redirect method (GET or POST) when redirecting back from the issuer.CreateCheckoutSessionResponseredirectToIssuerMethod(String redirectToIssuerMethod)Specifies the redirect method (GET or POST) when redirecting to the issuer.CreateCheckoutSessionResponsereference(String reference)The reference to uniquely identify a payment.CreateCheckoutSessionResponsereturnUrl(String returnUrl)The URL to return to in case of a redirection.CreateCheckoutSessionResponseriskData(RiskData riskData)riskDataCreateCheckoutSessionResponsesessionData(String sessionData)The payment session data you need to pass to your front end.voidsetAccountInfo(AccountInfo accountInfo)accountInfovoidsetAdditionalAmount(Amount additionalAmount)additionalAmountvoidsetAdditionalData(Map<String,String> additionalData)This field contains additional data, which may be required for a particular payment request.voidsetAllowedPaymentMethods(List<String> allowedPaymentMethods)List of payment methods to be presented to the shopper.voidsetAmount(Amount amount)amountvoidsetApplicationInfo(ApplicationInfo applicationInfo)applicationInfovoidsetAuthenticationData(AuthenticationData authenticationData)authenticationDatavoidsetBillingAddress(BillingAddress billingAddress)billingAddressvoidsetBlockedPaymentMethods(List<String> blockedPaymentMethods)List of payment methods to be hidden from the shopper.voidsetCaptureDelayHours(Integer captureDelayHours)The delay between the authorisation and scheduled auto-capture, specified in hours.voidsetChannel(CreateCheckoutSessionResponse.ChannelEnum channel)The platform where a payment transaction takes place.voidsetCompany(Company company)companyvoidsetCountryCode(String countryCode)The shopper's two-letter country code.voidsetDateOfBirth(OffsetDateTime dateOfBirth)The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.voidsetDeliverAt(OffsetDateTime deliverAt)The date and time when the purchased goods should be delivered.voidsetDeliveryAddress(DeliveryAddress deliveryAddress)deliveryAddressvoidsetEnableOneClick(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).voidsetEnablePayOut(Boolean enablePayOut)When true and `shopperReference` is provided, the payment details will be tokenized for payouts.voidsetEnableRecurring(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.voidsetExpiresAt(OffsetDateTime expiresAt)The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.voidsetFundOrigin(FundOrigin fundOrigin)fundOriginvoidsetFundRecipient(FundRecipient fundRecipient)fundRecipientvoidsetId(String id)A unique identifier of the session.voidsetInstallmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions)A set of key-value pairs that specifies the installment options available per payment method.voidsetLineItems(List<LineItem> lineItems)Price and product information about the purchased items, to be included on the invoice sent to the shopper.voidsetMandate(Mandate mandate)mandatevoidsetMcc(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.voidsetMerchantAccount(String merchantAccount)The merchant account identifier, with which you want to process the transaction.voidsetMerchantOrderReference(String merchantOrderReference)This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).voidsetMetadata(Map<String,String> metadata)Metadata consists of entries, each of which includes a key and a value.voidsetMode(CreateCheckoutSessionResponse.ModeEnum mode)Indicates the type of front end integration.voidsetMpiData(ThreeDSecureData mpiData)mpiDatavoidsetPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)platformChargebackLogicvoidsetRecurringExpiry(String recurringExpiry)Date after which no further authorisations shall be performed.voidsetRecurringFrequency(String recurringFrequency)Minimum number of days between authorisations.voidsetRecurringProcessingModel(CreateCheckoutSessionResponse.RecurringProcessingModelEnum recurringProcessingModel)Defines a recurring payment type.voidsetRedirectFromIssuerMethod(String redirectFromIssuerMethod)Specifies the redirect method (GET or POST) when redirecting back from the issuer.voidsetRedirectToIssuerMethod(String redirectToIssuerMethod)Specifies the redirect method (GET or POST) when redirecting to the issuer.voidsetReference(String reference)The reference to uniquely identify a payment.voidsetReturnUrl(String returnUrl)The URL to return to in case of a redirection.voidsetRiskData(RiskData riskData)riskDatavoidsetSessionData(String sessionData)The payment session data you need to pass to your front end.voidsetShopperEmail(String shopperEmail)The shopper's email address.voidsetShopperInteraction(CreateCheckoutSessionResponse.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.voidsetShopperIP(String shopperIP)The shopper's IP address.voidsetShopperLocale(String shopperLocale)The combination of a language code and a country code to specify the language to be used in the payment.voidsetShopperName(Name shopperName)shopperNamevoidsetShopperReference(String shopperReference)Your reference to uniquely identify this shopper, for example user ID or account ID.voidsetShopperStatement(String shopperStatement)The text to be shown on the shopper's bank statement.voidsetShowInstallmentAmount(Boolean showInstallmentAmount)Set to true to show the payment amount per installment.voidsetShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)Set to **true** to show a button that lets the shopper remove a stored payment method.voidsetSocialSecurityNumber(String socialSecurityNumber)The shopper's social security number.voidsetSplitCardFundingSources(Boolean splitCardFundingSources)Boolean value indicating whether the card payment method should be split into separate debit and credit options.voidsetSplits(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).voidsetStore(String store)Required for Adyen for Platforms integrations if you are a platform model.voidsetStoreFiltrationMode(CreateCheckoutSessionResponse.StoreFiltrationModeEnum storeFiltrationMode)Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returnedvoidsetStorePaymentMethod(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).voidsetStorePaymentMethodMode(CreateCheckoutSessionResponse.StorePaymentMethodModeEnum storePaymentMethodMode)Indicates if the details of the payment method will be stored for the shopper.voidsetTelephoneNumber(String telephoneNumber)The shopper's telephone number.voidsetThemeId(String themeId)Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?voidsetThreeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)threeDS2RequestDatavoidsetThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.voidsetTrustedShopper(Boolean trustedShopper)Set to true if the payment should be routed to a trusted MID.voidsetUrl(String url)The URL for the Hosted Checkout page.CreateCheckoutSessionResponseshopperEmail(String shopperEmail)The shopper's email address.CreateCheckoutSessionResponseshopperInteraction(CreateCheckoutSessionResponse.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.CreateCheckoutSessionResponseshopperIP(String shopperIP)The shopper's IP address.CreateCheckoutSessionResponseshopperLocale(String shopperLocale)The combination of a language code and a country code to specify the language to be used in the payment.CreateCheckoutSessionResponseshopperName(Name shopperName)shopperNameCreateCheckoutSessionResponseshopperReference(String shopperReference)Your reference to uniquely identify this shopper, for example user ID or account ID.CreateCheckoutSessionResponseshopperStatement(String shopperStatement)The text to be shown on the shopper's bank statement.CreateCheckoutSessionResponseshowInstallmentAmount(Boolean showInstallmentAmount)Set to true to show the payment amount per installment.CreateCheckoutSessionResponseshowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)Set to **true** to show a button that lets the shopper remove a stored payment method.CreateCheckoutSessionResponsesocialSecurityNumber(String socialSecurityNumber)The shopper's social security number.CreateCheckoutSessionResponsesplitCardFundingSources(Boolean splitCardFundingSources)Boolean value indicating whether the card payment method should be split into separate debit and credit options.CreateCheckoutSessionResponsesplits(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).CreateCheckoutSessionResponsestore(String store)Required for Adyen for Platforms integrations if you are a platform model.CreateCheckoutSessionResponsestoreFiltrationMode(CreateCheckoutSessionResponse.StoreFiltrationModeEnum storeFiltrationMode)Specifies how payment methods should be filtered based on the 'store' parameter: - 'exclusive': Only payment methods belonging to the specified 'store' are returnedCreateCheckoutSessionResponsestorePaymentMethod(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).CreateCheckoutSessionResponsestorePaymentMethodMode(CreateCheckoutSessionResponse.StorePaymentMethodModeEnum storePaymentMethodMode)Indicates if the details of the payment method will be stored for the shopper.CreateCheckoutSessionResponsetelephoneNumber(String telephoneNumber)The shopper's telephone number.CreateCheckoutSessionResponsethemeId(String themeId)Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?CreateCheckoutSessionResponsethreeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)threeDS2RequestDataCreateCheckoutSessionResponsethreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.StringtoJson()Convert an instance of CreateCheckoutSessionResponse to an JSON stringStringtoString()CreateCheckoutSessionResponsetrustedShopper(Boolean trustedShopper)Set to true if the payment should be routed to a trusted MID.CreateCheckoutSessionResponseurl(String url)The URL for the Hosted Checkout page.
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_INFO
public static final String JSON_PROPERTY_ACCOUNT_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_AMOUNT
public static final String JSON_PROPERTY_ADDITIONAL_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_APPLICATION_INFO
public static final String JSON_PROPERTY_APPLICATION_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AUTHENTICATION_DATA
public static final String JSON_PROPERTY_AUTHENTICATION_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BILLING_ADDRESS
public static final String JSON_PROPERTY_BILLING_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
public static final String JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAPTURE_DELAY_HOURS
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CHANNEL
public static final String JSON_PROPERTY_CHANNEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COMPANY
public static final String JSON_PROPERTY_COMPANY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTRY_CODE
public static final String JSON_PROPERTY_COUNTRY_CODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATE_OF_BIRTH
public static final String JSON_PROPERTY_DATE_OF_BIRTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVER_AT
public static final String JSON_PROPERTY_DELIVER_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVERY_ADDRESS
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_ONE_CLICK
public static final String JSON_PROPERTY_ENABLE_ONE_CLICK
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_PAY_OUT
public static final String JSON_PROPERTY_ENABLE_PAY_OUT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_RECURRING
public static final String JSON_PROPERTY_ENABLE_RECURRING
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPIRES_AT
public static final String JSON_PROPERTY_EXPIRES_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FUND_ORIGIN
public static final String JSON_PROPERTY_FUND_ORIGIN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FUND_RECIPIENT
public static final String JSON_PROPERTY_FUND_RECIPIENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INSTALLMENT_OPTIONS
public static final String JSON_PROPERTY_INSTALLMENT_OPTIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LINE_ITEMS
public static final String JSON_PROPERTY_LINE_ITEMS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MANDATE
public static final String JSON_PROPERTY_MANDATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MCC
public static final String JSON_PROPERTY_MCC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
public static final String JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_METADATA
public static final String JSON_PROPERTY_METADATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODE
public static final String JSON_PROPERTY_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MPI_DATA
public static final String JSON_PROPERTY_MPI_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_EXPIRY
public static final String JSON_PROPERTY_RECURRING_EXPIRY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_FREQUENCY
public static final String JSON_PROPERTY_RECURRING_FREQUENCY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_PROCESSING_MODEL
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
public static final String JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
public static final String JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RETURN_URL
public static final String JSON_PROPERTY_RETURN_URL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RISK_DATA
public static final String JSON_PROPERTY_RISK_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SESSION_DATA
public static final String JSON_PROPERTY_SESSION_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_EMAIL
public static final String JSON_PROPERTY_SHOPPER_EMAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_I_P
public static final String JSON_PROPERTY_SHOPPER_I_P
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_LOCALE
public static final String JSON_PROPERTY_SHOPPER_LOCALE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_NAME
public static final String JSON_PROPERTY_SHOPPER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT
public static final String JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
public static final String JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
public static final String JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLITS
public static final String JSON_PROPERTY_SPLITS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE
public static final String JSON_PROPERTY_STORE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_FILTRATION_MODE
public static final String JSON_PROPERTY_STORE_FILTRATION_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_PAYMENT_METHOD
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TELEPHONE_NUMBER
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THEME_ID
public static final String JSON_PROPERTY_THEME_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRUSTED_SHOPPER
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_URL
public static final String JSON_PROPERTY_URL
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountInfo
public CreateCheckoutSessionResponse accountInfo(AccountInfo accountInfo)
accountInfo- Parameters:
accountInfo-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getAccountInfo
public AccountInfo getAccountInfo()
accountInfo- Returns:
- accountInfo
-
setAccountInfo
public void setAccountInfo(AccountInfo accountInfo)
accountInfo- Parameters:
accountInfo-
-
additionalAmount
public CreateCheckoutSessionResponse additionalAmount(Amount additionalAmount)
additionalAmount- Parameters:
additionalAmount-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getAdditionalAmount
public Amount getAdditionalAmount()
additionalAmount- Returns:
- additionalAmount
-
setAdditionalAmount
public void setAdditionalAmount(Amount additionalAmount)
additionalAmount- Parameters:
additionalAmount-
-
additionalData
public CreateCheckoutSessionResponse additionalData(Map<String,String> additionalData)
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.- Parameters:
additionalData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
putAdditionalDataItem
public CreateCheckoutSessionResponse putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
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.- Returns:
- additionalData
-
setAdditionalData
public void setAdditionalData(Map<String,String> additionalData)
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.- Parameters:
additionalData-
-
allowedPaymentMethods
public CreateCheckoutSessionResponse allowedPaymentMethods(List<String> allowedPaymentMethods)
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\",\"giropay\"]`- Parameters:
allowedPaymentMethods-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
addAllowedPaymentMethodsItem
public CreateCheckoutSessionResponse addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
-
getAllowedPaymentMethods
public List<String> getAllowedPaymentMethods()
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\",\"giropay\"]`- Returns:
- allowedPaymentMethods
-
setAllowedPaymentMethods
public void setAllowedPaymentMethods(List<String> allowedPaymentMethods)
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\",\"giropay\"]`- Parameters:
allowedPaymentMethods-
-
amount
public CreateCheckoutSessionResponse amount(Amount amount)
amount- Parameters:
amount-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getAmount
public Amount getAmount()
amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
applicationInfo
public CreateCheckoutSessionResponse applicationInfo(ApplicationInfo applicationInfo)
applicationInfo- Parameters:
applicationInfo-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
applicationInfo- Returns:
- applicationInfo
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
applicationInfo- Parameters:
applicationInfo-
-
authenticationData
public CreateCheckoutSessionResponse authenticationData(AuthenticationData authenticationData)
authenticationData- Parameters:
authenticationData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getAuthenticationData
public AuthenticationData getAuthenticationData()
authenticationData- Returns:
- authenticationData
-
setAuthenticationData
public void setAuthenticationData(AuthenticationData authenticationData)
authenticationData- Parameters:
authenticationData-
-
billingAddress
public CreateCheckoutSessionResponse billingAddress(BillingAddress billingAddress)
billingAddress- Parameters:
billingAddress-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getBillingAddress
public BillingAddress getBillingAddress()
billingAddress- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(BillingAddress billingAddress)
billingAddress- Parameters:
billingAddress-
-
blockedPaymentMethods
public CreateCheckoutSessionResponse blockedPaymentMethods(List<String> blockedPaymentMethods)
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\",\"giropay\"]`- Parameters:
blockedPaymentMethods-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
addBlockedPaymentMethodsItem
public CreateCheckoutSessionResponse addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
-
getBlockedPaymentMethods
public List<String> getBlockedPaymentMethods()
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\",\"giropay\"]`- Returns:
- blockedPaymentMethods
-
setBlockedPaymentMethods
public void setBlockedPaymentMethods(List<String> blockedPaymentMethods)
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\",\"giropay\"]`- Parameters:
blockedPaymentMethods-
-
captureDelayHours
public CreateCheckoutSessionResponse captureDelayHours(Integer captureDelayHours)
The delay between the authorisation and scheduled auto-capture, specified in hours.- Parameters:
captureDelayHours-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getCaptureDelayHours
public Integer getCaptureDelayHours()
The delay between the authorisation and scheduled auto-capture, specified in hours.- Returns:
- captureDelayHours
-
setCaptureDelayHours
public void setCaptureDelayHours(Integer captureDelayHours)
The delay between the authorisation and scheduled auto-capture, specified in hours.- Parameters:
captureDelayHours-
-
channel
public CreateCheckoutSessionResponse channel(CreateCheckoutSessionResponse.ChannelEnum channel)
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**- Parameters:
channel-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getChannel
public CreateCheckoutSessionResponse.ChannelEnum getChannel()
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**- Returns:
- channel
-
setChannel
public void setChannel(CreateCheckoutSessionResponse.ChannelEnum channel)
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**- Parameters:
channel-
-
company
public CreateCheckoutSessionResponse company(Company company)
company- Parameters:
company-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getCompany
public Company getCompany()
company- Returns:
- company
-
setCompany
public void setCompany(Company company)
company- Parameters:
company-
-
countryCode
public CreateCheckoutSessionResponse countryCode(String countryCode)
The shopper's two-letter country code.- Parameters:
countryCode-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getCountryCode
public String getCountryCode()
The shopper's two-letter country code.- Returns:
- countryCode
-
setCountryCode
public void setCountryCode(String countryCode)
The shopper's two-letter country code.- Parameters:
countryCode-
-
dateOfBirth
public CreateCheckoutSessionResponse dateOfBirth(OffsetDateTime dateOfBirth)
The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.- Parameters:
dateOfBirth-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getDateOfBirth
public OffsetDateTime getDateOfBirth()
The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.- Returns:
- dateOfBirth
-
setDateOfBirth
public void setDateOfBirth(OffsetDateTime dateOfBirth)
The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.- Parameters:
dateOfBirth-
-
deliverAt
public CreateCheckoutSessionResponse deliverAt(OffsetDateTime deliverAt)
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**.- Parameters:
deliverAt-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getDeliverAt
public OffsetDateTime getDeliverAt()
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**.- Returns:
- deliverAt
-
setDeliverAt
public void setDeliverAt(OffsetDateTime deliverAt)
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**.- Parameters:
deliverAt-
-
deliveryAddress
public CreateCheckoutSessionResponse deliveryAddress(DeliveryAddress deliveryAddress)
deliveryAddress- Parameters:
deliveryAddress-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getDeliveryAddress
public DeliveryAddress getDeliveryAddress()
deliveryAddress- Returns:
- deliveryAddress
-
setDeliveryAddress
public void setDeliveryAddress(DeliveryAddress deliveryAddress)
deliveryAddress- Parameters:
deliveryAddress-
-
enableOneClick
public CreateCheckoutSessionResponse 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).- Parameters:
enableOneClick-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getEnableOneClick
public Boolean getEnableOneClick()
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).- Returns:
- enableOneClick
-
setEnableOneClick
public void setEnableOneClick(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).- Parameters:
enableOneClick-
-
enablePayOut
public CreateCheckoutSessionResponse enablePayOut(Boolean enablePayOut)
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.- Parameters:
enablePayOut-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getEnablePayOut
public Boolean getEnablePayOut()
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.- Returns:
- enablePayOut
-
setEnablePayOut
public void setEnablePayOut(Boolean enablePayOut)
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.- Parameters:
enablePayOut-
-
enableRecurring
public CreateCheckoutSessionResponse 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.- Parameters:
enableRecurring-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getEnableRecurring
public Boolean getEnableRecurring()
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.- Returns:
- enableRecurring
-
setEnableRecurring
public void setEnableRecurring(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.- Parameters:
enableRecurring-
-
expiresAt
public CreateCheckoutSessionResponse expiresAt(OffsetDateTime expiresAt)
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.- Parameters:
expiresAt-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getExpiresAt
public OffsetDateTime getExpiresAt()
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.- Returns:
- expiresAt
-
setExpiresAt
public void setExpiresAt(OffsetDateTime expiresAt)
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.- Parameters:
expiresAt-
-
fundOrigin
public CreateCheckoutSessionResponse fundOrigin(FundOrigin fundOrigin)
fundOrigin- Parameters:
fundOrigin-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getFundOrigin
public FundOrigin getFundOrigin()
fundOrigin- Returns:
- fundOrigin
-
setFundOrigin
public void setFundOrigin(FundOrigin fundOrigin)
fundOrigin- Parameters:
fundOrigin-
-
fundRecipient
public CreateCheckoutSessionResponse fundRecipient(FundRecipient fundRecipient)
fundRecipient- Parameters:
fundRecipient-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getFundRecipient
public FundRecipient getFundRecipient()
fundRecipient- Returns:
- fundRecipient
-
setFundRecipient
public void setFundRecipient(FundRecipient fundRecipient)
fundRecipient- Parameters:
fundRecipient-
-
id
public CreateCheckoutSessionResponse id(String id)
A unique identifier of the session.- Parameters:
id-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getId
public String getId()
A unique identifier of the session.- Returns:
- id
-
setId
public void setId(String id)
A unique identifier of the session.- Parameters:
id-
-
installmentOptions
public CreateCheckoutSessionResponse installmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions)
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.- Parameters:
installmentOptions-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
putInstallmentOptionsItem
public CreateCheckoutSessionResponse putInstallmentOptionsItem(String key, CheckoutSessionInstallmentOption installmentOptionsItem)
-
getInstallmentOptions
public Map<String,CheckoutSessionInstallmentOption> getInstallmentOptions()
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.- Returns:
- installmentOptions
-
setInstallmentOptions
public void setInstallmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions)
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.- Parameters:
installmentOptions-
-
lineItems
public CreateCheckoutSessionResponse lineItems(List<LineItem> lineItems)
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, Riverty, and Zip.- Parameters:
lineItems-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
addLineItemsItem
public CreateCheckoutSessionResponse addLineItemsItem(LineItem lineItemsItem)
-
getLineItems
public List<LineItem> getLineItems()
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, Riverty, and Zip.- Returns:
- lineItems
-
setLineItems
public void setLineItems(List<LineItem> lineItems)
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, Riverty, and Zip.- Parameters:
lineItems-
-
mandate
public CreateCheckoutSessionResponse mandate(Mandate mandate)
mandate- Parameters:
mandate-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMandate
public Mandate getMandate()
mandate- Returns:
- mandate
-
setMandate
public void setMandate(Mandate mandate)
mandate- Parameters:
mandate-
-
mcc
public CreateCheckoutSessionResponse 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. This code reflects the predominant activity that is conducted by the merchant.- Parameters:
mcc-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMcc
public String getMcc()
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.- Returns:
- mcc
-
setMcc
public void setMcc(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. This code reflects the predominant activity that is conducted by the merchant.- Parameters:
mcc-
-
merchantAccount
public CreateCheckoutSessionResponse merchantAccount(String merchantAccount)
The merchant account identifier, with which you want to process the transaction.- Parameters:
merchantAccount-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
The merchant account identifier, with which you want to process the transaction.- Parameters:
merchantAccount-
-
merchantOrderReference
public CreateCheckoutSessionResponse merchantOrderReference(String merchantOrderReference)
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`.- Parameters:
merchantOrderReference-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMerchantOrderReference
public String getMerchantOrderReference()
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`.- Returns:
- merchantOrderReference
-
setMerchantOrderReference
public void setMerchantOrderReference(String merchantOrderReference)
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`.- Parameters:
merchantOrderReference-
-
metadata
public CreateCheckoutSessionResponse metadata(Map<String,String> metadata)
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.- Parameters:
metadata-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
putMetadataItem
public CreateCheckoutSessionResponse putMetadataItem(String key, String metadataItem)
-
getMetadata
public Map<String,String> getMetadata()
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.- Returns:
- metadata
-
setMetadata
public void setMetadata(Map<String,String> metadata)
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.- Parameters:
metadata-
-
mode
public CreateCheckoutSessionResponse mode(CreateCheckoutSessionResponse.ModeEnum mode)
Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration- Parameters:
mode-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMode
public CreateCheckoutSessionResponse.ModeEnum getMode()
Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration- Returns:
- mode
-
setMode
public void setMode(CreateCheckoutSessionResponse.ModeEnum mode)
Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration- Parameters:
mode-
-
mpiData
public CreateCheckoutSessionResponse mpiData(ThreeDSecureData mpiData)
mpiData- Parameters:
mpiData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getMpiData
public ThreeDSecureData getMpiData()
mpiData- Returns:
- mpiData
-
setMpiData
public void setMpiData(ThreeDSecureData mpiData)
mpiData- Parameters:
mpiData-
-
platformChargebackLogic
public CreateCheckoutSessionResponse platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
platformChargebackLogic- Parameters:
platformChargebackLogic-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getPlatformChargebackLogic
public PlatformChargebackLogic getPlatformChargebackLogic()
platformChargebackLogic- Returns:
- platformChargebackLogic
-
setPlatformChargebackLogic
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
platformChargebackLogic- Parameters:
platformChargebackLogic-
-
recurringExpiry
public CreateCheckoutSessionResponse recurringExpiry(String recurringExpiry)
Date after which no further authorisations shall be performed. Only for 3D Secure 2.- Parameters:
recurringExpiry-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRecurringExpiry
public String getRecurringExpiry()
Date after which no further authorisations shall be performed. Only for 3D Secure 2.- Returns:
- recurringExpiry
-
setRecurringExpiry
public void setRecurringExpiry(String recurringExpiry)
Date after which no further authorisations shall be performed. Only for 3D Secure 2.- Parameters:
recurringExpiry-
-
recurringFrequency
public CreateCheckoutSessionResponse recurringFrequency(String recurringFrequency)
Minimum number of days between authorisations. Only for 3D Secure 2.- Parameters:
recurringFrequency-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRecurringFrequency
public String getRecurringFrequency()
Minimum number of days between authorisations. Only for 3D Secure 2.- Returns:
- recurringFrequency
-
setRecurringFrequency
public void setRecurringFrequency(String recurringFrequency)
Minimum number of days between authorisations. Only for 3D Secure 2.- Parameters:
recurringFrequency-
-
recurringProcessingModel
public CreateCheckoutSessionResponse recurringProcessingModel(CreateCheckoutSessionResponse.RecurringProcessingModelEnum recurringProcessingModel)
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.- Parameters:
recurringProcessingModel-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRecurringProcessingModel
public CreateCheckoutSessionResponse.RecurringProcessingModelEnum getRecurringProcessingModel()
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.- Returns:
- recurringProcessingModel
-
setRecurringProcessingModel
public void setRecurringProcessingModel(CreateCheckoutSessionResponse.RecurringProcessingModelEnum recurringProcessingModel)
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.- Parameters:
recurringProcessingModel-
-
redirectFromIssuerMethod
public CreateCheckoutSessionResponse redirectFromIssuerMethod(String redirectFromIssuerMethod)
Specifies the redirect method (GET or POST) when redirecting back from the issuer.- Parameters:
redirectFromIssuerMethod-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRedirectFromIssuerMethod
public String getRedirectFromIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting back from the issuer.- Returns:
- redirectFromIssuerMethod
-
setRedirectFromIssuerMethod
public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod)
Specifies the redirect method (GET or POST) when redirecting back from the issuer.- Parameters:
redirectFromIssuerMethod-
-
redirectToIssuerMethod
public CreateCheckoutSessionResponse redirectToIssuerMethod(String redirectToIssuerMethod)
Specifies the redirect method (GET or POST) when redirecting to the issuer.- Parameters:
redirectToIssuerMethod-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRedirectToIssuerMethod
public String getRedirectToIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting to the issuer.- Returns:
- redirectToIssuerMethod
-
setRedirectToIssuerMethod
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
Specifies the redirect method (GET or POST) when redirecting to the issuer.- Parameters:
redirectToIssuerMethod-
-
reference
public CreateCheckoutSessionResponse reference(String reference)
The reference to uniquely identify a payment.- Parameters:
reference-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getReference
public String getReference()
The reference to uniquely identify a payment.- Returns:
- reference
-
setReference
public void setReference(String reference)
The reference to uniquely identify a payment.- Parameters:
reference-
-
returnUrl
public CreateCheckoutSessionResponse returnUrl(String returnUrl)
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.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. > The URL must not include personally identifiable information (PII), for example name or email address.- Parameters:
returnUrl-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getReturnUrl
public String getReturnUrl()
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.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. > The URL must not include personally identifiable information (PII), for example name or email address.- Returns:
- returnUrl
-
setReturnUrl
public void setReturnUrl(String returnUrl)
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.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. > The URL must not include personally identifiable information (PII), for example name or email address.- Parameters:
returnUrl-
-
riskData
public CreateCheckoutSessionResponse riskData(RiskData riskData)
riskData- Parameters:
riskData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getRiskData
public RiskData getRiskData()
riskData- Returns:
- riskData
-
setRiskData
public void setRiskData(RiskData riskData)
riskData- Parameters:
riskData-
-
sessionData
public CreateCheckoutSessionResponse sessionData(String sessionData)
The payment session data you need to pass to your front end.- Parameters:
sessionData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getSessionData
public String getSessionData()
The payment session data you need to pass to your front end.- Returns:
- sessionData
-
setSessionData
public void setSessionData(String sessionData)
The payment session data you need to pass to your front end.- Parameters:
sessionData-
-
shopperEmail
public CreateCheckoutSessionResponse shopperEmail(String shopperEmail)
The shopper's email address.- Parameters:
shopperEmail-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperEmail
public String getShopperEmail()
The shopper's email address.- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
The shopper's email address.- Parameters:
shopperEmail-
-
shopperIP
public CreateCheckoutSessionResponse shopperIP(String shopperIP)
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 Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. 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).- Parameters:
shopperIP-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperIP
public String getShopperIP()
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 Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. 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).- Returns:
- shopperIP
-
setShopperIP
public void setShopperIP(String shopperIP)
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 Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. 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).- Parameters:
shopperIP-
-
shopperInteraction
public CreateCheckoutSessionResponse shopperInteraction(CreateCheckoutSessionResponse.ShopperInteractionEnum shopperInteraction)
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.- Parameters:
shopperInteraction-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperInteraction
public CreateCheckoutSessionResponse.ShopperInteractionEnum getShopperInteraction()
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.- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(CreateCheckoutSessionResponse.ShopperInteractionEnum shopperInteraction)
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.- Parameters:
shopperInteraction-
-
shopperLocale
public CreateCheckoutSessionResponse shopperLocale(String shopperLocale)
The combination of a language code and a country code to specify the language to be used in the payment.- Parameters:
shopperLocale-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperLocale
public String getShopperLocale()
The combination of a language code and a country code to specify the language to be used in the payment.- Returns:
- shopperLocale
-
setShopperLocale
public void setShopperLocale(String shopperLocale)
The combination of a language code and a country code to specify the language to be used in the payment.- Parameters:
shopperLocale-
-
shopperName
public CreateCheckoutSessionResponse shopperName(Name shopperName)
shopperName- Parameters:
shopperName-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperName
public Name getShopperName()
shopperName- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
shopperName- Parameters:
shopperName-
-
shopperReference
public CreateCheckoutSessionResponse shopperReference(String shopperReference)
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 example name or email address.- Parameters:
shopperReference-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperReference
public String getShopperReference()
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 example name or email address.- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
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 example name or email address.- Parameters:
shopperReference-
-
shopperStatement
public CreateCheckoutSessionResponse shopperStatement(String shopperStatement)
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 **. , ' _ - ? + * /_**.- Parameters:
shopperStatement-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShopperStatement
public String getShopperStatement()
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 **. , ' _ - ? + * /_**.- Returns:
- shopperStatement
-
setShopperStatement
public void setShopperStatement(String shopperStatement)
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 **. , ' _ - ? + * /_**.- Parameters:
shopperStatement-
-
showInstallmentAmount
public CreateCheckoutSessionResponse showInstallmentAmount(Boolean showInstallmentAmount)
Set to true to show the payment amount per installment.- Parameters:
showInstallmentAmount-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShowInstallmentAmount
public Boolean getShowInstallmentAmount()
Set to true to show the payment amount per installment.- Returns:
- showInstallmentAmount
-
setShowInstallmentAmount
public void setShowInstallmentAmount(Boolean showInstallmentAmount)
Set to true to show the payment amount per installment.- Parameters:
showInstallmentAmount-
-
showRemovePaymentMethodButton
public CreateCheckoutSessionResponse showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)
Set to **true** to show a button that lets the shopper remove a stored payment method.- Parameters:
showRemovePaymentMethodButton-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getShowRemovePaymentMethodButton
public Boolean getShowRemovePaymentMethodButton()
Set to **true** to show a button that lets the shopper remove a stored payment method.- Returns:
- showRemovePaymentMethodButton
-
setShowRemovePaymentMethodButton
public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton)
Set to **true** to show a button that lets the shopper remove a stored payment method.- Parameters:
showRemovePaymentMethodButton-
-
socialSecurityNumber
public CreateCheckoutSessionResponse socialSecurityNumber(String socialSecurityNumber)
The shopper's social security number.- Parameters:
socialSecurityNumber-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
The shopper's social security number.- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
The shopper's social security number.- Parameters:
socialSecurityNumber-
-
splitCardFundingSources
public CreateCheckoutSessionResponse splitCardFundingSources(Boolean splitCardFundingSources)
Boolean value indicating whether the card payment method should be split into separate debit and credit options.- Parameters:
splitCardFundingSources-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getSplitCardFundingSources
public Boolean getSplitCardFundingSources()
Boolean value indicating whether the card payment method should be split into separate debit and credit options.- Returns:
- splitCardFundingSources
-
setSplitCardFundingSources
public void setSplitCardFundingSources(Boolean splitCardFundingSources)
Boolean value indicating whether the card payment method should be split into separate debit and credit options.- Parameters:
splitCardFundingSources-
-
splits
public CreateCheckoutSessionResponse 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).- Parameters:
splits-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
addSplitsItem
public CreateCheckoutSessionResponse addSplitsItem(Split splitsItem)
-
getSplits
public List<Split> getSplits()
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).- Returns:
- splits
-
setSplits
public void setSplits(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).- Parameters:
splits-
-
store
public CreateCheckoutSessionResponse store(String store)
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.- Parameters:
store-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getStore
public String getStore()
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.- Returns:
- store
-
setStore
public void setStore(String store)
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.- Parameters:
store-
-
storeFiltrationMode
public CreateCheckoutSessionResponse storeFiltrationMode(CreateCheckoutSessionResponse.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. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.- Parameters:
storeFiltrationMode-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getStoreFiltrationMode
public CreateCheckoutSessionResponse.StoreFiltrationModeEnum getStoreFiltrationMode()
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.- Returns:
- storeFiltrationMode
-
setStoreFiltrationMode
public void setStoreFiltrationMode(CreateCheckoutSessionResponse.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. - 'inclusive': Payment methods from the 'store' and those not associated with any other store are returned.- Parameters:
storeFiltrationMode-
-
storePaymentMethod
public CreateCheckoutSessionResponse 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).- Parameters:
storePaymentMethod-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getStorePaymentMethod
public Boolean getStorePaymentMethod()
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).- Returns:
- storePaymentMethod
-
setStorePaymentMethod
public void setStorePaymentMethod(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).- Parameters:
storePaymentMethod-
-
storePaymentMethodMode
public CreateCheckoutSessionResponse storePaymentMethodMode(CreateCheckoutSessionResponse.StorePaymentMethodModeEnum storePaymentMethodMode)
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 UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent.- Parameters:
storePaymentMethodMode-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getStorePaymentMethodMode
public CreateCheckoutSessionResponse.StorePaymentMethodModeEnum getStorePaymentMethodMode()
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 UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent.- Returns:
- storePaymentMethodMode
-
setStorePaymentMethodMode
public void setStorePaymentMethodMode(CreateCheckoutSessionResponse.StorePaymentMethodModeEnum storePaymentMethodMode)
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 UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent.- Parameters:
storePaymentMethodMode-
-
telephoneNumber
public CreateCheckoutSessionResponse telephoneNumber(String telephoneNumber)
The shopper's telephone number.- Parameters:
telephoneNumber-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getTelephoneNumber
public String getTelephoneNumber()
The shopper's telephone number.- Returns:
- telephoneNumber
-
setTelephoneNumber
public void setTelephoneNumber(String telephoneNumber)
The shopper's telephone number.- Parameters:
telephoneNumber-
-
themeId
public CreateCheckoutSessionResponse themeId(String themeId)
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.- Parameters:
themeId-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getThemeId
public String getThemeId()
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.- Returns:
- themeId
-
setThemeId
public void setThemeId(String themeId)
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.- Parameters:
themeId-
-
threeDS2RequestData
public CreateCheckoutSessionResponse threeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)
threeDS2RequestData- Parameters:
threeDS2RequestData-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getThreeDS2RequestData
public CheckoutSessionThreeDS2RequestData getThreeDS2RequestData()
threeDS2RequestData- Returns:
- threeDS2RequestData
-
setThreeDS2RequestData
public void setThreeDS2RequestData(CheckoutSessionThreeDS2RequestData threeDS2RequestData)
threeDS2RequestData- Parameters:
threeDS2RequestData-
-
threeDSAuthenticationOnly
@Deprecated public CreateCheckoutSessionResponse threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.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.- Parameters:
threeDSAuthenticationOnly-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getThreeDSAuthenticationOnly
@Deprecated public Boolean getThreeDSAuthenticationOnly()
Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.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.- Returns:
- threeDSAuthenticationOnly
-
setThreeDSAuthenticationOnly
@Deprecated public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
Deprecated.since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.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.- Parameters:
threeDSAuthenticationOnly-
-
trustedShopper
public CreateCheckoutSessionResponse trustedShopper(Boolean trustedShopper)
Set to true if the payment should be routed to a trusted MID.- Parameters:
trustedShopper-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getTrustedShopper
public Boolean getTrustedShopper()
Set to true if the payment should be routed to a trusted MID.- Returns:
- trustedShopper
-
setTrustedShopper
public void setTrustedShopper(Boolean trustedShopper)
Set to true if the payment should be routed to a trusted MID.- Parameters:
trustedShopper-
-
url
public CreateCheckoutSessionResponse url(String url)
The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment.- Parameters:
url-- Returns:
- the current
CreateCheckoutSessionResponseinstance, allowing for method chaining
-
getUrl
public String getUrl()
The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment.- Returns:
- url
-
setUrl
public void setUrl(String url)
The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment.- Parameters:
url-
-
equals
public boolean equals(Object o)
Return true if this CreateCheckoutSessionResponse object is equal to o.
-
fromJson
public static CreateCheckoutSessionResponse fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of CreateCheckoutSessionResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateCheckoutSessionResponse
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to CreateCheckoutSessionResponse
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of CreateCheckoutSessionResponse to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-