public class CreateCheckoutSessionRequest extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateCheckoutSessionRequest.ChannelEnum
The platform where a payment transaction takes place.
|
static class |
CreateCheckoutSessionRequest.RecurringProcessingModelEnum
Defines a recurring payment type.
|
static class |
CreateCheckoutSessionRequest.ShopperInteractionEnum
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
|
| Constructor and Description |
|---|
CreateCheckoutSessionRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateCheckoutSessionRequest |
accountInfo(AccountInfo accountInfo) |
CreateCheckoutSessionRequest |
addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem) |
CreateCheckoutSessionRequest |
addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem) |
CreateCheckoutSessionRequest |
additionalAmount(Amount additionalAmount) |
CreateCheckoutSessionRequest |
additionalData(Map<String,String> additionalData) |
CreateCheckoutSessionRequest |
addLineItemsItem(LineItem lineItemsItem) |
CreateCheckoutSessionRequest |
addSplitsItem(Split splitsItem) |
CreateCheckoutSessionRequest |
allowedPaymentMethods(List<String> allowedPaymentMethods) |
CreateCheckoutSessionRequest |
amount(Amount amount) |
CreateCheckoutSessionRequest |
applicationInfo(ApplicationInfo applicationInfo) |
CreateCheckoutSessionRequest |
billingAddress(Address billingAddress) |
CreateCheckoutSessionRequest |
blockedPaymentMethods(List<String> blockedPaymentMethods) |
CreateCheckoutSessionRequest |
captureDelayHours(Integer captureDelayHours) |
CreateCheckoutSessionRequest |
channel(CreateCheckoutSessionRequest.ChannelEnum channel) |
CreateCheckoutSessionRequest |
company(Company company) |
CreateCheckoutSessionRequest |
countryCode(String countryCode) |
CreateCheckoutSessionRequest |
dateOfBirth(String dateOfBirth) |
CreateCheckoutSessionRequest |
deliveryAddress(Address deliveryAddress) |
CreateCheckoutSessionRequest |
enableOneClick(Boolean enableOneClick) |
CreateCheckoutSessionRequest |
enablePayOut(Boolean enablePayOut) |
CreateCheckoutSessionRequest |
enableRecurring(Boolean enableRecurring) |
boolean |
equals(Object o) |
CreateCheckoutSessionRequest |
expiresAt(String expiresAt) |
AccountInfo |
getAccountInfo()
Get accountInfo
|
Amount |
getAdditionalAmount()
Get additionalAmount
|
Map<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.
|
Amount |
getAmount()
Get amount
|
ApplicationInfo |
getApplicationInfo()
Get applicationInfo
|
Address |
getBillingAddress()
Get billingAddress
|
List<String> |
getBlockedPaymentMethods()
List of payment methods to be hidden from the shopper.
|
Integer |
getCaptureDelayHours()
The delay between the authorisation and scheduled auto-capture, specified in hours.
|
CreateCheckoutSessionRequest.ChannelEnum |
getChannel()
The platform where a payment transaction takes place.
|
Company |
getCompany()
Get company
|
String |
getCountryCode()
The shopper's two-letter country code.
|
String |
getDateOfBirth()
The shopper's date of birth.
|
Address |
getDeliveryAddress()
Get deliveryAddress
|
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.
|
Boolean |
getEnablePayOut()
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
Boolean |
getEnableRecurring()
When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
|
String |
getExpiresAt()
The date the session expires in ISO8601 format.
|
List<LineItem> |
getLineItems()
Price and product information about the purchased items, to be included on the invoice sent to the shopper.
|
Mandate |
getMandate()
Get mandate
|
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.
|
String |
getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.
|
String |
getMerchantOrderReference()
This reference allows linking multiple transactions to each other for reporting purposes (i.e.
|
Map<String,String> |
getMetadata()
Metadata consists of entries, each of which includes a key and a value.
|
ThreeDSecureData |
getMpiData()
Get mpiData
|
String |
getRecurringExpiry()
Date after which no further authorisations shall be performed.
|
String |
getRecurringFrequency()
Minimum number of days between authorisations.
|
CreateCheckoutSessionRequest.RecurringProcessingModelEnum |
getRecurringProcessingModel()
Defines a recurring payment type.
|
String |
getRedirectFromIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting back from the issuer.
|
String |
getRedirectToIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting to the issuer.
|
String |
getReference()
The reference to uniquely identify a payment.
|
String |
getReturnUrl()
The URL to return to when a redirect payment is completed.
|
RiskData |
getRiskData()
Get riskData
|
String |
getShopperEmail()
The shopper's email address.
|
CreateCheckoutSessionRequest.ShopperInteractionEnum |
getShopperInteraction()
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
|
String |
getShopperIP()
The shopper's IP address.
|
String |
getShopperLocale()
The combination of a language code and a country code to specify the language to be used in the payment.
|
Name |
getShopperName()
Get shopperName
|
String |
getShopperReference()
Your reference to uniquely identify this shopper, for example user ID or account ID.
|
String |
getShopperStatement()
The text to be shown on the shopper's bank statement.
|
String |
getSocialSecurityNumber()
The shopper's social security number.
|
Boolean |
getSplitCardFundingSources()
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 the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
Boolean |
getStorePaymentMethod()
When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.
|
String |
getTelephoneNumber()
The shopper's telephone number.
|
Boolean |
getThreeDSAuthenticationOnly()
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.
|
Boolean |
getTrustedShopper()
Set to true if the payment should be routed to a trusted MID.
|
int |
hashCode() |
CreateCheckoutSessionRequest |
lineItems(List<LineItem> lineItems) |
CreateCheckoutSessionRequest |
mandate(Mandate mandate) |
CreateCheckoutSessionRequest |
mcc(String mcc) |
CreateCheckoutSessionRequest |
merchantAccount(String merchantAccount) |
CreateCheckoutSessionRequest |
merchantOrderReference(String merchantOrderReference) |
CreateCheckoutSessionRequest |
metadata(Map<String,String> metadata) |
CreateCheckoutSessionRequest |
mpiData(ThreeDSecureData mpiData) |
CreateCheckoutSessionRequest |
putAdditionalDataItem(String key,
String additionalDataItem) |
CreateCheckoutSessionRequest |
putMetadataItem(String key,
String metadataItem) |
CreateCheckoutSessionRequest |
recurringExpiry(String recurringExpiry) |
CreateCheckoutSessionRequest |
recurringFrequency(String recurringFrequency) |
CreateCheckoutSessionRequest |
recurringProcessingModel(CreateCheckoutSessionRequest.RecurringProcessingModelEnum recurringProcessingModel) |
CreateCheckoutSessionRequest |
redirectFromIssuerMethod(String redirectFromIssuerMethod) |
CreateCheckoutSessionRequest |
redirectToIssuerMethod(String redirectToIssuerMethod) |
CreateCheckoutSessionRequest |
reference(String reference) |
CreateCheckoutSessionRequest |
returnUrl(String returnUrl) |
CreateCheckoutSessionRequest |
riskData(RiskData riskData) |
void |
setAccountInfo(AccountInfo accountInfo) |
void |
setAdditionalAmount(Amount additionalAmount) |
void |
setAdditionalData(Map<String,String> additionalData) |
void |
setAllowedPaymentMethods(List<String> allowedPaymentMethods) |
void |
setAmount(Amount amount) |
void |
setApplicationInfo(ApplicationInfo applicationInfo) |
void |
setBillingAddress(Address billingAddress) |
void |
setBlockedPaymentMethods(List<String> blockedPaymentMethods) |
void |
setCaptureDelayHours(Integer captureDelayHours) |
void |
setChannel(CreateCheckoutSessionRequest.ChannelEnum channel) |
void |
setCompany(Company company) |
void |
setCountryCode(String countryCode) |
void |
setDateOfBirth(String dateOfBirth) |
void |
setDeliveryAddress(Address deliveryAddress) |
void |
setEnableOneClick(Boolean enableOneClick) |
void |
setEnablePayOut(Boolean enablePayOut) |
void |
setEnableRecurring(Boolean enableRecurring) |
void |
setExpiresAt(String expiresAt) |
void |
setLineItems(List<LineItem> lineItems) |
void |
setMandate(Mandate mandate) |
void |
setMcc(String mcc) |
void |
setMerchantAccount(String merchantAccount) |
void |
setMerchantOrderReference(String merchantOrderReference) |
void |
setMetadata(Map<String,String> metadata) |
void |
setMpiData(ThreeDSecureData mpiData) |
void |
setRecurringExpiry(String recurringExpiry) |
void |
setRecurringFrequency(String recurringFrequency) |
void |
setRecurringProcessingModel(CreateCheckoutSessionRequest.RecurringProcessingModelEnum recurringProcessingModel) |
void |
setRedirectFromIssuerMethod(String redirectFromIssuerMethod) |
void |
setRedirectToIssuerMethod(String redirectToIssuerMethod) |
void |
setReference(String reference) |
void |
setReturnUrl(String returnUrl) |
void |
setRiskData(RiskData riskData) |
void |
setShopperEmail(String shopperEmail) |
void |
setShopperInteraction(CreateCheckoutSessionRequest.ShopperInteractionEnum shopperInteraction) |
void |
setShopperIP(String shopperIP) |
void |
setShopperLocale(String shopperLocale) |
void |
setShopperName(Name shopperName) |
void |
setShopperReference(String shopperReference) |
void |
setShopperStatement(String shopperStatement) |
void |
setSocialSecurityNumber(String socialSecurityNumber) |
void |
setSplitCardFundingSources(Boolean splitCardFundingSources) |
void |
setSplits(List<Split> splits) |
void |
setStorePaymentMethod(Boolean storePaymentMethod) |
void |
setTelephoneNumber(String telephoneNumber) |
void |
setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) |
void |
setTrustedShopper(Boolean trustedShopper) |
CreateCheckoutSessionRequest |
shopperEmail(String shopperEmail) |
CreateCheckoutSessionRequest |
shopperInteraction(CreateCheckoutSessionRequest.ShopperInteractionEnum shopperInteraction) |
CreateCheckoutSessionRequest |
shopperIP(String shopperIP) |
CreateCheckoutSessionRequest |
shopperLocale(String shopperLocale) |
CreateCheckoutSessionRequest |
shopperName(Name shopperName) |
CreateCheckoutSessionRequest |
shopperReference(String shopperReference) |
CreateCheckoutSessionRequest |
shopperStatement(String shopperStatement) |
CreateCheckoutSessionRequest |
socialSecurityNumber(String socialSecurityNumber) |
CreateCheckoutSessionRequest |
splitCardFundingSources(Boolean splitCardFundingSources) |
CreateCheckoutSessionRequest |
splits(List<Split> splits) |
CreateCheckoutSessionRequest |
storePaymentMethod(Boolean storePaymentMethod) |
CreateCheckoutSessionRequest |
telephoneNumber(String telephoneNumber) |
CreateCheckoutSessionRequest |
threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) |
String |
toString() |
CreateCheckoutSessionRequest |
trustedShopper(Boolean trustedShopper) |
public static final String SERIALIZED_NAME_ACCOUNT_INFO
public static final String SERIALIZED_NAME_ADDITIONAL_AMOUNT
public static final String SERIALIZED_NAME_ADDITIONAL_DATA
public static final String SERIALIZED_NAME_ALLOWED_PAYMENT_METHODS
public static final String SERIALIZED_NAME_AMOUNT
public static final String SERIALIZED_NAME_APPLICATION_INFO
public static final String SERIALIZED_NAME_BILLING_ADDRESS
public static final String SERIALIZED_NAME_BLOCKED_PAYMENT_METHODS
public static final String SERIALIZED_NAME_CAPTURE_DELAY_HOURS
public static final String SERIALIZED_NAME_CHANNEL
public static final String SERIALIZED_NAME_COMPANY
public static final String SERIALIZED_NAME_COUNTRY_CODE
public static final String SERIALIZED_NAME_DATE_OF_BIRTH
public static final String SERIALIZED_NAME_DELIVERY_ADDRESS
public static final String SERIALIZED_NAME_ENABLE_ONE_CLICK
public static final String SERIALIZED_NAME_ENABLE_PAY_OUT
public static final String SERIALIZED_NAME_ENABLE_RECURRING
public static final String SERIALIZED_NAME_EXPIRES_AT
public static final String SERIALIZED_NAME_LINE_ITEMS
public static final String SERIALIZED_NAME_MANDATE
public static final String SERIALIZED_NAME_MCC
public static final String SERIALIZED_NAME_MERCHANT_ACCOUNT
public static final String SERIALIZED_NAME_MERCHANT_ORDER_REFERENCE
public static final String SERIALIZED_NAME_METADATA
public static final String SERIALIZED_NAME_MPI_DATA
public static final String SERIALIZED_NAME_RECURRING_EXPIRY
public static final String SERIALIZED_NAME_RECURRING_FREQUENCY
public static final String SERIALIZED_NAME_RECURRING_PROCESSING_MODEL
public static final String SERIALIZED_NAME_REDIRECT_FROM_ISSUER_METHOD
public static final String SERIALIZED_NAME_REDIRECT_TO_ISSUER_METHOD
public static final String SERIALIZED_NAME_REFERENCE
public static final String SERIALIZED_NAME_RETURN_URL
public static final String SERIALIZED_NAME_RISK_DATA
public static final String SERIALIZED_NAME_SHOPPER_EMAIL
public static final String SERIALIZED_NAME_SHOPPER_I_P
public static final String SERIALIZED_NAME_SHOPPER_INTERACTION
public static final String SERIALIZED_NAME_SHOPPER_LOCALE
public static final String SERIALIZED_NAME_SHOPPER_NAME
public static final String SERIALIZED_NAME_SHOPPER_REFERENCE
public static final String SERIALIZED_NAME_SHOPPER_STATEMENT
public static final String SERIALIZED_NAME_SOCIAL_SECURITY_NUMBER
public static final String SERIALIZED_NAME_SPLIT_CARD_FUNDING_SOURCES
public static final String SERIALIZED_NAME_SPLITS
public static final String SERIALIZED_NAME_STORE_PAYMENT_METHOD
public static final String SERIALIZED_NAME_TELEPHONE_NUMBER
public static final String SERIALIZED_NAME_THREE_D_S_AUTHENTICATION_ONLY
public static final String SERIALIZED_NAME_TRUSTED_SHOPPER
public CreateCheckoutSessionRequest accountInfo(AccountInfo accountInfo)
public AccountInfo getAccountInfo()
public void setAccountInfo(AccountInfo accountInfo)
public CreateCheckoutSessionRequest additionalAmount(Amount additionalAmount)
public Amount getAdditionalAmount()
public void setAdditionalAmount(Amount additionalAmount)
public CreateCheckoutSessionRequest additionalData(Map<String,String> additionalData)
public CreateCheckoutSessionRequest putAdditionalDataItem(String key, String additionalDataItem)
public Map<String,String> getAdditionalData()
public CreateCheckoutSessionRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
public CreateCheckoutSessionRequest addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
public List<String> getAllowedPaymentMethods()
public CreateCheckoutSessionRequest amount(Amount amount)
public Amount getAmount()
public void setAmount(Amount amount)
public CreateCheckoutSessionRequest applicationInfo(ApplicationInfo applicationInfo)
public ApplicationInfo getApplicationInfo()
public void setApplicationInfo(ApplicationInfo applicationInfo)
public CreateCheckoutSessionRequest billingAddress(Address billingAddress)
public Address getBillingAddress()
public void setBillingAddress(Address billingAddress)
public CreateCheckoutSessionRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
public CreateCheckoutSessionRequest addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
public List<String> getBlockedPaymentMethods()
public CreateCheckoutSessionRequest captureDelayHours(Integer captureDelayHours)
public Integer getCaptureDelayHours()
public void setCaptureDelayHours(Integer captureDelayHours)
public CreateCheckoutSessionRequest channel(CreateCheckoutSessionRequest.ChannelEnum channel)
public CreateCheckoutSessionRequest.ChannelEnum getChannel()
public void setChannel(CreateCheckoutSessionRequest.ChannelEnum channel)
public CreateCheckoutSessionRequest company(Company company)
public Company getCompany()
public void setCompany(Company company)
public CreateCheckoutSessionRequest countryCode(String countryCode)
public String getCountryCode()
public void setCountryCode(String countryCode)
public CreateCheckoutSessionRequest dateOfBirth(String dateOfBirth)
public String getDateOfBirth()
public void setDateOfBirth(String dateOfBirth)
public CreateCheckoutSessionRequest deliveryAddress(Address deliveryAddress)
public Address getDeliveryAddress()
public void setDeliveryAddress(Address deliveryAddress)
public CreateCheckoutSessionRequest enableOneClick(Boolean enableOneClick)
public Boolean getEnableOneClick()
public void setEnableOneClick(Boolean enableOneClick)
public CreateCheckoutSessionRequest enablePayOut(Boolean enablePayOut)
public Boolean getEnablePayOut()
public void setEnablePayOut(Boolean enablePayOut)
public CreateCheckoutSessionRequest enableRecurring(Boolean enableRecurring)
public Boolean getEnableRecurring()
public void setEnableRecurring(Boolean enableRecurring)
public CreateCheckoutSessionRequest expiresAt(String expiresAt)
public String getExpiresAt()
public void setExpiresAt(String expiresAt)
public CreateCheckoutSessionRequest lineItems(List<LineItem> lineItems)
public CreateCheckoutSessionRequest addLineItemsItem(LineItem lineItemsItem)
public List<LineItem> getLineItems()
public CreateCheckoutSessionRequest mandate(Mandate mandate)
public Mandate getMandate()
public void setMandate(Mandate mandate)
public CreateCheckoutSessionRequest mcc(String mcc)
public String getMcc()
public void setMcc(String mcc)
public CreateCheckoutSessionRequest merchantAccount(String merchantAccount)
public String getMerchantAccount()
public void setMerchantAccount(String merchantAccount)
public CreateCheckoutSessionRequest merchantOrderReference(String merchantOrderReference)
public String getMerchantOrderReference()
public void setMerchantOrderReference(String merchantOrderReference)
public CreateCheckoutSessionRequest metadata(Map<String,String> metadata)
public CreateCheckoutSessionRequest putMetadataItem(String key, String metadataItem)
public Map<String,String> getMetadata()
public CreateCheckoutSessionRequest mpiData(ThreeDSecureData mpiData)
public ThreeDSecureData getMpiData()
public void setMpiData(ThreeDSecureData mpiData)
public CreateCheckoutSessionRequest recurringExpiry(String recurringExpiry)
public String getRecurringExpiry()
public void setRecurringExpiry(String recurringExpiry)
public CreateCheckoutSessionRequest recurringFrequency(String recurringFrequency)
public String getRecurringFrequency()
public void setRecurringFrequency(String recurringFrequency)
public CreateCheckoutSessionRequest recurringProcessingModel(CreateCheckoutSessionRequest.RecurringProcessingModelEnum recurringProcessingModel)
public CreateCheckoutSessionRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
public void setRecurringProcessingModel(CreateCheckoutSessionRequest.RecurringProcessingModelEnum recurringProcessingModel)
public CreateCheckoutSessionRequest redirectFromIssuerMethod(String redirectFromIssuerMethod)
public String getRedirectFromIssuerMethod()
public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod)
public CreateCheckoutSessionRequest redirectToIssuerMethod(String redirectToIssuerMethod)
public String getRedirectToIssuerMethod()
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
public CreateCheckoutSessionRequest reference(String reference)
public String getReference()
public void setReference(String reference)
public CreateCheckoutSessionRequest returnUrl(String returnUrl)
public String getReturnUrl()
public void setReturnUrl(String returnUrl)
public CreateCheckoutSessionRequest riskData(RiskData riskData)
public RiskData getRiskData()
public void setRiskData(RiskData riskData)
public CreateCheckoutSessionRequest shopperEmail(String shopperEmail)
public String getShopperEmail()
public void setShopperEmail(String shopperEmail)
public CreateCheckoutSessionRequest shopperIP(String shopperIP)
public String getShopperIP()
public void setShopperIP(String shopperIP)
public CreateCheckoutSessionRequest shopperInteraction(CreateCheckoutSessionRequest.ShopperInteractionEnum shopperInteraction)
public CreateCheckoutSessionRequest.ShopperInteractionEnum getShopperInteraction()
public void setShopperInteraction(CreateCheckoutSessionRequest.ShopperInteractionEnum shopperInteraction)
public CreateCheckoutSessionRequest shopperLocale(String shopperLocale)
public String getShopperLocale()
public void setShopperLocale(String shopperLocale)
public CreateCheckoutSessionRequest shopperName(Name shopperName)
public Name getShopperName()
public void setShopperName(Name shopperName)
public CreateCheckoutSessionRequest shopperReference(String shopperReference)
public String getShopperReference()
public void setShopperReference(String shopperReference)
public CreateCheckoutSessionRequest shopperStatement(String shopperStatement)
public String getShopperStatement()
public void setShopperStatement(String shopperStatement)
public CreateCheckoutSessionRequest socialSecurityNumber(String socialSecurityNumber)
public String getSocialSecurityNumber()
public void setSocialSecurityNumber(String socialSecurityNumber)
public CreateCheckoutSessionRequest splitCardFundingSources(Boolean splitCardFundingSources)
public Boolean getSplitCardFundingSources()
public void setSplitCardFundingSources(Boolean splitCardFundingSources)
public CreateCheckoutSessionRequest splits(List<Split> splits)
public CreateCheckoutSessionRequest addSplitsItem(Split splitsItem)
public List<Split> getSplits()
public CreateCheckoutSessionRequest storePaymentMethod(Boolean storePaymentMethod)
public Boolean getStorePaymentMethod()
public void setStorePaymentMethod(Boolean storePaymentMethod)
public CreateCheckoutSessionRequest telephoneNumber(String telephoneNumber)
public String getTelephoneNumber()
public void setTelephoneNumber(String telephoneNumber)
public CreateCheckoutSessionRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
public Boolean getThreeDSAuthenticationOnly()
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
public CreateCheckoutSessionRequest trustedShopper(Boolean trustedShopper)
public Boolean getTrustedShopper()
public void setTrustedShopper(Boolean trustedShopper)
Copyright © 2022. All rights reserved.