CostEstimateRequest (Adyen Java API Library 17.3.0 API)

java.lang.Object
- com.adyen.model.binlookup.CostEstimateRequest

public class CostEstimateRequest
extends Object

CostEstimateRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CostEstimateRequest.ShopperInteractionEnum` Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

Constructor Summary

Constructors
Constructor and Description

CostEstimateRequest()

Constructors
Constructor and Description
`CostEstimateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CostEstimateRequest`	`amount(Amount amount)`
`CostEstimateRequest`	`assumptions(CostEstimateAssumptions assumptions)`
`CostEstimateRequest`	`cardNumber(String cardNumber)`
`CostEstimateRequest`	`encryptedCard(String encryptedCard)`
`boolean`	`equals(Object o)`
`Amount`	`getAmount()` Get amount
`CostEstimateAssumptions`	`getAssumptions()` Get assumptions
`String`	`getCardNumber()` The card number (4-19 characters) for PCI compliant use cases.
`String`	`getEncryptedCard()` Encrypted data that stores card information for non PCI-compliant use cases.
`String`	`getMerchantAccount()` The merchant account identifier you want to process the (transaction) request with.
`MerchantDetails`	`getMerchantDetails()` Get merchantDetails
`Recurring`	`getRecurring()` Get recurring
`String`	`getSelectedRecurringDetailReference()` The `recurringDetailReference` you want to use for this cost estimate.
`CostEstimateRequest.ShopperInteractionEnum`	`getShopperInteraction()` Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`String`	`getShopperReference()` The shopper's reference to uniquely identify this shopper (e.g.
`int`	`hashCode()`
`CostEstimateRequest`	`merchantAccount(String merchantAccount)`
`CostEstimateRequest`	`merchantDetails(MerchantDetails merchantDetails)`
`CostEstimateRequest`	`recurring(Recurring recurring)`
`CostEstimateRequest`	`selectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setAmount(Amount amount)`
`void`	`setAssumptions(CostEstimateAssumptions assumptions)`
`void`	`setCardNumber(String cardNumber)`
`void`	`setEncryptedCard(String encryptedCard)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantDetails(MerchantDetails merchantDetails)`
`void`	`setRecurring(Recurring recurring)`
`void`	`setSelectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setShopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)`
`void`	`setShopperReference(String shopperReference)`
`CostEstimateRequest`	`shopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)`
`CostEstimateRequest`	`shopperReference(String shopperReference)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CostEstimateRequest
```
public CostEstimateRequest()
```
- Method Detail
  - amount
```
public CostEstimateRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - assumptions
```
public CostEstimateRequest assumptions(CostEstimateAssumptions assumptions)
```
  - getAssumptions
```
public CostEstimateAssumptions getAssumptions()
```
    Get assumptions
    
    Returns:
    
    assumptions
  - setAssumptions
```
public void setAssumptions(CostEstimateAssumptions assumptions)
```
  - cardNumber
```
public CostEstimateRequest cardNumber(String cardNumber)
```
  - getCardNumber
```
public String getCardNumber()
```
    The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
    
    Returns:
    
    cardNumber
  - setCardNumber
```
public void setCardNumber(String cardNumber)
```
  - encryptedCard
```
public CostEstimateRequest encryptedCard(String encryptedCard)
```
  - getEncryptedCard
```
public String getEncryptedCard()
```
    Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Client-Side Encryption library and must contain at least the ` number` and `generationtime` fields. > Either the `cardNumber` or `encryptedCard` field must be provided in a payment request.
    
    Returns:
    
    encryptedCard
  - setEncryptedCard
```
public void setEncryptedCard(String encryptedCard)
```
  - merchantAccount
```
public CostEstimateRequest merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier you want to process the (transaction) request with.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
  - merchantDetails
```
public CostEstimateRequest merchantDetails(MerchantDetails merchantDetails)
```
  - getMerchantDetails
```
public MerchantDetails getMerchantDetails()
```
    Get merchantDetails
    
    Returns:
    
    merchantDetails
  - setMerchantDetails
```
public void setMerchantDetails(MerchantDetails merchantDetails)
```
  - recurring
```
public CostEstimateRequest recurring(Recurring recurring)
```
  - getRecurring
```
public Recurring getRecurring()
```
    Get recurring
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Recurring recurring)
```
  - selectedRecurringDetailReference
```
public CostEstimateRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - 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)
```
  - shopperInteraction
```
public CostEstimateRequest shopperInteraction(CostEstimateRequest.ShopperInteractionEnum shopperInteraction)
```
  - 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)
```
  - shopperReference
```
public CostEstimateRequest shopperReference(String shopperReference)
```
  - getShopperReference
```
public String getShopperReference()
```
    The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
  - 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

Class CostEstimateRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CostEstimateRequest

Method Detail

amount

getAmount

setAmount

assumptions

getAssumptions

setAssumptions

cardNumber

getCardNumber

setCardNumber

encryptedCard

getEncryptedCard

setEncryptedCard

merchantAccount

getMerchantAccount

setMerchantAccount

merchantDetails

getMerchantDetails

setMerchantDetails

recurring

getRecurring

setRecurring

selectedRecurringDetailReference

getSelectedRecurringDetailReference

setSelectedRecurringDetailReference

shopperInteraction

getShopperInteraction

setShopperInteraction

shopperReference

getShopperReference

setShopperReference

equals

hashCode

toString