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 and Description
static class	AbstractPaymentRequest.FundingSourceEnum How to process a combo card (for some Brazilian cards only).
static class	AbstractPaymentRequest.ShopperInteractionEnum how the shopper interacts with the system

Constructor Summary

Constructors

Constructor and Description
AbstractPaymentRequest()

Method Summary

Modifier and Type	Method and Description
T	additionalAmount(Amount additionalAmount)
T	additionalData(Map<String,String> additionalData)
T	billingAddress(Address billingAddress)
T	browserInfo(BrowserInfo browserInfo)
T	captureDelayHours(Integer captureDelayHours)
T	dateOfBirth(Date dateOfBirth)
T	dccQuote(ForexQuote dccQuote)
T	deliveryAddress(Address deliveryAddress)
T	deliveryDate(Date deliveryDate)
T	deviceFingerprint(String deviceFingerprint)
T	enableRealTimeUpdate(Boolean enableRealTimeUpdate)
boolean	equals(Object o)
T	fraudOffset(Integer fraudOffset)
T	fundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)
Amount	getAdditionalAmount() 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 data
Amount	getAmount() the amount to charge
ApplicationInfo	getApplicationInfo()
Address	getBillingAddress() the address where to send the invoice
BrowserInfo	getBrowserInfo() the browser info data
Integer	getCaptureDelayHours() the number of hours delay between the authorisation and scheduled auto-capture
Date	getDateOfBirth() the shopper's date of birth
ForexQuote	getDccQuote() the forex quote as returned in the response of the forex service
Address	getDeliveryAddress() the address where to deliver
Date	getDeliveryDate() the expected date of delivery or fulfillment
String	getDeviceFingerprint() Get deviceFingerprint
Integer	getFraudOffset() the offset that is added to the normal fraud score (positive or negative)
AbstractPaymentRequest.FundingSourceEnum	getFundingSource() How to process a combo card (for some Brazilian cards only).
Installments	getInstallments() the installment properties of the payment
String	getMcc() the mcc value that is required to process this payment
String	getMerchantAccount() the merchant account which will be used to process the payment
String	getMerchantOrderReference() the reference to link multiple transactions to each other
Map<String,String>	getMetadata() a map of key/value pairs of metadata sent by merchant
Map<String,String>	getOrCreateAdditionalData() get additionalData map Create the map if doesn't exists
String	getOrderReference() the order reference to link multiple partial payments
Recurring	getRecurring() the recurring properties of the payment
String	getReference() the reference assigned to the payment
String	getSelectedBrand() the selected brand how to process the payment for dual branded cards
String	getSelectedRecurringDetailReference() the recurringDetailReference you want to use for this payment
String	getSessionId() Get sessionId
String	getShopperEmail() the email address of the shopper / customer
AbstractPaymentRequest.ShopperInteractionEnum	getShopperInteraction() how the shopper interacts with the system
String	getShopperIP() the IP address of the shopper
String	getShopperLocale() the combination of language code and country code to specify the language to be used in the payment
Name	getShopperName() the name of the shopper
String	getShopperReference() a reference used to uniquely identify the shopper (e.g.
String	getShopperStatement() the text to appear on the shopper's statement
String	getSocialSecurityNumber() the shopper's social security number
String	getTelephoneNumber() the shopper's telephone number
int	hashCode()
T	installments(Installments installments)
Boolean	isEnableRealTimeUpdate() Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
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.
T	mcc(String mcc)
T	merchantAccount(String merchantAccount)
T	merchantOrderReference(String merchantOrderReference)
T	metadata(Map<String,String> metadata)
T	orderReference(String orderReference)
T	recurring(Recurring recurring)
T	reference(String reference)
T	selectedBrand(String selectedBrand)
T	selectedRecurringDetailReference(String selectedRecurringDetailReference)
T	sessionId(String sessionId)
void	setAdditionalAmount(Amount additionalAmount)
void	setAdditionalData(Map<String,String> additionalData)
void	setAmount(Amount amount)
void	setBillingAddress(Address billingAddress)
void	setBrowserInfo(BrowserInfo browserInfo)
T	setBrowserInfoData(String userAgent, String acceptHeader) Set browser data
void	setCaptureDelayHours(Integer captureDelayHours)
void	setDateOfBirth(Date dateOfBirth)
void	setDccQuote(ForexQuote dccQuote)
void	setDeliveryAddress(Address deliveryAddress)
void	setDeliveryDate(Date deliveryDate)
void	setDeviceFingerprint(String deviceFingerprint)
void	setEnableRealTimeUpdate(Boolean enableRealTimeUpdate)
void	setFraudOffset(Integer fraudOffset)
void	setFundingSource(AbstractPaymentRequest.FundingSourceEnum fundingSource)
void	setInstallments(Installments installments)
void	setMcc(String mcc)
void	setMerchantAccount(String merchantAccount)
void	setMerchantOrderReference(String merchantOrderReference)
void	setMetadata(Map<String,String> metadata)
void	setOrderReference(String orderReference)
void	setRecurring(Recurring recurring)
void	setReference(String reference)
void	setSelectedBrand(String selectedBrand)
void	setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
void	setSessionId(String sessionId)
void	setShopperEmail(String shopperEmail)
void	setShopperInteraction(AbstractPaymentRequest.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	setTelephoneNumber(String telephoneNumber)
void	setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
T	shopperEmail(String shopperEmail)
T	shopperInteraction(AbstractPaymentRequest.ShopperInteractionEnum shopperInteraction)
T	shopperIP(String shopperIP)
T	shopperLocale(String shopperLocale)
T	shopperName(Name shopperName)
T	shopperReference(String shopperReference)
T	shopperStatement(String shopperStatement)
T	socialSecurityNumber(String socialSecurityNumber)
T	telephoneNumber(String telephoneNumber)
T	threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractPaymentRequest

public AbstractPaymentRequest()

Method Detail

setBrowserInfoData

public T setBrowserInfoData(String userAgent,
                            String acceptHeader)

Set browser data

Parameters:

userAgent - http header

acceptHeader - 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)

reference

public T reference(String reference)

getReference

public String getReference()

the reference assigned to the payment

Returns:

reference

setReference

public void setReference(String reference)

billingAddress

public T billingAddress(Address billingAddress)

getBillingAddress

public Address getBillingAddress()

the address where to send the invoice

Returns:

billingAddress

setBillingAddress

public void setBillingAddress(Address billingAddress)

shopperIP

public T shopperIP(String shopperIP)

getShopperIP

public String getShopperIP()

the IP address of the shopper

Returns:

shopperIP

setShopperIP

public void setShopperIP(String shopperIP)

merchantAccount

public T merchantAccount(String merchantAccount)

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)

shopperEmail

public T shopperEmail(String shopperEmail)

getShopperEmail

public String getShopperEmail()

the email address of the shopper / customer

Returns:

shopperEmail

setShopperEmail

public void setShopperEmail(String shopperEmail)

shopperReference

public T shopperReference(String shopperReference)

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)

recurring

public T recurring(Recurring recurring)

getRecurring

public Recurring getRecurring()

the recurring properties of the payment

Returns:

recurring

setRecurring

public void setRecurring(Recurring recurring)

shopperStatement

public T shopperStatement(String shopperStatement)

getShopperStatement

public String getShopperStatement()

the text to appear on the shopper's statement

Returns:

shopperStatement

setShopperStatement

public void setShopperStatement(String shopperStatement)

fraudOffset

public T fraudOffset(Integer fraudOffset)

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)

sessionId

public T sessionId(String sessionId)

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)

additionalAmount

public T additionalAmount(Amount additionalAmount)

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)

orderReference

public T orderReference(String orderReference)

getOrderReference

public String getOrderReference()

the order reference to link multiple partial payments

Returns:

orderReference

setOrderReference

public void setOrderReference(String orderReference)

merchantOrderReference

public T merchantOrderReference(String merchantOrderReference)

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)

additionalData

public T additionalData(Map<String,String> additionalData)

getAdditionalData

public Map<String,String> getAdditionalData()

a map of name/value pairs for passing in additional/industry-specific data

Returns:

additionalData

setAdditionalData

public void setAdditionalData(Map<String,String> additionalData)

shopperName

public T shopperName(Name shopperName)

getShopperName

public Name getShopperName()

the name of the shopper

Returns:

shopperName

setShopperName

public void setShopperName(Name shopperName)

shopperLocale

public T shopperLocale(String shopperLocale)

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)

selectedBrand

public T selectedBrand(String selectedBrand)

getSelectedBrand

public String getSelectedBrand()

the selected brand how to process the payment for dual branded cards

Returns:

selectedBrand

setSelectedBrand

public void setSelectedBrand(String selectedBrand)

deliveryAddress

public T deliveryAddress(Address deliveryAddress)

getDeliveryAddress

public Address getDeliveryAddress()

the address where to deliver

Returns:

deliveryAddress

setDeliveryAddress

public void setDeliveryAddress(Address deliveryAddress)

deliveryDate

public T deliveryDate(Date deliveryDate)

getDeliveryDate

public Date getDeliveryDate()

the expected date of delivery or fulfillment

Returns:

deliveryDate

setDeliveryDate

public void setDeliveryDate(Date deliveryDate)

deviceFingerprint

public T deviceFingerprint(String deviceFingerprint)

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)

socialSecurityNumber

public T socialSecurityNumber(String socialSecurityNumber)

getSocialSecurityNumber

public String getSocialSecurityNumber()

the shopper's social security number

Returns:

socialSecurityNumber

setSocialSecurityNumber

public void setSocialSecurityNumber(String socialSecurityNumber)

captureDelayHours

public T captureDelayHours(Integer captureDelayHours)

getCaptureDelayHours

public Integer getCaptureDelayHours()

the number of hours delay between the authorisation and scheduled auto-capture

Returns:

captureDelayHours

setCaptureDelayHours

public void setCaptureDelayHours(Integer captureDelayHours)

dateOfBirth

public T dateOfBirth(Date dateOfBirth)

getDateOfBirth

public Date getDateOfBirth()

the shopper's date of birth

Returns:

dateOfBirth

setDateOfBirth

public void setDateOfBirth(Date dateOfBirth)

telephoneNumber

public T telephoneNumber(String telephoneNumber)

getTelephoneNumber

public String getTelephoneNumber()

the shopper's telephone number

Returns:

telephoneNumber

setTelephoneNumber

public void setTelephoneNumber(String telephoneNumber)

mcc

public T mcc(String mcc)

getMcc

public String getMcc()

the mcc value that is required to process this payment

Returns:

mcc

setMcc

public void setMcc(String mcc)

metadata

public T metadata(Map<String,String> metadata)

getApplicationInfo

public ApplicationInfo getApplicationInfo()

getMetadata

public Map<String,String> getMetadata()

a map of key/value pairs of metadata sent by merchant

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

enableRealTimeUpdate

public T enableRealTimeUpdate(Boolean enableRealTimeUpdate)

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)

threeDSAuthenticationOnly

public T threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)

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)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object