Package com.adyen.model.tapi
Class TransactionConditions
- java.lang.Object
-
- com.adyen.model.tapi.TransactionConditions
-
public class TransactionConditions extends Object
Conditions on which the transaction must be processed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransactionConditions.ForceEntryModeEnumGets or Sets forceEntryMode
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACQUIRER_I_Dstatic StringJSON_PROPERTY_ALLOWED_LOYALTY_BRANDstatic StringJSON_PROPERTY_ALLOWED_PAYMENT_BRANDstatic StringJSON_PROPERTY_CUSTOMER_LANGUAGEstatic StringJSON_PROPERTY_DEBIT_PREFERRED_FLAGstatic StringJSON_PROPERTY_FORCE_ENTRY_MODEstatic StringJSON_PROPERTY_FORCE_ONLINE_FLAGstatic StringJSON_PROPERTY_LOYALTY_HANDLINGstatic StringJSON_PROPERTY_MERCHANT_CATEGORY_CODE
-
Constructor Summary
Constructors Constructor Description TransactionConditions()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TransactionConditionsacquirerID(List<Integer> acquirerID)Identification of the Acquirer.TransactionConditionsaddAcquirerIDItem(Integer acquirerIDItem)TransactionConditionsaddAllowedLoyaltyBrandItem(String allowedLoyaltyBrandItem)TransactionConditionsaddAllowedPaymentBrandItem(String allowedPaymentBrandItem)TransactionConditionsaddForceEntryModeItem(TransactionConditions.ForceEntryModeEnum forceEntryModeItem)TransactionConditionsallowedLoyaltyBrand(List<String> allowedLoyaltyBrand)Loyalty brands or programs allowed by the Sale System for the loyalty transaction.TransactionConditionsallowedPaymentBrand(List<String> allowedPaymentBrand)Payment brands accepted for this transaction.TransactionConditionscustomerLanguage(String customerLanguage)The language used on the terminal screen or in text printed by the terminal.TransactionConditionsdebitPreferredFlag(Boolean debitPreferredFlag)The preferred type of payment is a debit transaction rather than a credit transaction.booleanequals(Object o)Return true if this TransactionConditions object is equal to o.TransactionConditionsforceEntryMode(List<TransactionConditions.ForceEntryModeEnum> forceEntryMode)forceEntryModeTransactionConditionsforceOnlineFlag(Boolean forceOnlineFlag)Indicates if the Cashier requires POI forces online access to the Acquirer.static TransactionConditionsfromJson(String jsonString)Create an instance of TransactionConditions given an JSON stringList<Integer>getAcquirerID()Identification of the Acquirer.List<String>getAllowedLoyaltyBrand()Loyalty brands or programs allowed by the Sale System for the loyalty transaction.List<String>getAllowedPaymentBrand()Payment brands accepted for this transaction.StringgetCustomerLanguage()The language used on the terminal screen or in text printed by the terminal.BooleangetDebitPreferredFlag()The preferred type of payment is a debit transaction rather than a credit transaction.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.List<TransactionConditions.ForceEntryModeEnum>getForceEntryMode()Get forceEntryModeBooleangetForceOnlineFlag()Indicates if the Cashier requires POI forces online access to the Acquirer.LoyaltyHandlinggetLoyaltyHandling()Get loyaltyHandlingStringgetMerchantCategoryCode()The code which identifies the category of the transaction (MCC).inthashCode()TransactionConditionsincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.TransactionConditionsloyaltyHandling(LoyaltyHandling loyaltyHandling)loyaltyHandlingTransactionConditionsmerchantCategoryCode(String merchantCategoryCode)The code which identifies the category of the transaction (MCC).voidsetAcquirerID(List<Integer> acquirerID)Identification of the Acquirer.voidsetAllowedLoyaltyBrand(List<String> allowedLoyaltyBrand)Loyalty brands or programs allowed by the Sale System for the loyalty transaction.voidsetAllowedPaymentBrand(List<String> allowedPaymentBrand)Payment brands accepted for this transaction.voidsetCustomerLanguage(String customerLanguage)The language used on the terminal screen or in text printed by the terminal.voidsetDebitPreferredFlag(Boolean debitPreferredFlag)The preferred type of payment is a debit transaction rather than a credit transaction.voidsetForceEntryMode(List<TransactionConditions.ForceEntryModeEnum> forceEntryMode)forceEntryModevoidsetForceOnlineFlag(Boolean forceOnlineFlag)Indicates if the Cashier requires POI forces online access to the Acquirer.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetLoyaltyHandling(LoyaltyHandling loyaltyHandling)loyaltyHandlingvoidsetMerchantCategoryCode(String merchantCategoryCode)The code which identifies the category of the transaction (MCC).StringtoJson()Convert an instance of TransactionConditions to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ALLOWED_PAYMENT_BRAND
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_BRAND
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ACQUIRER_I_D
public static final String JSON_PROPERTY_ACQUIRER_I_D
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DEBIT_PREFERRED_FLAG
public static final String JSON_PROPERTY_DEBIT_PREFERRED_FLAG
- 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_ONLINE_FLAG
public static final String JSON_PROPERTY_FORCE_ONLINE_FLAG
- 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_MERCHANT_CATEGORY_CODE
public static final String JSON_PROPERTY_MERCHANT_CATEGORY_CODE
- See Also:
- Constant Field Values
-
-
Method Detail
-
allowedPaymentBrand
public TransactionConditions allowedPaymentBrand(List<String> allowedPaymentBrand)
Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.- Parameters:
allowedPaymentBrand- Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
addAllowedPaymentBrandItem
public TransactionConditions addAllowedPaymentBrandItem(String allowedPaymentBrandItem)
-
getAllowedPaymentBrand
public List<String> getAllowedPaymentBrand()
Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.- Returns:
- allowedPaymentBrand Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.
-
setAllowedPaymentBrand
public void setAllowedPaymentBrand(List<String> allowedPaymentBrand)
Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.- Parameters:
allowedPaymentBrand- Payment brands accepted for this transaction. Card payment brands allowed by the Sale System for the payment transaction. Restrict brand if data sent.
-
acquirerID
public TransactionConditions acquirerID(List<Integer> acquirerID)
Identification of the Acquirer. Restrict to these Acquirer if present.- Parameters:
acquirerID- Identification of the Acquirer. Restrict to these Acquirer if present.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
addAcquirerIDItem
public TransactionConditions addAcquirerIDItem(Integer acquirerIDItem)
-
getAcquirerID
public List<Integer> getAcquirerID()
Identification of the Acquirer. Restrict to these Acquirer if present.- Returns:
- acquirerID Identification of the Acquirer. Restrict to these Acquirer if present.
-
setAcquirerID
public void setAcquirerID(List<Integer> acquirerID)
Identification of the Acquirer. Restrict to these Acquirer if present.- Parameters:
acquirerID- Identification of the Acquirer. Restrict to these Acquirer if present.
-
debitPreferredFlag
public TransactionConditions debitPreferredFlag(Boolean debitPreferredFlag)
The preferred type of payment is a debit transaction rather than a credit transaction.- Parameters:
debitPreferredFlag- The preferred type of payment is a debit transaction rather than a credit transaction.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
getDebitPreferredFlag
public Boolean getDebitPreferredFlag()
The preferred type of payment is a debit transaction rather than a credit transaction.- Returns:
- debitPreferredFlag The preferred type of payment is a debit transaction rather than a credit transaction.
-
setDebitPreferredFlag
public void setDebitPreferredFlag(Boolean debitPreferredFlag)
The preferred type of payment is a debit transaction rather than a credit transaction.- Parameters:
debitPreferredFlag- The preferred type of payment is a debit transaction rather than a credit transaction.
-
allowedLoyaltyBrand
public TransactionConditions allowedLoyaltyBrand(List<String> allowedLoyaltyBrand)
Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.- Parameters:
allowedLoyaltyBrand- Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
addAllowedLoyaltyBrandItem
public TransactionConditions addAllowedLoyaltyBrandItem(String allowedLoyaltyBrandItem)
-
getAllowedLoyaltyBrand
public List<String> getAllowedLoyaltyBrand()
Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.- Returns:
- allowedLoyaltyBrand Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.
-
setAllowedLoyaltyBrand
public void setAllowedLoyaltyBrand(List<String> allowedLoyaltyBrand)
Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.- Parameters:
allowedLoyaltyBrand- Loyalty brands or programs allowed by the Sale System for the loyalty transaction. Restrict brand if data sent.
-
loyaltyHandling
public TransactionConditions loyaltyHandling(LoyaltyHandling loyaltyHandling)
loyaltyHandling- Parameters:
loyaltyHandling-- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
getLoyaltyHandling
public LoyaltyHandling getLoyaltyHandling()
Get loyaltyHandling- Returns:
- loyaltyHandling
-
setLoyaltyHandling
public void setLoyaltyHandling(LoyaltyHandling loyaltyHandling)
loyaltyHandling- Parameters:
loyaltyHandling-
-
customerLanguage
public TransactionConditions 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
TransactionConditionsinstance, 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.
-
forceOnlineFlag
public TransactionConditions forceOnlineFlag(Boolean forceOnlineFlag)
Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.- Parameters:
forceOnlineFlag- Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
getForceOnlineFlag
public Boolean getForceOnlineFlag()
Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.- Returns:
- forceOnlineFlag Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.
-
setForceOnlineFlag
public void setForceOnlineFlag(Boolean forceOnlineFlag)
Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.- Parameters:
forceOnlineFlag- Indicates if the Cashier requires POI forces online access to the Acquirer. Go online if data sent.
-
forceEntryMode
public TransactionConditions forceEntryMode(List<TransactionConditions.ForceEntryModeEnum> forceEntryMode)
forceEntryMode- Parameters:
forceEntryMode-- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
addForceEntryModeItem
public TransactionConditions addForceEntryModeItem(TransactionConditions.ForceEntryModeEnum forceEntryModeItem)
-
getForceEntryMode
public List<TransactionConditions.ForceEntryModeEnum> getForceEntryMode()
Get forceEntryMode- Returns:
- forceEntryMode
-
setForceEntryMode
public void setForceEntryMode(List<TransactionConditions.ForceEntryModeEnum> forceEntryMode)
forceEntryMode- Parameters:
forceEntryMode-
-
merchantCategoryCode
public TransactionConditions merchantCategoryCode(String merchantCategoryCode)
The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.- Parameters:
merchantCategoryCode- The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.- Returns:
- the current
TransactionConditionsinstance, allowing for method chaining
-
getMerchantCategoryCode
public String getMerchantCategoryCode()
The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.- Returns:
- merchantCategoryCode The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.
-
setMerchantCategoryCode
public void setMerchantCategoryCode(String merchantCategoryCode)
The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.- Parameters:
merchantCategoryCode- The code which identifies the category of the transaction (MCC). The payment implies a specific MCC.
-
includeNullValues
public TransactionConditions 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 TransactionConditions object is equal to o.
-
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 TransactionConditions fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of TransactionConditions given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of TransactionConditions
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to TransactionConditions
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of TransactionConditions to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-