Package com.adyen.model
Class AbstractPaymentRequest<T extends AbstractPaymentRequest<T>>
- java.lang.Object
-
- com.adyen.model.AbstractPaymentRequest<T>
-
- Direct Known Subclasses:
PaymentRequest,PaymentRequest3d,PaymentRequest3ds2
public abstract class AbstractPaymentRequest<T extends AbstractPaymentRequest<T>> extends Object
AbstractPaymentRequest Base for PaymentRequest and PaymentRequest3D
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAbstractPaymentRequest.FundingSourceEnumHow to process a combo card (for some Brazilian cards only).static classAbstractPaymentRequest.ShopperInteractionEnumhow the shopper interacts with the system
-
Constructor Summary
Constructors Constructor Description AbstractPaymentRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TadditionalAmount(Amount additionalAmount)TadditionalData(Map<String,String> additionalData)TbillingAddress(Address billingAddress)TbrowserInfo(BrowserInfo browserInfo)TcaptureDelayHours(Integer captureDelayHours)TdateOfBirth(Date dateOfBirth)TdccQuote(ForexQuote dccQuote)TdeliveryAddress(Address deliveryAddress)TdeliveryDate(Date deliveryDate)TdeviceFingerprint(String deviceFingerprint)TenableRealTimeUpdate(Boolean enableRealTimeUpdate)booleanequals(Object o)TfraudOffset(Integer fraudOffset)TfundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)AmountgetAdditionalAmount()the portion of the \"amount\" which is additional/surcharged.Map<String,String>getAdditionalData()a map of name/value pairs for passing in additional/industry-specific dataAmountgetAmount()the amount to chargeApplicationInfogetApplicationInfo()AddressgetBillingAddress()the address where to send the invoiceBrowserInfogetBrowserInfo()the browser info dataIntegergetCaptureDelayHours()the number of hours delay between the authorisation and scheduled auto-captureDategetDateOfBirth()the shopper's date of birthForexQuotegetDccQuote()the forex quote as returned in the response of the forex serviceAddressgetDeliveryAddress()the address where to deliverDategetDeliveryDate()the expected date of delivery or fulfillmentStringgetDeviceFingerprint()Get deviceFingerprintIntegergetFraudOffset()the offset that is added to the normal fraud score (positive or negative)AbstractPaymentRequest.FundingSourceEnumgetFundingSource()How to process a combo card (for some Brazilian cards only).InstallmentsgetInstallments()the installment properties of the paymentStringgetMcc()the mcc value that is required to process this paymentStringgetMerchantAccount()the merchant account which will be used to process the paymentStringgetMerchantOrderReference()the reference to link multiple transactions to each otherMap<String,String>getMetadata()a map of key/value pairs of metadata sent by merchantMap<String,String>getOrCreateAdditionalData()get additionalData map Create the map if doesn't existsStringgetOrderReference()the order reference to link multiple partial paymentsRecurringgetRecurring()the recurring properties of the paymentStringgetReference()the reference assigned to the paymentStringgetSelectedBrand()the selected brand how to process the payment for dual branded cardsStringgetSelectedRecurringDetailReference()the recurringDetailReference you want to use for this paymentStringgetSessionId()Get sessionIdStringgetShopperEmail()the email address of the shopper / customerAbstractPaymentRequest.ShopperInteractionEnumgetShopperInteraction()how the shopper interacts with the systemStringgetShopperIP()the IP address of the shopperStringgetShopperLocale()the combination of language code and country code to specify the language to be used in the paymentNamegetShopperName()the name of the shopperStringgetShopperReference()a reference used to uniquely identify the shopper (e.g.StringgetShopperStatement()the text to appear on the shopper's statementStringgetSocialSecurityNumber()the shopper's social security numberStringgetTelephoneNumber()the shopper's telephone numberinthashCode()Tinstallments(Installments installments)BooleanisEnableRealTimeUpdate()Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.BooleanisThreeDSAuthenticationOnly()If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.Tmcc(String mcc)TmerchantAccount(String merchantAccount)TmerchantOrderReference(String merchantOrderReference)Tmetadata(Map<String,String> metadata)TorderReference(String orderReference)Trecurring(Recurring recurring)Treference(String reference)TselectedBrand(String selectedBrand)TselectedRecurringDetailReference(String selectedRecurringDetailReference)TsessionId(String sessionId)voidsetAdditionalAmount(Amount additionalAmount)voidsetAdditionalData(Map<String,String> additionalData)voidsetAmount(Amount amount)voidsetApplicationInfo(ApplicationInfo applicationInfo)voidsetBillingAddress(Address billingAddress)voidsetBrowserInfo(BrowserInfo browserInfo)TsetBrowserInfoData(String userAgent, String acceptHeader)Set browser datavoidsetCaptureDelayHours(Integer captureDelayHours)voidsetDateOfBirth(Date dateOfBirth)voidsetDccQuote(ForexQuote dccQuote)voidsetDeliveryAddress(Address deliveryAddress)voidsetDeliveryDate(Date deliveryDate)voidsetDeviceFingerprint(String deviceFingerprint)voidsetEnableRealTimeUpdate(Boolean enableRealTimeUpdate)voidsetFraudOffset(Integer fraudOffset)voidsetFundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)voidsetInstallments(Installments installments)voidsetMcc(String mcc)voidsetMerchantAccount(String merchantAccount)voidsetMerchantOrderReference(String merchantOrderReference)voidsetMetadata(Map<String,String> metadata)voidsetOrderReference(String orderReference)voidsetRecurring(Recurring recurring)voidsetReference(String reference)voidsetSelectedBrand(String selectedBrand)voidsetSelectedRecurringDetailReference(String selectedRecurringDetailReference)voidsetSessionId(String sessionId)voidsetShopperEmail(String shopperEmail)voidsetShopperInteraction(AbstractPaymentRequest.ShopperInteractionEnum shopperInteraction)voidsetShopperIP(String shopperIP)voidsetShopperLocale(String shopperLocale)voidsetShopperName(Name shopperName)voidsetShopperReference(String shopperReference)voidsetShopperStatement(String shopperStatement)voidsetSocialSecurityNumber(String socialSecurityNumber)voidsetTelephoneNumber(String telephoneNumber)voidsetThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)TshopperEmail(String shopperEmail)TshopperInteraction(AbstractPaymentRequest.ShopperInteractionEnum shopperInteraction)TshopperIP(String shopperIP)TshopperLocale(String shopperLocale)TshopperName(Name shopperName)TshopperReference(String shopperReference)TshopperStatement(String shopperStatement)TsocialSecurityNumber(String socialSecurityNumber)TtelephoneNumber(String telephoneNumber)TthreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)StringtoString()
-
-
-
Method Detail
-
setBrowserInfoData
public T setBrowserInfoData(String userAgent, String acceptHeader)
Set browser data- Parameters:
userAgent- http headeracceptHeader- http header- Returns:
- browser data
-
getOrCreateAdditionalData
public Map<String,String> getOrCreateAdditionalData()
get additionalData map Create the map if doesn't exists- Returns:
- additional data
-
getAmount
public Amount getAmount()
the amount to charge- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
getReference
public String getReference()
the reference assigned to the payment- Returns:
- reference
-
setReference
public void setReference(String reference)
-
getBillingAddress
public Address getBillingAddress()
the address where to send the invoice- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(Address billingAddress)
-
getShopperIP
public String getShopperIP()
the IP address of the shopper- Returns:
- shopperIP
-
setShopperIP
public void setShopperIP(String shopperIP)
-
getMerchantAccount
public String getMerchantAccount()
the merchant account which will be used to process the payment- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
-
browserInfo
public T browserInfo(BrowserInfo browserInfo)
-
getBrowserInfo
public BrowserInfo getBrowserInfo()
the browser info data- Returns:
- browserInfo
-
setBrowserInfo
public void setBrowserInfo(BrowserInfo browserInfo)
-
shopperInteraction
public T shopperInteraction(AbstractPaymentRequest.ShopperInteractionEnum shopperInteraction)
-
getShopperInteraction
public AbstractPaymentRequest.ShopperInteractionEnum getShopperInteraction()
how the shopper interacts with the system- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(AbstractPaymentRequest.ShopperInteractionEnum shopperInteraction)
-
getShopperEmail
public String getShopperEmail()
the email address of the shopper / customer- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
-
getShopperReference
public String getShopperReference()
a reference used to uniquely identify the shopper (e.g. user ID or account ID)- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
-
getRecurring
public Recurring getRecurring()
the recurring properties of the payment- Returns:
- recurring
-
setRecurring
public void setRecurring(Recurring recurring)
-
getShopperStatement
public String getShopperStatement()
the text to appear on the shopper's statement- Returns:
- shopperStatement
-
setShopperStatement
public void setShopperStatement(String shopperStatement)
-
getFraudOffset
public Integer getFraudOffset()
the offset that is added to the normal fraud score (positive or negative)- Returns:
- fraudOffset
-
setFraudOffset
public void setFraudOffset(Integer fraudOffset)
-
fundingSource
public T fundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)
-
getFundingSource
public AbstractPaymentRequest.FundingSourceEnum getFundingSource()
How to process a combo card (for some Brazilian cards only). Allowed values: * debit * credit- Returns:
- fundingSource
-
setFundingSource
public void setFundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)
-
getSessionId
public String getSessionId()
Get sessionId- Returns:
- sessionId
-
setSessionId
public void setSessionId(String sessionId)
-
getAdditionalAmount
public Amount getAdditionalAmount()
the portion of the \"amount\" which is additional/surcharged. Required to be in the same currency as the amount.- Returns:
- additionalAmount
-
setAdditionalAmount
public void setAdditionalAmount(Amount additionalAmount)
-
selectedRecurringDetailReference
public T selectedRecurringDetailReference(String selectedRecurringDetailReference)
-
getSelectedRecurringDetailReference
public String getSelectedRecurringDetailReference()
the recurringDetailReference you want to use for this payment- Returns:
- selectedRecurringDetailReference
-
setSelectedRecurringDetailReference
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
-
getOrderReference
public String getOrderReference()
the order reference to link multiple partial payments- Returns:
- orderReference
-
setOrderReference
public void setOrderReference(String orderReference)
-
getMerchantOrderReference
public String getMerchantOrderReference()
the reference to link multiple transactions to each other- Returns:
- merchantOrderReference
-
setMerchantOrderReference
public void setMerchantOrderReference(String merchantOrderReference)
-
dccQuote
public T dccQuote(ForexQuote dccQuote)
-
getDccQuote
public ForexQuote getDccQuote()
the forex quote as returned in the response of the forex service- Returns:
- dccQuote
-
setDccQuote
public void setDccQuote(ForexQuote dccQuote)
-
getAdditionalData
public Map<String,String> getAdditionalData()
a map of name/value pairs for passing in additional/industry-specific data- Returns:
- additionalData
-
getShopperName
public Name getShopperName()
the name of the shopper- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
-
getShopperLocale
public String getShopperLocale()
the combination of language code and country code to specify the language to be used in the payment- Returns:
- shopperLocale
-
setShopperLocale
public void setShopperLocale(String shopperLocale)
-
getSelectedBrand
public String getSelectedBrand()
the selected brand how to process the payment for dual branded cards- Returns:
- selectedBrand
-
setSelectedBrand
public void setSelectedBrand(String selectedBrand)
-
getDeliveryAddress
public Address getDeliveryAddress()
the address where to deliver- Returns:
- deliveryAddress
-
setDeliveryAddress
public void setDeliveryAddress(Address deliveryAddress)
-
getDeliveryDate
public Date getDeliveryDate()
the expected date of delivery or fulfillment- Returns:
- deliveryDate
-
setDeliveryDate
public void setDeliveryDate(Date deliveryDate)
-
getDeviceFingerprint
public String getDeviceFingerprint()
Get deviceFingerprint- Returns:
- deviceFingerprint
-
setDeviceFingerprint
public void setDeviceFingerprint(String deviceFingerprint)
-
installments
public T installments(Installments installments)
-
getInstallments
public Installments getInstallments()
the installment properties of the payment- Returns:
- installments
-
setInstallments
public void setInstallments(Installments installments)
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
the shopper's social security number- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
-
getCaptureDelayHours
public Integer getCaptureDelayHours()
the number of hours delay between the authorisation and scheduled auto-capture- Returns:
- captureDelayHours
-
setCaptureDelayHours
public void setCaptureDelayHours(Integer captureDelayHours)
-
getDateOfBirth
public Date getDateOfBirth()
the shopper's date of birth- Returns:
- dateOfBirth
-
setDateOfBirth
public void setDateOfBirth(Date dateOfBirth)
-
getTelephoneNumber
public String getTelephoneNumber()
the shopper's telephone number- Returns:
- telephoneNumber
-
setTelephoneNumber
public void setTelephoneNumber(String telephoneNumber)
-
getMcc
public String getMcc()
the mcc value that is required to process this payment- Returns:
- mcc
-
setMcc
public void setMcc(String mcc)
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
-
getMetadata
public Map<String,String> getMetadata()
a map of key/value pairs of metadata sent by merchant- Returns:
- metadata
-
isEnableRealTimeUpdate
public Boolean isEnableRealTimeUpdate()
Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.- Returns:
- enableRealTimeUpdate
-
setEnableRealTimeUpdate
public void setEnableRealTimeUpdate(Boolean enableRealTimeUpdate)
-
isThreeDSAuthenticationOnly
public Boolean isThreeDSAuthenticationOnly()
If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.- Returns:
- threeDSAuthenticationOnly
-
setThreeDSAuthenticationOnly
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
-
-