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.StorePaymentMethodModeEnumIndicates if the details of the payment method will be stored for the shopper.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description CreateCheckoutSessionResponse()
-
Method Summary
-
-
-
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_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_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_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
-
-
Method Detail
-
accountInfo
public CreateCheckoutSessionResponse accountInfo(AccountInfo accountInfo)
-
getAccountInfo
public AccountInfo getAccountInfo()
Get accountInfo- Returns:
- accountInfo
-
setAccountInfo
public void setAccountInfo(AccountInfo accountInfo)
-
additionalAmount
public CreateCheckoutSessionResponse additionalAmount(Amount additionalAmount)
-
getAdditionalAmount
public Amount getAdditionalAmount()
Get additionalAmount- Returns:
- additionalAmount
-
setAdditionalAmount
public void setAdditionalAmount(Amount additionalAmount)
-
additionalData
public CreateCheckoutSessionResponse additionalData(Map<String,String> additionalData)
-
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
-
allowedPaymentMethods
public CreateCheckoutSessionResponse allowedPaymentMethods(List<String> allowedPaymentMethods)
-
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
-
amount
public CreateCheckoutSessionResponse amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
applicationInfo
public CreateCheckoutSessionResponse applicationInfo(ApplicationInfo applicationInfo)
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
Get applicationInfo- Returns:
- applicationInfo
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
-
authenticationData
public CreateCheckoutSessionResponse authenticationData(AuthenticationData authenticationData)
-
getAuthenticationData
public AuthenticationData getAuthenticationData()
Get authenticationData- Returns:
- authenticationData
-
setAuthenticationData
public void setAuthenticationData(AuthenticationData authenticationData)
-
billingAddress
public CreateCheckoutSessionResponse billingAddress(BillingAddress billingAddress)
-
getBillingAddress
public BillingAddress getBillingAddress()
Get billingAddress- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(BillingAddress billingAddress)
-
blockedPaymentMethods
public CreateCheckoutSessionResponse blockedPaymentMethods(List<String> blockedPaymentMethods)
-
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
-
captureDelayHours
public CreateCheckoutSessionResponse captureDelayHours(Integer captureDelayHours)
-
getCaptureDelayHours
public Integer getCaptureDelayHours()
The delay between the authorisation and scheduled auto-capture, specified in hours.- Returns:
- captureDelayHours
-
setCaptureDelayHours
public void setCaptureDelayHours(Integer captureDelayHours)
-
channel
public CreateCheckoutSessionResponse channel(CreateCheckoutSessionResponse.ChannelEnum channel)
-
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)
-
company
public CreateCheckoutSessionResponse company(Company company)
-
getCompany
public Company getCompany()
Get company- Returns:
- company
-
setCompany
public void setCompany(Company company)
-
countryCode
public CreateCheckoutSessionResponse countryCode(String countryCode)
-
getCountryCode
public String getCountryCode()
The shopper's two-letter country code.- Returns:
- countryCode
-
setCountryCode
public void setCountryCode(String countryCode)
-
dateOfBirth
public CreateCheckoutSessionResponse dateOfBirth(OffsetDateTime dateOfBirth)
-
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)
-
deliverAt
public CreateCheckoutSessionResponse deliverAt(OffsetDateTime deliverAt)
-
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)
-
deliveryAddress
public CreateCheckoutSessionResponse deliveryAddress(DeliveryAddress deliveryAddress)
-
getDeliveryAddress
public DeliveryAddress getDeliveryAddress()
Get deliveryAddress- Returns:
- deliveryAddress
-
setDeliveryAddress
public void setDeliveryAddress(DeliveryAddress deliveryAddress)
-
enableOneClick
public CreateCheckoutSessionResponse enableOneClick(Boolean enableOneClick)
-
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.- Returns:
- enableOneClick
-
setEnableOneClick
public void setEnableOneClick(Boolean enableOneClick)
-
enablePayOut
public CreateCheckoutSessionResponse enablePayOut(Boolean enablePayOut)
-
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)
-
enableRecurring
public CreateCheckoutSessionResponse enableRecurring(Boolean enableRecurring)
-
getEnableRecurring
public Boolean getEnableRecurring()
When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.- Returns:
- enableRecurring
-
setEnableRecurring
public void setEnableRecurring(Boolean enableRecurring)
-
expiresAt
public CreateCheckoutSessionResponse expiresAt(OffsetDateTime expiresAt)
-
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)
-
fundOrigin
public CreateCheckoutSessionResponse fundOrigin(FundOrigin fundOrigin)
-
getFundOrigin
public FundOrigin getFundOrigin()
Get fundOrigin- Returns:
- fundOrigin
-
setFundOrigin
public void setFundOrigin(FundOrigin fundOrigin)
-
fundRecipient
public CreateCheckoutSessionResponse fundRecipient(FundRecipient fundRecipient)
-
getFundRecipient
public FundRecipient getFundRecipient()
Get fundRecipient- Returns:
- fundRecipient
-
setFundRecipient
public void setFundRecipient(FundRecipient fundRecipient)
-
id
public CreateCheckoutSessionResponse id(String id)
-
getId
public String getId()
A unique identifier of the session.- Returns:
- id
-
setId
public void setId(String id)
-
installmentOptions
public CreateCheckoutSessionResponse installmentOptions(Map<String,CheckoutSessionInstallmentOption> installmentOptions)
-
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)
-
lineItems
public CreateCheckoutSessionResponse lineItems(List<LineItem> lineItems)
-
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, and Zip.- Returns:
- lineItems
-
mandate
public CreateCheckoutSessionResponse mandate(Mandate mandate)
-
getMandate
public Mandate getMandate()
Get mandate- Returns:
- mandate
-
setMandate
public void setMandate(Mandate mandate)
-
mcc
public CreateCheckoutSessionResponse mcc(String mcc)
-
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)
-
merchantAccount
public CreateCheckoutSessionResponse merchantAccount(String merchantAccount)
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
-
merchantOrderReference
public CreateCheckoutSessionResponse merchantOrderReference(String merchantOrderReference)
-
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)
-
metadata
public CreateCheckoutSessionResponse metadata(Map<String,String> metadata)
-
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
-
mode
public CreateCheckoutSessionResponse mode(CreateCheckoutSessionResponse.ModeEnum mode)
-
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)
-
mpiData
public CreateCheckoutSessionResponse mpiData(ThreeDSecureData mpiData)
-
getMpiData
public ThreeDSecureData getMpiData()
Get mpiData- Returns:
- mpiData
-
setMpiData
public void setMpiData(ThreeDSecureData mpiData)
-
platformChargebackLogic
public CreateCheckoutSessionResponse platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
-
getPlatformChargebackLogic
public PlatformChargebackLogic getPlatformChargebackLogic()
Get platformChargebackLogic- Returns:
- platformChargebackLogic
-
setPlatformChargebackLogic
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
-
recurringExpiry
public CreateCheckoutSessionResponse recurringExpiry(String recurringExpiry)
-
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)
-
recurringFrequency
public CreateCheckoutSessionResponse recurringFrequency(String recurringFrequency)
-
getRecurringFrequency
public String getRecurringFrequency()
Minimum number of days between authorisations. Only for 3D Secure 2.- Returns:
- recurringFrequency
-
setRecurringFrequency
public void setRecurringFrequency(String recurringFrequency)
-
recurringProcessingModel
public CreateCheckoutSessionResponse recurringProcessingModel(CreateCheckoutSessionResponse.RecurringProcessingModelEnum recurringProcessingModel)
-
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)
-
redirectFromIssuerMethod
public CreateCheckoutSessionResponse redirectFromIssuerMethod(String redirectFromIssuerMethod)
-
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)
-
redirectToIssuerMethod
public CreateCheckoutSessionResponse redirectToIssuerMethod(String redirectToIssuerMethod)
-
getRedirectToIssuerMethod
public String getRedirectToIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting to the issuer.- Returns:
- redirectToIssuerMethod
-
setRedirectToIssuerMethod
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
-
reference
public CreateCheckoutSessionResponse reference(String reference)
-
getReference
public String getReference()
The reference to uniquely identify a payment.- Returns:
- reference
-
setReference
public void setReference(String reference)
-
returnUrl
public CreateCheckoutSessionResponse returnUrl(String returnUrl)
-
getReturnUrl
public String getReturnUrl()
The URL to return to when a redirect payment is completed.- Returns:
- returnUrl
-
setReturnUrl
public void setReturnUrl(String returnUrl)
-
riskData
public CreateCheckoutSessionResponse riskData(RiskData riskData)
-
getRiskData
public RiskData getRiskData()
Get riskData- Returns:
- riskData
-
setRiskData
public void setRiskData(RiskData riskData)
-
sessionData
public CreateCheckoutSessionResponse sessionData(String sessionData)
-
getSessionData
public String getSessionData()
The payment session data you need to pass to your front end.- Returns:
- sessionData
-
setSessionData
public void setSessionData(String sessionData)
-
shopperEmail
public CreateCheckoutSessionResponse shopperEmail(String shopperEmail)
-
getShopperEmail
public String getShopperEmail()
The shopper's email address.- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
-
shopperIP
public CreateCheckoutSessionResponse shopperIP(String shopperIP)
-
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)
-
shopperInteraction
public CreateCheckoutSessionResponse shopperInteraction(CreateCheckoutSessionResponse.ShopperInteractionEnum shopperInteraction)
-
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)
-
shopperLocale
public CreateCheckoutSessionResponse shopperLocale(String shopperLocale)
-
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)
-
shopperName
public CreateCheckoutSessionResponse shopperName(Name shopperName)
-
getShopperName
public Name getShopperName()
Get shopperName- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
-
shopperReference
public CreateCheckoutSessionResponse shopperReference(String shopperReference)
-
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)
-
shopperStatement
public CreateCheckoutSessionResponse shopperStatement(String shopperStatement)
-
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)
-
socialSecurityNumber
public CreateCheckoutSessionResponse socialSecurityNumber(String socialSecurityNumber)
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
The shopper's social security number.- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
-
splitCardFundingSources
public CreateCheckoutSessionResponse splitCardFundingSources(Boolean splitCardFundingSources)
-
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)
-
splits
public CreateCheckoutSessionResponse splits(List<Split> splits)
-
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/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).- Returns:
- splits
-
store
public CreateCheckoutSessionResponse store(String store)
-
getStore
public String getStore()
The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).- Returns:
- store
-
setStore
public void setStore(String store)
-
storePaymentMethod
public CreateCheckoutSessionResponse storePaymentMethod(Boolean storePaymentMethod)
-
getStorePaymentMethod
public Boolean getStorePaymentMethod()
When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.- Returns:
- storePaymentMethod
-
setStorePaymentMethod
public void setStorePaymentMethod(Boolean storePaymentMethod)
-
storePaymentMethodMode
public CreateCheckoutSessionResponse storePaymentMethodMode(CreateCheckoutSessionResponse.StorePaymentMethodModeEnum storePaymentMethodMode)
-
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)
-
telephoneNumber
public CreateCheckoutSessionResponse telephoneNumber(String telephoneNumber)
-
getTelephoneNumber
public String getTelephoneNumber()
The shopper's telephone number.- Returns:
- telephoneNumber
-
setTelephoneNumber
public void setTelephoneNumber(String telephoneNumber)
-
threeDSAuthenticationOnly
public CreateCheckoutSessionResponse threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
-
getThreeDSAuthenticationOnly
@Deprecated public Boolean getThreeDSAuthenticationOnly()
Deprecated.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.
-
trustedShopper
public CreateCheckoutSessionResponse trustedShopper(Boolean trustedShopper)
-
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)
-
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
-
-