com.adyen.model.checkout.PaymentsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* ######
* ######
* ############ ####( ###### #####. ###### ############ ############
* ############# #####( ###### #####. ###### ############# #############
* ###### #####( ###### #####. ###### ##### ###### ##### ######
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
* ###### ###### #####( ###### #####. ###### ##### ##### ######
* ############# ############# ############# ############# ##### ######
* ############ ############ ############# ############ ##### ######
* ######
* #############
* ############
*
* Adyen Java API Library
*
* Copyright (c) 2020 Adyen B.V.
* This file is open source and available under the MIT license.
* See the LICENSE file for more info.
*/
package com.adyen.model.checkout;
import com.adyen.deserializer.PaymentMethodDetailsDeserializerJackson;
import com.adyen.deserializer.PaymentMethodDetailsTypeAdapter;
import com.adyen.model.AccountInfo;
import com.adyen.model.Address;
import com.adyen.model.Amount;
import com.adyen.model.BrowserInfo;
import com.adyen.model.ForexQuote;
import com.adyen.model.Installments;
import com.adyen.model.MerchantRiskIndicator;
import com.adyen.model.Name;
import com.adyen.model.Split;
import com.adyen.model.ThreeDS2RequestData;
import com.adyen.model.applicationinfo.ApplicationInfo;
import com.adyen.serializer.DateSerializer;
import com.adyen.serializer.DateTimeGMTSerializer;
import com.adyen.util.Util;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import static com.adyen.constants.ApiConstants.PaymentMethodType.TYPE_SCHEME;
import static com.adyen.util.Util.toIndentedString;
/**
* PaymentsRequest
*/
public class PaymentsRequest {
@SerializedName("accountInfo")
private AccountInfo accountInfo = null;
@SerializedName("additionalData")
private Map additionalData = null;
@SerializedName("amount")
private Amount amount = null;
@SerializedName("billingAddress")
private Address billingAddress = null;
@SerializedName("captureDelayHours")
private Integer captureDelayHours = null;
@SerializedName("channel")
private ChannelEnum channel = null;
@SerializedName("company")
private Company company = null;
@SerializedName("countryCode")
private String countryCode = null;
@SerializedName("dateOfBirth")
@JsonAdapter(DateSerializer.class)
private Date dateOfBirth = null;
@SerializedName("dccQuote")
private ForexQuote dccQuote = null;
@SerializedName("deliveryAddress")
private Address deliveryAddress = null;
@SerializedName("deliveryDate")
@JsonAdapter(DateTimeGMTSerializer.class)
private Date deliveryDate = null;
@SerializedName("enableOneClick")
private Boolean enableOneClick = null;
@SerializedName("enablePayOut")
private Boolean enablePayOut = null;
@SerializedName("enableRecurring")
private Boolean enableRecurring = null;
@SerializedName("entityType")
private EntityTypeEnum entityType = null;
@SerializedName("fraudOffset")
private Integer fraudOffset = null;
@SerializedName("installments")
private Installments installments = null;
@SerializedName("lineItems")
private List lineItems = null;
@SerializedName("mcc")
private String mcc = null;
@SerializedName("merchantAccount")
private String merchantAccount = null;
@SerializedName("merchantOrderReference")
private String merchantOrderReference = null;
@SerializedName("metadata")
private Map metadata = null;
@SerializedName("orderReference")
private String orderReference = null;
@SerializedName("paymentMethod")
@JsonAdapter(PaymentMethodDetailsTypeAdapter.class)
@JsonDeserialize(using = PaymentMethodDetailsDeserializerJackson.class)
private PaymentMethodDetails paymentMethod = null;
@SerializedName("reference")
private String reference = null;
@SerializedName("returnUrl")
private String returnUrl = null;
@SerializedName("sessionValidity")
private String sessionValidity = null;
@SerializedName("shopperEmail")
private String shopperEmail = null;
@SerializedName("shopperIP")
private String shopperIP = null;
@SerializedName("shopperInteraction")
private ShopperInteractionEnum shopperInteraction = null;
@SerializedName("shopperLocale")
private String shopperLocale = null;
@SerializedName("shopperName")
private Name shopperName = null;
@SerializedName("shopperReference")
private String shopperReference = null;
@SerializedName("shopperStatement")
private String shopperStatement = null;
@SerializedName("socialSecurityNumber")
private String socialSecurityNumber = null;
@SerializedName("telephoneNumber")
private String telephoneNumber = null;
@SerializedName("browserInfo")
private BrowserInfo browserInfo = null;
@SerializedName("deviceFingerprint")
private String deviceFingerprint = null;
@SerializedName("applicationInfo")
private ApplicationInfo applicationInfo;
@SerializedName("splits")
private List splits = null;
@SerializedName("merchantRiskIndicator")
private MerchantRiskIndicator merchantRiskIndicator = null;
@SerializedName("threeDS2RequestData")
private ThreeDS2RequestData threeDS2RequestData = null;
@SerializedName("trustedShopper")
private Boolean trustedShopper = null;
@SerializedName("origin")
private String origin;
@SerializedName("recurringProcessingModel")
private RecurringProcessingModelEnum recurringProcessingModel = null;
@SerializedName("mpiData")
private ThreeDSecureData mpiData = null;
@SerializedName("redirectFromIssuerMethod")
private String redirectFromIssuerMethod = null;
@SerializedName("redirectToIssuerMethod")
private String redirectToIssuerMethod = null;
@SerializedName("order")
private CheckoutOrder order = null;
@SerializedName("storePaymentMethod")
private Boolean storePaymentMethod = null;
@SerializedName("store")
private String store = null;
@SerializedName("threeDSAuthenticationOnly")
private Boolean threeDSAuthenticationOnly = null;
@SerializedName("riskData")
private RiskData riskData = null;
@SerializedName("conversionId")
private String conversionId = null;
@SerializedName("recurringExpiry")
private String recurringExpiry = null;
@SerializedName("recurringFrequency")
private String recurringFrequency = null;
public PaymentsRequest() {
applicationInfo = new ApplicationInfo();
}
public RecurringProcessingModelEnum getRecurringProcessingModel() {
return recurringProcessingModel;
}
public PaymentsRequest recurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) {
this.recurringProcessingModel = recurringProcessingModel;
return this;
}
public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) {
this.recurringProcessingModel = recurringProcessingModel;
}
public MerchantRiskIndicator getMerchantRiskIndicator() {
return merchantRiskIndicator;
}
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) {
this.merchantRiskIndicator = merchantRiskIndicator;
}
public AccountInfo getAccountInfo() {
return accountInfo;
}
public void setAccountInfo(AccountInfo accountInfo) {
this.accountInfo = accountInfo;
}
public Boolean getEnableOneClick() {
return enableOneClick;
}
public Boolean getEnablePayOut() {
return enablePayOut;
}
public Boolean getEnableRecurring() {
return enableRecurring;
}
public List getSplits() {
return splits;
}
public void setSplits(List splits) {
this.splits = splits;
}
public Boolean getTrustedShopper() {
return trustedShopper;
}
public void setTrustedShopper(Boolean trustedShopper) {
this.trustedShopper = trustedShopper;
}
public ThreeDS2RequestData getThreeDS2RequestData() {
return threeDS2RequestData;
}
public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) {
this.threeDS2RequestData = threeDS2RequestData;
}
public PaymentsRequest additionalData(Map additionalData) {
this.additionalData = additionalData;
return this;
}
public PaymentsRequest putAdditionalDataItem(String key, String additionalDataItem) {
if (additionalData == null) {
additionalData = new HashMap<>();
}
additionalData.put(key, additionalDataItem);
return this;
}
/**
* 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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/developers/api-reference/payments-api#paymentrequestadditionaldata).
*
* @return additionalData
**/
public Map getAdditionalData() {
return additionalData;
}
public void setAdditionalData(Map additionalData) {
this.additionalData = additionalData;
}
public PaymentsRequest amount(Amount amount) {
this.amount = amount;
return this;
}
/**
* Get amount
*
* @return amount
**/
public Amount getAmount() {
return amount;
}
public void setAmount(Amount amount) {
this.amount = amount;
}
public PaymentsRequest setAmountData(String amount, String currency) {
Amount amountData = Util.createAmount(amount, currency);
setAmount(amountData);
return this;
}
public PaymentsRequest billingAddress(Address billingAddress) {
this.billingAddress = billingAddress;
return this;
}
/**
* Get billingAddress
*
* @return billingAddress
**/
public Address getBillingAddress() {
return billingAddress;
}
public void setBillingAddress(Address billingAddress) {
this.billingAddress = billingAddress;
}
public PaymentsRequest captureDelayHours(Integer captureDelayHours) {
this.captureDelayHours = captureDelayHours;
return this;
}
/**
* The delay between the authorisation and scheduled auto-capture, specified in hours.
*
* @return captureDelayHours
**/
public Integer getCaptureDelayHours() {
return captureDelayHours;
}
public void setCaptureDelayHours(Integer captureDelayHours) {
this.captureDelayHours = captureDelayHours;
}
public PaymentsRequest channel(ChannelEnum channel) {
this.channel = channel;
return this;
}
/**
* 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
*
* @return channel
**/
public ChannelEnum getChannel() {
return channel;
}
public void setChannel(ChannelEnum channel) {
this.channel = channel;
}
public PaymentsRequest company(Company company) {
this.company = company;
return this;
}
/**
* Get company
*
* @return company
**/
public Company getCompany() {
return company;
}
public void setCompany(Company company) {
this.company = company;
}
public PaymentsRequest countryCode(String countryCode) {
this.countryCode = countryCode;
return this;
}
/**
* The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
*
* @return countryCode
**/
public String getCountryCode() {
return countryCode;
}
public void setCountryCode(String countryCode) {
this.countryCode = countryCode;
}
public PaymentsRequest dateOfBirth(Date dateOfBirth) {
this.dateOfBirth = dateOfBirth;
return this;
}
/**
* The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
*
* @return dateOfBirth
**/
public Date getDateOfBirth() {
return dateOfBirth;
}
public void setDateOfBirth(Date dateOfBirth) {
this.dateOfBirth = dateOfBirth;
}
public PaymentsRequest dccQuote(ForexQuote dccQuote) {
this.dccQuote = dccQuote;
return this;
}
/**
* Get dccQuote
*
* @return dccQuote
**/
public ForexQuote getDccQuote() {
return dccQuote;
}
public void setDccQuote(ForexQuote dccQuote) {
this.dccQuote = dccQuote;
}
public PaymentsRequest deliveryAddress(Address deliveryAddress) {
this.deliveryAddress = deliveryAddress;
return this;
}
/**
* Get deliveryAddress
*
* @return deliveryAddress
**/
public Address getDeliveryAddress() {
return deliveryAddress;
}
public void setDeliveryAddress(Address deliveryAddress) {
this.deliveryAddress = deliveryAddress;
}
public PaymentsRequest deliveryDate(Date deliveryDate) {
this.deliveryDate = deliveryDate;
return this;
}
/**
* The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
*
* @return deliveryDate
**/
public Date getDeliveryDate() {
return deliveryDate;
}
public void setDeliveryDate(Date deliveryDate) {
this.deliveryDate = deliveryDate;
}
public PaymentsRequest enableOneClick(Boolean enableOneClick) {
this.enableOneClick = enableOneClick;
return this;
}
/**
* When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
*
* @return enableOneClick
**/
public Boolean isEnableOneClick() {
return enableOneClick;
}
public void setEnableOneClick(Boolean enableOneClick) {
this.enableOneClick = enableOneClick;
}
public PaymentsRequest enablePayOut(Boolean enablePayOut) {
this.enablePayOut = enablePayOut;
return this;
}
/**
* When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
*
* @return enablePayOut
**/
public Boolean isEnablePayOut() {
return enablePayOut;
}
public void setEnablePayOut(Boolean enablePayOut) {
this.enablePayOut = enablePayOut;
}
public PaymentsRequest enableRecurring(Boolean enableRecurring) {
this.enableRecurring = enableRecurring;
return this;
}
/**
* When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
*
* @return enableRecurring
**/
public Boolean isEnableRecurring() {
return enableRecurring;
}
public void setEnableRecurring(Boolean enableRecurring) {
this.enableRecurring = enableRecurring;
}
public PaymentsRequest entityType(EntityTypeEnum entityType) {
this.entityType = entityType;
return this;
}
/**
* The type of the entity the payment is processed for.
*
* @return entityType
**/
public EntityTypeEnum getEntityType() {
return entityType;
}
public void setEntityType(EntityTypeEnum entityType) {
this.entityType = entityType;
}
public PaymentsRequest fraudOffset(Integer fraudOffset) {
this.fraudOffset = fraudOffset;
return this;
}
/**
* An integer value that is added to the normal fraud score. The value can be either positive or negative.
*
* @return fraudOffset
**/
public Integer getFraudOffset() {
return fraudOffset;
}
public void setFraudOffset(Integer fraudOffset) {
this.fraudOffset = fraudOffset;
}
public PaymentsRequest installments(Installments installments) {
this.installments = installments;
return this;
}
/**
* Get installments
*
* @return installments
**/
public Installments getInstallments() {
return installments;
}
public void setInstallments(Installments installments) {
this.installments = installments;
}
public PaymentsRequest lineItems(List lineItems) {
this.lineItems = lineItems;
return this;
}
public PaymentsRequest addLineItemsItem(LineItem lineItemsItem) {
if (lineItems == null) {
lineItems = new ArrayList<>();
}
lineItems.add(lineItemsItem);
return this;
}
/**
* Line items regarding the payment.
*
* @return lineItems
**/
public List getLineItems() {
return lineItems;
}
public void setLineItems(List lineItems) {
this.lineItems = lineItems;
}
public PaymentsRequest mcc(String mcc) {
this.mcc = mcc;
return this;
}
/**
* 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.
*
* @return mcc
**/
public String getMcc() {
return mcc;
}
public void setMcc(String mcc) {
this.mcc = mcc;
}
public PaymentsRequest merchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
return this;
}
/**
* The merchant account identifier, with which you want to process the transaction.
*
* @return merchantAccount
**/
public String getMerchantAccount() {
return merchantAccount;
}
public void setMerchantAccount(String merchantAccount) {
this.merchantAccount = merchantAccount;
}
public PaymentsRequest merchantOrderReference(String merchantOrderReference) {
this.merchantOrderReference = merchantOrderReference;
return this;
}
/**
* This reference allows linking multiple transactions to each other. > When providing the `merchantOrderReference` value, we also recommend you submit
* `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values.
*
* @return merchantOrderReference
**/
public String getMerchantOrderReference() {
return merchantOrderReference;
}
public void setMerchantOrderReference(String merchantOrderReference) {
this.merchantOrderReference = merchantOrderReference;
}
public PaymentsRequest metadata(Map metadata) {
this.metadata = metadata;
return this;
}
public PaymentsRequest putMetadataItem(String key, String metadataItem) {
if (metadata == null) {
metadata = new HashMap<>();
}
metadata.put(key, metadataItem);
return this;
}
/**
* Metadata consists of entries, each of which includes a key and a value. Limitations: Error \"177\", \"Metadata size exceeds limit\"
*
* @return metadata
**/
public Map getMetadata() {
return metadata;
}
public void setMetadata(Map metadata) {
this.metadata = metadata;
}
public PaymentsRequest orderReference(String orderReference) {
this.orderReference = orderReference;
return this;
}
/**
* The order reference to link multiple partial payments.
*
* @return orderReference
**/
public String getOrderReference() {
return orderReference;
}
public void setOrderReference(String orderReference) {
this.orderReference = orderReference;
}
public PaymentMethodDetails getPaymentMethod() {
return paymentMethod;
}
public void setPaymentMethod(PaymentMethodDetails paymentMethod) {
this.paymentMethod = paymentMethod;
}
public PaymentsRequest paymentMethod(PaymentMethodDetails paymentMethod) {
this.paymentMethod = paymentMethod;
return this;
}
public String getStore() {
return store;
}
public void setStore(String store) {
this.store = store;
}
public PaymentsRequest store(String store) {
this.store = store;
return this;
}
public PaymentsRequest addEncryptedCardData(String encryptedCardNumber, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode, String holderName) {
return addEncryptedCardData(encryptedCardNumber, encryptedExpiryMonth, encryptedExpiryYear, encryptedSecurityCode, holderName, null);
}
public PaymentsRequest addEncryptedCardData(String encryptedCardNumber, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode, String holderName, Boolean storeDetails) {
DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.type(TYPE_SCHEME).encryptedCardNumber(encryptedCardNumber).encryptedExpiryMonth(encryptedExpiryMonth).encryptedExpiryYear(encryptedExpiryYear);
if (encryptedSecurityCode != null) {
paymentMethodDetails.setEncryptedSecurityCode(encryptedSecurityCode);
}
if (holderName != null) {
paymentMethodDetails.setHolderName(holderName);
}
if (storeDetails != null) {
paymentMethodDetails.setStoreDetails(storeDetails);
}
paymentMethod = paymentMethodDetails;
return this;
}
/**
* Add raw card data into the payment request. You need to be PCI compliant!
*
* @param cardNumber card number
* @param expiryMonth expiry month
* @param expiryYear expiry year
* @param holderName holder name
* @param securityCode security code
* @return paymentMethod payment method
*/
public PaymentsRequest addCardData(String cardNumber, String expiryMonth, String expiryYear, String securityCode, String holderName) {
return addCardData(cardNumber, expiryMonth, expiryYear, securityCode, holderName, null);
}
public PaymentsRequest addCardData(String cardNumber, String expiryMonth, String expiryYear, String securityCode, String holderName, Boolean storeDetails) {
DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.type(TYPE_SCHEME).number(cardNumber).expiryMonth(expiryMonth).expiryYear(expiryYear);
if (securityCode != null) {
paymentMethodDetails.setCvc(securityCode);
}
if (holderName != null) {
paymentMethodDetails.setHolderName(holderName);
}
if (storeDetails != null) {
paymentMethodDetails.setStoreDetails(storeDetails);
}
paymentMethod = paymentMethodDetails;
return this;
}
public PaymentsRequest addOneClickData(String recurringDetailReference, String encryptedSecurityCode) {
DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.type(TYPE_SCHEME).setStoredPaymentMethodId(recurringDetailReference);
paymentMethodDetails.type(TYPE_SCHEME).encryptedSecurityCode(encryptedSecurityCode);
paymentMethod = paymentMethodDetails;
return this;
}
public PaymentsRequest reference(String reference) {
this.reference = reference;
return this;
}
/**
* The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a
* requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
*
* @return reference
**/
public String getReference() {
return reference;
}
public void setReference(String reference) {
this.reference = reference;
}
public PaymentsRequest returnUrl(String returnUrl) {
this.returnUrl = returnUrl;
return this;
}
/**
* The URL to return to.
*
* @return returnUrl
**/
public String getReturnUrl() {
return returnUrl;
}
public void setReturnUrl(String returnUrl) {
this.returnUrl = returnUrl;
}
public PaymentsRequest sessionValidity(String sessionValidity) {
this.sessionValidity = sessionValidity;
return this;
}
/**
* The maximum validity of the session.
*
* @return sessionValidity
**/
public String getSessionValidity() {
return sessionValidity;
}
public void setSessionValidity(String sessionValidity) {
this.sessionValidity = sessionValidity;
}
public PaymentsRequest shopperEmail(String shopperEmail) {
this.shopperEmail = shopperEmail;
return this;
}
/**
* The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.
*
* @return shopperEmail
**/
public String getShopperEmail() {
return shopperEmail;
}
public void setShopperEmail(String shopperEmail) {
this.shopperEmail = shopperEmail;
}
public PaymentsRequest shopperIP(String shopperIP) {
this.shopperIP = shopperIP;
return this;
}
/**
* The shopper's IP address. 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). > This
* field is mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).
*
* @return shopperIP
**/
public String getShopperIP() {
return shopperIP;
}
public void setShopperIP(String shopperIP) {
this.shopperIP = shopperIP;
}
public PaymentsRequest shopperInteraction(ShopperInteractionEnum shopperInteraction) {
this.shopperInteraction = shopperInteraction;
return this;
}
/**
* 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.
*
* @return shopperInteraction
**/
public ShopperInteractionEnum getShopperInteraction() {
return shopperInteraction;
}
public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) {
this.shopperInteraction = shopperInteraction;
}
public PaymentsRequest shopperLocale(String shopperLocale) {
this.shopperLocale = shopperLocale;
return this;
}
/**
* The combination of a language code and a country code to specify the language to be used in the payment.
*
* @return shopperLocale
**/
public String getShopperLocale() {
return shopperLocale;
}
public void setShopperLocale(String shopperLocale) {
this.shopperLocale = shopperLocale;
}
public PaymentsRequest shopperName(Name shopperName) {
this.shopperName = shopperName;
return this;
}
/**
* Get shopperName
*
* @return shopperName
**/
public Name getShopperName() {
return shopperName;
}
public void setShopperName(Name shopperName) {
this.shopperName = shopperName;
}
public PaymentsRequest shopperReference(String shopperReference) {
this.shopperReference = shopperReference;
return this;
}
/**
* The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
*
* @return shopperReference
**/
public String getShopperReference() {
return shopperReference;
}
public void setShopperReference(String shopperReference) {
this.shopperReference = shopperReference;
}
public PaymentsRequest shopperStatement(String shopperStatement) {
this.shopperStatement = shopperStatement;
return this;
}
/**
* The text to appear on the shopper's bank statement.
*
* @return shopperStatement
**/
public String getShopperStatement() {
return shopperStatement;
}
public void setShopperStatement(String shopperStatement) {
this.shopperStatement = shopperStatement;
}
public PaymentsRequest socialSecurityNumber(String socialSecurityNumber) {
this.socialSecurityNumber = socialSecurityNumber;
return this;
}
/**
* The shopper's social security number.
*
* @return socialSecurityNumber
**/
public String getSocialSecurityNumber() {
return socialSecurityNumber;
}
public void setSocialSecurityNumber(String socialSecurityNumber) {
this.socialSecurityNumber = socialSecurityNumber;
}
public PaymentsRequest telephoneNumber(String telephoneNumber) {
this.telephoneNumber = telephoneNumber;
return this;
}
/**
* The shopper's telephone number.
*
* @return telephoneNumber
**/
public String getTelephoneNumber() {
return telephoneNumber;
}
public void setTelephoneNumber(String telephoneNumber) {
this.telephoneNumber = telephoneNumber;
}
public BrowserInfo getBrowserInfo() {
return browserInfo;
}
public void setBrowserInfo(BrowserInfo browserInfo) {
this.browserInfo = browserInfo;
}
public PaymentsRequest browserInfo(BrowserInfo browserInfo) {
this.browserInfo = browserInfo;
return this;
}
public PaymentsRequest addBrowserInfoData(String userAgent, String acceptHeader) {
BrowserInfo browserInfo = new BrowserInfo();
browserInfo.setAcceptHeader(acceptHeader);
browserInfo.setUserAgent(userAgent);
setBrowserInfo(browserInfo);
return this;
}
public String getDeviceFingerprint() {
return deviceFingerprint;
}
public void setDeviceFingerprint(String deviceFingerprint) {
this.deviceFingerprint = deviceFingerprint;
}
public PaymentsRequest deviceFingerprint(String deviceFingerprint) {
this.deviceFingerprint = deviceFingerprint;
return this;
}
public ApplicationInfo getApplicationInfo() {
return applicationInfo;
}
public void setApplicationInfo(ApplicationInfo applicationInfo) {
this.applicationInfo = applicationInfo;
}
public PaymentsRequest applicationInfo(ApplicationInfo applicationInfo) {
this.applicationInfo = applicationInfo;
return this;
}
public String getOrigin() {
return origin;
}
public void setOrigin(String origin) {
this.origin = origin;
}
public PaymentsRequest origin(String origin) {
this.origin = origin;
return this;
}
/**
* Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa).
*
* @return the mpi data
*/
public ThreeDSecureData getMpiData() {
return mpiData;
}
public void setMpiData(ThreeDSecureData mpiData) {
this.mpiData = mpiData;
}
public PaymentsRequest mpiData(ThreeDSecureData mpiData) {
this.mpiData = mpiData;
return this;
}
/**
* Specifies the redirect method (GET or POST) when redirecting back from the issuer.
*
* @return the redirect from issuer method
*/
public String getRedirectFromIssuerMethod() {
return redirectFromIssuerMethod;
}
public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod) {
this.redirectFromIssuerMethod = redirectFromIssuerMethod;
}
public PaymentsRequest redirectFromIssuerMethod(String redirectFromIssuerMethod) {
this.redirectFromIssuerMethod = redirectFromIssuerMethod;
return this;
}
/**
* Specifies the redirect method (GET or POST) when redirecting to the issuer.
*
* @return the redirect to issuer method
*/
public String getRedirectToIssuerMethod() {
return redirectToIssuerMethod;
}
public void setRedirectToIssuerMethod(String redirectToIssuerMethod) {
this.redirectToIssuerMethod = redirectToIssuerMethod;
}
public PaymentsRequest redirectToIssuerMethod(String redirectToIssuerMethod) {
this.redirectToIssuerMethod = redirectToIssuerMethod;
return this;
}
/**
* Contains the order information which is required for partial payments.
*
* @return order
*/
public CheckoutOrder getOrder() {
return order;
}
public void setOrder(CheckoutOrder order) {
this.order = order;
}
public PaymentsRequest order(CheckoutOrder order) {
this.order = order;
return this;
}
/**
* When true and shopperReference is provided, the payment details will be stored.
*
* @return storePaymentMethod
*/
public Boolean getStorePaymentMethod() {
return storePaymentMethod;
}
public void setStorePaymentMethod(Boolean storePaymentMethod) {
this.storePaymentMethod = storePaymentMethod;
}
public PaymentsRequest storePaymentMethod(Boolean storePaymentMethod) {
this.storePaymentMethod = storePaymentMethod;
return this;
}
public PaymentsRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) {
this.threeDSAuthenticationOnly = threeDSAuthenticationOnly;
return this;
}
/**
* 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.
*
* @return threeDSAuthenticationOnly
**/
public Boolean isThreeDSAuthenticationOnly() {
return threeDSAuthenticationOnly;
}
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) {
this.threeDSAuthenticationOnly = threeDSAuthenticationOnly;
}
public PaymentsRequest riskData(RiskData riskData) {
this.riskData = riskData;
return this;
}
/**
* Get riskData
*
* @return riskData
**/
public RiskData getRiskData() {
return riskData;
}
public void setRiskData(RiskData riskData) {
this.riskData = riskData;
}
public PaymentsRequest conversionId(String conversionId) {
this.conversionId = conversionId;
return this;
}
/**
* Conversion ID that corresponds to the Id generated for tracking user payment journey.
*
* @return conversionId
**/
public String getConversionId() {
return conversionId;
}
public void setConversionId(String conversionId) {
this.conversionId = conversionId;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PaymentsRequest paymentsRequest = (PaymentsRequest) o;
return Objects.equals(this.accountInfo, paymentsRequest.accountInfo) &&
Objects.equals(this.additionalData, paymentsRequest.additionalData) &&
Objects.equals(this.amount, paymentsRequest.amount) &&
Objects.equals(this.applicationInfo, paymentsRequest.applicationInfo) &&
Objects.equals(this.billingAddress, paymentsRequest.billingAddress) &&
Objects.equals(this.browserInfo, paymentsRequest.browserInfo) &&
Objects.equals(this.captureDelayHours, paymentsRequest.captureDelayHours) &&
Objects.equals(this.channel, paymentsRequest.channel) &&
Objects.equals(this.company, paymentsRequest.company) &&
Objects.equals(this.conversionId, paymentsRequest.conversionId) &&
Objects.equals(this.countryCode, paymentsRequest.countryCode) &&
Objects.equals(this.dateOfBirth, paymentsRequest.dateOfBirth) &&
Objects.equals(this.dccQuote, paymentsRequest.dccQuote) &&
Objects.equals(this.deliveryAddress, paymentsRequest.deliveryAddress) &&
Objects.equals(this.deliveryDate, paymentsRequest.deliveryDate) &&
Objects.equals(this.deviceFingerprint, paymentsRequest.deviceFingerprint) &&
Objects.equals(this.enableOneClick, paymentsRequest.enableOneClick) &&
Objects.equals(this.enablePayOut, paymentsRequest.enablePayOut) &&
Objects.equals(this.enableRecurring, paymentsRequest.enableRecurring) &&
Objects.equals(this.entityType, paymentsRequest.entityType) &&
Objects.equals(this.fraudOffset, paymentsRequest.fraudOffset) &&
Objects.equals(this.installments, paymentsRequest.installments) &&
Objects.equals(this.lineItems, paymentsRequest.lineItems) &&
Objects.equals(this.mcc, paymentsRequest.mcc) &&
Objects.equals(this.merchantAccount, paymentsRequest.merchantAccount) &&
Objects.equals(this.merchantOrderReference, paymentsRequest.merchantOrderReference) &&
Objects.equals(this.merchantRiskIndicator, paymentsRequest.merchantRiskIndicator) &&
Objects.equals(this.metadata, paymentsRequest.metadata) &&
Objects.equals(this.mpiData, paymentsRequest.mpiData) &&
Objects.equals(this.order, paymentsRequest.order) &&
Objects.equals(this.orderReference, paymentsRequest.orderReference) &&
Objects.equals(this.origin, paymentsRequest.origin) &&
Objects.equals(this.paymentMethod, paymentsRequest.paymentMethod) &&
Objects.equals(this.recurringExpiry, paymentsRequest.recurringExpiry) &&
Objects.equals(this.recurringFrequency, paymentsRequest.recurringFrequency) &&
Objects.equals(this.recurringProcessingModel, paymentsRequest.recurringProcessingModel) &&
Objects.equals(this.redirectFromIssuerMethod, paymentsRequest.redirectFromIssuerMethod) &&
Objects.equals(this.redirectToIssuerMethod, paymentsRequest.redirectToIssuerMethod) &&
Objects.equals(this.reference, paymentsRequest.reference) &&
Objects.equals(this.returnUrl, paymentsRequest.returnUrl) &&
Objects.equals(this.riskData, paymentsRequest.riskData) &&
Objects.equals(this.sessionValidity, paymentsRequest.sessionValidity) &&
Objects.equals(this.shopperEmail, paymentsRequest.shopperEmail) &&
Objects.equals(this.shopperIP, paymentsRequest.shopperIP) &&
Objects.equals(this.shopperInteraction, paymentsRequest.shopperInteraction) &&
Objects.equals(this.shopperLocale, paymentsRequest.shopperLocale) &&
Objects.equals(this.shopperName, paymentsRequest.shopperName) &&
Objects.equals(this.shopperReference, paymentsRequest.shopperReference) &&
Objects.equals(this.shopperStatement, paymentsRequest.shopperStatement) &&
Objects.equals(this.socialSecurityNumber, paymentsRequest.socialSecurityNumber) &&
Objects.equals(this.splits, paymentsRequest.splits) &&
Objects.equals(this.store, paymentsRequest.store) &&
Objects.equals(this.storePaymentMethod, paymentsRequest.storePaymentMethod) &&
Objects.equals(this.telephoneNumber, paymentsRequest.telephoneNumber) &&
Objects.equals(this.threeDS2RequestData, paymentsRequest.threeDS2RequestData) &&
Objects.equals(this.threeDSAuthenticationOnly, paymentsRequest.threeDSAuthenticationOnly) &&
Objects.equals(this.trustedShopper, paymentsRequest.trustedShopper);
}
@Override
public int hashCode() {
return Objects.hash(accountInfo, additionalData, amount, applicationInfo, billingAddress, browserInfo,
captureDelayHours, channel, company, conversionId, countryCode, dateOfBirth, dccQuote, deliveryAddress,
deliveryDate, deviceFingerprint, enableOneClick, enablePayOut, enableRecurring, entityType, fraudOffset,
installments, lineItems, mcc, merchantAccount, merchantOrderReference, merchantRiskIndicator, metadata,
mpiData, order, orderReference, origin, paymentMethod, recurringExpiry, recurringFrequency,
recurringProcessingModel, redirectFromIssuerMethod, redirectToIssuerMethod, reference, returnUrl,
riskData, sessionValidity, shopperEmail, shopperIP, shopperInteraction, shopperLocale, shopperName,
shopperReference, shopperStatement, socialSecurityNumber, splits, store, storePaymentMethod,
telephoneNumber, threeDS2RequestData, threeDSAuthenticationOnly, trustedShopper);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PaymentsRequest {\n");
sb.append(" accountInfo: ").append(toIndentedString(accountInfo)).append("\n");
sb.append(" additionalData: ").append(toIndentedString(additionalData)).append("\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" applicationInfo: ").append(toIndentedString(applicationInfo)).append("\n");
sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n");
sb.append(" browserInfo: ").append(toIndentedString(browserInfo)).append("\n");
sb.append(" captureDelayHours: ").append(toIndentedString(captureDelayHours)).append("\n");
sb.append(" channel: ").append(toIndentedString(channel)).append("\n");
sb.append(" company: ").append(toIndentedString(company)).append("\n");
sb.append(" conversionId: ").append(toIndentedString(conversionId)).append("\n");
sb.append(" countryCode: ").append(toIndentedString(countryCode)).append("\n");
sb.append(" dateOfBirth: ").append(toIndentedString(dateOfBirth)).append("\n");
sb.append(" dccQuote: ").append(toIndentedString(dccQuote)).append("\n");
sb.append(" deliveryAddress: ").append(toIndentedString(deliveryAddress)).append("\n");
sb.append(" deliveryDate: ").append(toIndentedString(deliveryDate)).append("\n");
sb.append(" deviceFingerprint: ").append(toIndentedString(deviceFingerprint)).append("\n");
sb.append(" enableOneClick: ").append(toIndentedString(enableOneClick)).append("\n");
sb.append(" enablePayOut: ").append(toIndentedString(enablePayOut)).append("\n");
sb.append(" enableRecurring: ").append(toIndentedString(enableRecurring)).append("\n");
sb.append(" entityType: ").append(toIndentedString(entityType)).append("\n");
sb.append(" fraudOffset: ").append(toIndentedString(fraudOffset)).append("\n");
sb.append(" installments: ").append(toIndentedString(installments)).append("\n");
sb.append(" lineItems: ").append(toIndentedString(lineItems)).append("\n");
sb.append(" mcc: ").append(toIndentedString(mcc)).append("\n");
sb.append(" merchantAccount: ").append(toIndentedString(merchantAccount)).append("\n");
sb.append(" merchantOrderReference: ").append(toIndentedString(merchantOrderReference)).append("\n");
sb.append(" merchantRiskIndicator: ").append(toIndentedString(merchantRiskIndicator)).append("\n");
sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n");
sb.append(" mpiData: ").append(toIndentedString(mpiData)).append("\n");
sb.append(" order: ").append(toIndentedString(order)).append("\n");
sb.append(" orderReference: ").append(toIndentedString(orderReference)).append("\n");
sb.append(" origin: ").append(toIndentedString(origin)).append("\n");
sb.append(" paymentMethod: ").append(toIndentedString(paymentMethod)).append("\n");
sb.append(" recurringExpiry: ").append(toIndentedString(recurringExpiry)).append("\n");
sb.append(" recurringFrequency: ").append(toIndentedString(recurringFrequency)).append("\n");
sb.append(" recurringProcessingModel: ").append(toIndentedString(recurringProcessingModel)).append("\n");
sb.append(" redirectFromIssuerMethod: ").append(toIndentedString(redirectFromIssuerMethod)).append("\n");
sb.append(" redirectToIssuerMethod: ").append(toIndentedString(redirectToIssuerMethod)).append("\n");
sb.append(" reference: ").append(toIndentedString(reference)).append("\n");
sb.append(" returnUrl: ").append(toIndentedString(returnUrl)).append("\n");
sb.append(" riskData: ").append(toIndentedString(riskData)).append("\n");
sb.append(" sessionValidity: ").append(toIndentedString(sessionValidity)).append("\n");
sb.append(" shopperEmail: ").append(toIndentedString(shopperEmail)).append("\n");
sb.append(" shopperIP: ").append(toIndentedString(shopperIP)).append("\n");
sb.append(" shopperInteraction: ").append(toIndentedString(shopperInteraction)).append("\n");
sb.append(" shopperLocale: ").append(toIndentedString(shopperLocale)).append("\n");
sb.append(" shopperName: ").append(toIndentedString(shopperName)).append("\n");
sb.append(" shopperReference: ").append(toIndentedString(shopperReference)).append("\n");
sb.append(" shopperStatement: ").append(toIndentedString(shopperStatement)).append("\n");
sb.append(" socialSecurityNumber: ").append(toIndentedString(socialSecurityNumber)).append("\n");
sb.append(" splits: ").append(toIndentedString(splits)).append("\n");
sb.append(" store: ").append(toIndentedString(store)).append("\n");
sb.append(" storePaymentMethod: ").append(toIndentedString(storePaymentMethod)).append("\n");
sb.append(" telephoneNumber: ").append(toIndentedString(telephoneNumber)).append("\n");
sb.append(" threeDS2RequestData: ").append(toIndentedString(threeDS2RequestData)).append("\n");
sb.append(" threeDSAuthenticationOnly: ").append(toIndentedString(threeDSAuthenticationOnly)).append("\n");
sb.append(" trustedShopper: ").append(toIndentedString(trustedShopper)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* 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
*/
@JsonAdapter(ChannelEnum.Adapter.class)
public enum ChannelEnum {
IOS("iOS"),
ANDROID("Android"),
WEB("Web");
@JsonValue
private final String value;
ChannelEnum(String value) {
this.value = value;
}
public static ChannelEnum fromValue(String text) {
return Arrays.stream(values()).
filter(s -> s.value.equals(text)).
findFirst().orElse(null);
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static class Adapter extends TypeAdapter {
@Override
public void write(JsonWriter jsonWriter, ChannelEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ChannelEnum read(JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ChannelEnum.fromValue(String.valueOf(value));
}
}
}
/**
* The type of the entity the payment is processed for.
*/
@JsonAdapter(EntityTypeEnum.Adapter.class)
public enum EntityTypeEnum {
NATURALPERSON("NaturalPerson"),
COMPANYNAME("CompanyName");
@JsonValue
private final String value;
EntityTypeEnum(String value) {
this.value = value;
}
public static EntityTypeEnum fromValue(String text) {
return Arrays.stream(values()).
filter(s -> s.value.equals(text)).
findFirst().orElse(null);
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static class Adapter extends TypeAdapter {
@Override
public void write(JsonWriter jsonWriter, EntityTypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public EntityTypeEnum read(JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return EntityTypeEnum.fromValue(String.valueOf(value));
}
}
}
/**
* how the shopper interacts with the system
*/
public enum RecurringProcessingModelEnum {
/**
* A transaction for a fixed or variable amount, which follows a fixed schedule. This is the default value.
*/
@SerializedName("Subscription") SUBSCRIPTION("Subscription"),
/**
* 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 as a card-on-file transaction.
*/
@SerializedName("CardOnFile") CARD_ON_FILE("CardOnFile"),
/**
* 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.
*/
@SerializedName("UnscheduledCardOnFile") UNSCHEDULED_CARD_ON_FILE("UnscheduledCardOnFile");
@JsonValue
private final String value;
RecurringProcessingModelEnum(String value) {
this.value = value;
}
@Override
public String toString() {
return String.valueOf(value);
}
}
/**
* 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.
*/
@JsonAdapter(ShopperInteractionEnum.Adapter.class)
public enum ShopperInteractionEnum {
ECOMMERCE("Ecommerce"),
CONTAUTH("ContAuth"),
MOTO("Moto"),
POS("POS");
@JsonValue
private final String value;
ShopperInteractionEnum(String value) {
this.value = value;
}
public static ShopperInteractionEnum fromValue(String text) {
return Arrays.stream(values()).
filter(s -> s.value.equals(text)).
findFirst().orElse(null);
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static class Adapter extends TypeAdapter {
@Override
public void write(JsonWriter jsonWriter, ShopperInteractionEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ShopperInteractionEnum read(JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ShopperInteractionEnum.fromValue(String.valueOf(value));
}
}
}
}