java.lang.Object
- com.adyen.model.tapi.CardAcquisitionTransaction

public class CardAcquisitionTransaction
extends Object

CardAcquisitionTransaction

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CardAcquisitionTransaction.ForceEntryModeEnum
Gets or Sets forceEntryMode

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ALLOWED_LOYALTY_BRAND`
`static String`	`JSON_PROPERTY_ALLOWED_PAYMENT_BRAND`
`static String`	`JSON_PROPERTY_CASH_BACK_FLAG`
`static String`	`JSON_PROPERTY_CUSTOMER_LANGUAGE`
`static String`	`JSON_PROPERTY_FORCE_CUSTOMER_SELECTION_FLAG`
`static String`	`JSON_PROPERTY_FORCE_ENTRY_MODE`
`static String`	`JSON_PROPERTY_LOYALTY_HANDLING`
`static String`	`JSON_PROPERTY_PAYMENT_TYPE`
`static String`	`JSON_PROPERTY_TOTAL_AMOUNT`

Constructor Summary

Constructors
Constructor Description

CardAcquisitionTransaction()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CardAcquisitionTransaction`	`addAllowedLoyaltyBrandItem(String allowedLoyaltyBrandItem)`
`CardAcquisitionTransaction`	`addAllowedPaymentBrandItem(String allowedPaymentBrandItem)`
`CardAcquisitionTransaction`	`addForceEntryModeItem(CardAcquisitionTransaction.ForceEntryModeEnum forceEntryModeItem)`
`CardAcquisitionTransaction`	`allowedLoyaltyBrand(List<String> allowedLoyaltyBrand)`	Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
`CardAcquisitionTransaction`	`allowedPaymentBrand(List<String> allowedPaymentBrand)`	Card payment brands allowed by the Sale System for the payment transaction.
`CardAcquisitionTransaction`	`cashBackFlag(Boolean cashBackFlag)`	Cash back has been requested with the payment transaction.
`CardAcquisitionTransaction`	`customerLanguage(String customerLanguage)`	The language used on the terminal screen or in text printed by the terminal.
`boolean`	`equals(Object o)`	Return true if this CardAcquisitionTransaction object is equal to o.
`CardAcquisitionTransaction`	`forceCustomerSelectionFlag(Boolean forceCustomerSelectionFlag)`	Indicates if the Customer realises the selection of the card application.
`CardAcquisitionTransaction`	`forceEntryMode(List<CardAcquisitionTransaction.ForceEntryModeEnum> forceEntryMode)`	forceEntryMode
`static CardAcquisitionTransaction`	`fromJson(String jsonString)`	Create an instance of CardAcquisitionTransaction given an JSON string
`List<String>`	`getAllowedLoyaltyBrand()`	Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
`List<String>`	`getAllowedPaymentBrand()`	Card payment brands allowed by the Sale System for the payment transaction.
`Boolean`	`getCashBackFlag()`	Cash back has been requested with the payment transaction.
`String`	`getCustomerLanguage()`	The language used on the terminal screen or in text printed by the terminal.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`Boolean`	`getForceCustomerSelectionFlag()`	Indicates if the Customer realises the selection of the card application.
`List<CardAcquisitionTransaction.ForceEntryModeEnum>`	`getForceEntryMode()`	Get forceEntryMode
`LoyaltyHandling`	`getLoyaltyHandling()`	Get loyaltyHandling
`PaymentType`	`getPaymentType()`	Get paymentType
`BigDecimal`	`getTotalAmount()`	Amount of a transaction.
`int`	`hashCode()`
`CardAcquisitionTransaction`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`CardAcquisitionTransaction`	`loyaltyHandling(LoyaltyHandling loyaltyHandling)`	loyaltyHandling
`CardAcquisitionTransaction`	`paymentType(PaymentType paymentType)`	paymentType
`void`	`setAllowedLoyaltyBrand(List<String> allowedLoyaltyBrand)`	Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
`void`	`setAllowedPaymentBrand(List<String> allowedPaymentBrand)`	Card payment brands allowed by the Sale System for the payment transaction.
`void`	`setCashBackFlag(Boolean cashBackFlag)`	Cash back has been requested with the payment transaction.
`void`	`setCustomerLanguage(String customerLanguage)`	The language used on the terminal screen or in text printed by the terminal.
`void`	`setForceCustomerSelectionFlag(Boolean forceCustomerSelectionFlag)`	Indicates if the Customer realises the selection of the card application.
`void`	`setForceEntryMode(List<CardAcquisitionTransaction.ForceEntryModeEnum> forceEntryMode)`	forceEntryMode
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setLoyaltyHandling(LoyaltyHandling loyaltyHandling)`	loyaltyHandling
`void`	`setPaymentType(PaymentType paymentType)`	paymentType
`void`	`setTotalAmount(BigDecimal totalAmount)`	Amount of a transaction.
`String`	`toJson()`	Convert an instance of CardAcquisitionTransaction to an JSON string
`String`	`toString()`
`CardAcquisitionTransaction`	`totalAmount(BigDecimal totalAmount)`	Amount of a transaction.

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

- Field Detail
  - JSON_PROPERTY_ALLOWED_PAYMENT_BRAND
```
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_BRAND
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ALLOWED_LOYALTY_BRAND
```
public static final String JSON_PROPERTY_ALLOWED_LOYALTY_BRAND
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LOYALTY_HANDLING
```
public static final String JSON_PROPERTY_LOYALTY_HANDLING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CUSTOMER_LANGUAGE
```
public static final String JSON_PROPERTY_CUSTOMER_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FORCE_ENTRY_MODE
```
public static final String JSON_PROPERTY_FORCE_ENTRY_MODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FORCE_CUSTOMER_SELECTION_FLAG
```
public static final String JSON_PROPERTY_FORCE_CUSTOMER_SELECTION_FLAG
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOTAL_AMOUNT
```
public static final String JSON_PROPERTY_TOTAL_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_TYPE
```
public static final String JSON_PROPERTY_PAYMENT_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CASH_BACK_FLAG
```
public static final String JSON_PROPERTY_CASH_BACK_FLAG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CardAcquisitionTransaction
```
public CardAcquisitionTransaction()
```
- Method Detail
  - allowedPaymentBrand
```
public CardAcquisitionTransaction allowedPaymentBrand(List<String> allowedPaymentBrand)
```
    Card payment brands allowed by the Sale System for the payment transaction.
    
    Parameters:
    
    allowedPaymentBrand - Card payment brands allowed by the Sale System for the payment transaction.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - addAllowedPaymentBrandItem
```
public CardAcquisitionTransaction addAllowedPaymentBrandItem(String allowedPaymentBrandItem)
```
  - getAllowedPaymentBrand
```
public List<String> getAllowedPaymentBrand()
```
    Card payment brands allowed by the Sale System for the payment transaction.
    
    Returns:
    
    allowedPaymentBrand Card payment brands allowed by the Sale System for the payment transaction.
  - setAllowedPaymentBrand
```
public void setAllowedPaymentBrand(List<String> allowedPaymentBrand)
```
    Card payment brands allowed by the Sale System for the payment transaction.
    
    Parameters:
    
    allowedPaymentBrand - Card payment brands allowed by the Sale System for the payment transaction.
  - allowedLoyaltyBrand
```
public CardAcquisitionTransaction allowedLoyaltyBrand(List<String> allowedLoyaltyBrand)
```
    Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
    
    Parameters:
    
    allowedLoyaltyBrand - Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - addAllowedLoyaltyBrandItem
```
public CardAcquisitionTransaction addAllowedLoyaltyBrandItem(String allowedLoyaltyBrandItem)
```
  - getAllowedLoyaltyBrand
```
public List<String> getAllowedLoyaltyBrand()
```
    Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
    
    Returns:
    
    allowedLoyaltyBrand Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
  - setAllowedLoyaltyBrand
```
public void setAllowedLoyaltyBrand(List<String> allowedLoyaltyBrand)
```
    Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
    
    Parameters:
    
    allowedLoyaltyBrand - Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
  - loyaltyHandling
```
public CardAcquisitionTransaction loyaltyHandling(LoyaltyHandling loyaltyHandling)
```
    loyaltyHandling
    
    Parameters:
    
    loyaltyHandling -
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getLoyaltyHandling
```
public LoyaltyHandling getLoyaltyHandling()
```
    Get loyaltyHandling
    
    Returns:
    
    loyaltyHandling
  - setLoyaltyHandling
```
public void setLoyaltyHandling(LoyaltyHandling loyaltyHandling)
```
    loyaltyHandling
    
    Parameters:
    
    loyaltyHandling -
  - customerLanguage
```
public CardAcquisitionTransaction customerLanguage(String customerLanguage)
```
    The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
    
    Parameters:
    
    customerLanguage - The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getCustomerLanguage
```
public String getCustomerLanguage()
```
    The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
    
    Returns:
    
    customerLanguage The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
  - setCustomerLanguage
```
public void setCustomerLanguage(String customerLanguage)
```
    The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
    
    Parameters:
    
    customerLanguage - The language used on the terminal screen or in text printed by the terminal. Typical use case is setting the language on unattended terminals. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
  - forceEntryMode
```
public CardAcquisitionTransaction forceEntryMode(List<CardAcquisitionTransaction.ForceEntryModeEnum> forceEntryMode)
```
    forceEntryMode
    
    Parameters:
    
    forceEntryMode -
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - addForceEntryModeItem
```
public CardAcquisitionTransaction addForceEntryModeItem(CardAcquisitionTransaction.ForceEntryModeEnum forceEntryModeItem)
```
  - getForceEntryMode
```
public List<CardAcquisitionTransaction.ForceEntryModeEnum> getForceEntryMode()
```
    Get forceEntryMode
    
    Returns:
    
    forceEntryMode
  - setForceEntryMode
```
public void setForceEntryMode(List<CardAcquisitionTransaction.ForceEntryModeEnum> forceEntryMode)
```
    forceEntryMode
    
    Parameters:
    
    forceEntryMode -
  - forceCustomerSelectionFlag
```
public CardAcquisitionTransaction forceCustomerSelectionFlag(Boolean forceCustomerSelectionFlag)
```
    Indicates if the Customer realises the selection of the card application.
    
    Parameters:
    
    forceCustomerSelectionFlag - Indicates if the Customer realises the selection of the card application.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getForceCustomerSelectionFlag
```
public Boolean getForceCustomerSelectionFlag()
```
    Indicates if the Customer realises the selection of the card application.
    
    Returns:
    
    forceCustomerSelectionFlag Indicates if the Customer realises the selection of the card application.
  - setForceCustomerSelectionFlag
```
public void setForceCustomerSelectionFlag(Boolean forceCustomerSelectionFlag)
```
    Indicates if the Customer realises the selection of the card application.
    
    Parameters:
    
    forceCustomerSelectionFlag - Indicates if the Customer realises the selection of the card application.
  - totalAmount
```
public CardAcquisitionTransaction totalAmount(BigDecimal totalAmount)
```
    Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
    
    Parameters:
    
    totalAmount - Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getTotalAmount
```
public BigDecimal getTotalAmount()
```
    Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card. minimum: 0.0 maximum: 99999999.999999
    
    Returns:
    
    totalAmount Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
  - setTotalAmount
```
public void setTotalAmount(BigDecimal totalAmount)
```
    Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
    
    Parameters:
    
    totalAmount - Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
  - paymentType
```
public CardAcquisitionTransaction paymentType(PaymentType paymentType)
```
    paymentType
    
    Parameters:
    
    paymentType -
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getPaymentType
```
public PaymentType getPaymentType()
```
    Get paymentType
    
    Returns:
    
    paymentType
  - setPaymentType
```
public void setPaymentType(PaymentType paymentType)
```
    paymentType
    
    Parameters:
    
    paymentType -
  - cashBackFlag
```
public CardAcquisitionTransaction cashBackFlag(Boolean cashBackFlag)
```
    Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
    
    Parameters:
    
    cashBackFlag - Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
    
    Returns:
    
    the current CardAcquisitionTransaction instance, allowing for method chaining
  - getCashBackFlag
```
public Boolean getCashBackFlag()
```
    Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
    
    Returns:
    
    cashBackFlag Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
  - setCashBackFlag
```
public void setCashBackFlag(Boolean cashBackFlag)
```
    Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
    
    Parameters:
    
    cashBackFlag - Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
  - includeNullValues
```
public CardAcquisitionTransaction includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this CardAcquisitionTransaction object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static CardAcquisitionTransaction fromJson(String jsonString)
                                           throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of CardAcquisitionTransaction given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of CardAcquisitionTransaction
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CardAcquisitionTransaction
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of CardAcquisitionTransaction to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class CardAcquisitionTransaction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ALLOWED_PAYMENT_BRAND

JSON_PROPERTY_ALLOWED_LOYALTY_BRAND

JSON_PROPERTY_LOYALTY_HANDLING

JSON_PROPERTY_CUSTOMER_LANGUAGE

JSON_PROPERTY_FORCE_ENTRY_MODE

JSON_PROPERTY_FORCE_CUSTOMER_SELECTION_FLAG

JSON_PROPERTY_TOTAL_AMOUNT

JSON_PROPERTY_PAYMENT_TYPE

JSON_PROPERTY_CASH_BACK_FLAG

Constructor Detail

CardAcquisitionTransaction

Method Detail

allowedPaymentBrand

addAllowedPaymentBrandItem

getAllowedPaymentBrand

setAllowedPaymentBrand

allowedLoyaltyBrand

addAllowedLoyaltyBrandItem

getAllowedLoyaltyBrand

setAllowedLoyaltyBrand

loyaltyHandling

getLoyaltyHandling

setLoyaltyHandling

customerLanguage

getCustomerLanguage

setCustomerLanguage

forceEntryMode

addForceEntryModeItem

getForceEntryMode

setForceEntryMode

forceCustomerSelectionFlag

getForceCustomerSelectionFlag

setForceCustomerSelectionFlag

totalAmount

getTotalAmount

setTotalAmount

paymentType

getPaymentType

setPaymentType

cashBackFlag

getCashBackFlag

setCashBackFlag

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson