Package com.adyen.model.binlookup
Class CostEstimateRequest
- java.lang.Object
-
- com.adyen.model.binlookup.CostEstimateRequest
-
public class CostEstimateRequest extends Object
CostEstimateRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCostEstimateRequest.ShopperInteractionEnumSpecifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_AMOUNTstatic StringJSON_PROPERTY_ASSUMPTIONSstatic StringJSON_PROPERTY_CARD_NUMBERstatic StringJSON_PROPERTY_ENCRYPTED_CARD_NUMBERstatic StringJSON_PROPERTY_MERCHANT_ACCOUNTstatic StringJSON_PROPERTY_MERCHANT_DETAILSstatic StringJSON_PROPERTY_RECURRINGstatic StringJSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCEstatic StringJSON_PROPERTY_SHOPPER_INTERACTIONstatic StringJSON_PROPERTY_SHOPPER_REFERENCE
-
Constructor Summary
Constructors Constructor Description CostEstimateRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CostEstimateRequestamount(Amount amount)amountCostEstimateRequestassumptions(CostEstimateAssumptions assumptions)assumptionsCostEstimateRequestcardNumber(String cardNumber)The card number (4-19 characters) for PCI compliant use cases.CostEstimateRequestencryptedCardNumber(String encryptedCardNumber)Encrypted data that stores card information for non PCI-compliant use cases.booleanequals(Object o)Return true if this CostEstimateRequest object is equal to o.static CostEstimateRequestfromJson(String jsonString)Create an instance of CostEstimateRequest given an JSON stringAmountgetAmount()amountCostEstimateAssumptionsgetAssumptions()assumptionsStringgetCardNumber()The card number (4-19 characters) for PCI compliant use cases.StringgetEncryptedCardNumber()Encrypted data that stores card information for non PCI-compliant use cases.StringgetMerchantAccount()The merchant account identifier you want to process the (transaction) request with.MerchantDetailsgetMerchantDetails()merchantDetailsRecurringgetRecurring()recurringStringgetSelectedRecurringDetailReference()The `recurringDetailReference` you want to use for this cost estimate.CostEstimateRequest.ShopperInteractionEnumgetShopperInteraction()Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.StringgetShopperReference()Required for recurring payments.inthashCode()CostEstimateRequestmerchantAccount(String merchantAccount)The merchant account identifier you want to process the (transaction) request with.CostEstimateRequestmerchantDetails(MerchantDetails merchantDetails)merchantDetailsCostEstimateRequestrecurring(Recurring recurring)recurringCostEstimateRequestselectedRecurringDetailReference(String selectedRecurringDetailReference)The `recurringDetailReference` you want to use for this cost estimate.voidsetAmount(Amount amount)amountvoidsetAssumptions(CostEstimateAssumptions assumptions)assumptionsvoidsetCardNumber(String cardNumber)The card number (4-19 characters) for PCI compliant use cases.voidsetEncryptedCardNumber(String encryptedCardNumber)Encrypted data that stores card information for non PCI-compliant use cases.voidsetMerchantAccount(String merchantAccount)The merchant account identifier you want to process the (transaction) request with.voidsetMerchantDetails(MerchantDetails merchantDetails)merchantDetailsvoidsetRecurring(Recurring recurring)recurringvoidsetSelectedRecurringDetailReference(String selectedRecurringDetailReference)The `recurringDetailReference` you want to use for this cost estimate.voidsetShopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.voidsetShopperReference(String shopperReference)Required for recurring payments.CostEstimateRequestshopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.CostEstimateRequestshopperReference(String shopperReference)Required for recurring payments.StringtoJson()Convert an instance of CostEstimateRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ASSUMPTIONS
public static final String JSON_PROPERTY_ASSUMPTIONS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CARD_NUMBER
public static final String JSON_PROPERTY_CARD_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENCRYPTED_CARD_NUMBER
public static final String JSON_PROPERTY_ENCRYPTED_CARD_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_DETAILS
public static final String JSON_PROPERTY_MERCHANT_DETAILS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING
public static final String JSON_PROPERTY_RECURRING
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
public static final String JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
-
Method Detail
-
amount
public CostEstimateRequest amount(Amount amount)
amount- Parameters:
amount-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getAmount
public Amount getAmount()
amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
assumptions
public CostEstimateRequest assumptions(CostEstimateAssumptions assumptions)
assumptions- Parameters:
assumptions-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getAssumptions
public CostEstimateAssumptions getAssumptions()
assumptions- Returns:
- assumptions
-
setAssumptions
public void setAssumptions(CostEstimateAssumptions assumptions)
assumptions- Parameters:
assumptions-
-
cardNumber
public CostEstimateRequest cardNumber(String cardNumber)
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Parameters:
cardNumber-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getCardNumber
public String getCardNumber()
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Returns:
- cardNumber
-
setCardNumber
public void setCardNumber(String cardNumber)
The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Parameters:
cardNumber-
-
encryptedCardNumber
public CostEstimateRequest encryptedCardNumber(String encryptedCardNumber)
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Parameters:
encryptedCardNumber-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getEncryptedCardNumber
public String getEncryptedCardNumber()
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Returns:
- encryptedCardNumber
-
setEncryptedCardNumber
public void setEncryptedCardNumber(String encryptedCardNumber)
Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request.- Parameters:
encryptedCardNumber-
-
merchantAccount
public CostEstimateRequest merchantAccount(String merchantAccount)
The merchant account identifier you want to process the (transaction) request with.- Parameters:
merchantAccount-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier you want to process the (transaction) request with.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
The merchant account identifier you want to process the (transaction) request with.- Parameters:
merchantAccount-
-
merchantDetails
public CostEstimateRequest merchantDetails(MerchantDetails merchantDetails)
merchantDetails- Parameters:
merchantDetails-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getMerchantDetails
public MerchantDetails getMerchantDetails()
merchantDetails- Returns:
- merchantDetails
-
setMerchantDetails
public void setMerchantDetails(MerchantDetails merchantDetails)
merchantDetails- Parameters:
merchantDetails-
-
recurring
public CostEstimateRequest recurring(Recurring recurring)
recurring- Parameters:
recurring-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getRecurring
public Recurring getRecurring()
recurring- Returns:
- recurring
-
setRecurring
public void setRecurring(Recurring recurring)
recurring- Parameters:
recurring-
-
selectedRecurringDetailReference
public CostEstimateRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.- Parameters:
selectedRecurringDetailReference-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getSelectedRecurringDetailReference
public String getSelectedRecurringDetailReference()
The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.- Returns:
- selectedRecurringDetailReference
-
setSelectedRecurringDetailReference
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail.- Parameters:
selectedRecurringDetailReference-
-
shopperInteraction
public CostEstimateRequest shopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)
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 card holder 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.- Parameters:
shopperInteraction-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getShopperInteraction
public CostEstimateRequest.ShopperInteractionEnum getShopperInteraction()
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)
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 card holder 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.- Parameters:
shopperInteraction-
-
shopperReference
public CostEstimateRequest shopperReference(String shopperReference)
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.- Parameters:
shopperReference-- Returns:
- the current
CostEstimateRequestinstance, allowing for method chaining
-
getShopperReference
public String getShopperReference()
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.- Parameters:
shopperReference-
-
equals
public boolean equals(Object o)
Return true if this CostEstimateRequest object is equal to o.
-
fromJson
public static CostEstimateRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of CostEstimateRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CostEstimateRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to CostEstimateRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of CostEstimateRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-