Package model
Class ConfigurationDetails
- java.lang.Object
-
- model.ConfigurationDetails
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class ConfigurationDetails extends Object
Configure the details of the activated device.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConfigurationDetails.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_ALLOW_DEBITstatic StringSERIALIZED_NAME_ALLOW_PARTIAL_APPROVALSstatic StringSERIALIZED_NAME_BYPASS_DEVICE_ON_CAPTUREstatic StringSERIALIZED_NAME_CASHBACK_OPTIONSstatic StringSERIALIZED_NAME_CHECK_FOR_DUPLICATE_TRANSACTIONSstatic StringSERIALIZED_NAME_IS_CASH_BACK_ALLOWEDstatic StringSERIALIZED_NAME_IS_GIFT_SUPPORTEDstatic StringSERIALIZED_NAME_IS_MANUAL_ENTRY_ALLOWEDstatic StringSERIALIZED_NAME_MARKET_CODEstatic StringSERIALIZED_NAME_PROMPT_AMOUNT_CONFIRMATIONstatic StringSERIALIZED_NAME_PROMPT_MANUAL_ENTRYstatic StringSERIALIZED_NAME_PROMPT_SIGNATUREstatic StringSERIALIZED_NAME_SIGNATURE_THRESHOLD_AMOUNTstatic StringSERIALIZED_NAME_TIP_OPTIONS
-
Constructor Summary
Constructors Constructor Description ConfigurationDetails()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ConfigurationDetailsallowDebit(Boolean allowDebit)ConfigurationDetailsallowPartialApprovals(Boolean allowPartialApprovals)ConfigurationDetailsbypassDeviceOnCapture(Boolean bypassDeviceOnCapture)ConfigurationDetailscashbackOptions(ConfigurationDetailsCashbackOptions cashbackOptions)ConfigurationDetailscheckForDuplicateTransactions(Boolean checkForDuplicateTransactions)booleanequals(Object o)static ConfigurationDetailsfromJson(String jsonString)Create an instance of ConfigurationDetails given an JSON stringBooleangetAllowDebit()Allow transaction to be processed on Debit rails.BooleangetAllowPartialApprovals()Determines if a transaction can be partially approved (Usually **null**).BooleangetBypassDeviceOnCapture()Sets whether the device will be used to capture `Authorizations`.ConfigurationDetailsCashbackOptionsgetCashbackOptions()Get cashbackOptionsBooleangetCheckForDuplicateTransactions()Sets whether the device will check for duplicate transactions.BooleangetIsCashBackAllowed()Sets whether the device will allow cash back.StringgetIsGiftSupported()Sets whether the device will allow gifting funds.BooleangetIsManualEntryAllowed()Sets whether the device will process payment details entered manually.StringgetMarketCode()Used by the processor to handle the `transfer`.BooleangetPromptAmountConfirmation()Sets if the card holder needs to confirm the amount they will pay (defaults to **true**).BooleangetPromptManualEntry()Sets if the device defaults to manual entry as the default card input method.StringgetPromptSignature()Sets if the device will prompt the card holder for a signature by default.LonggetSignatureThresholdAmount()The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0).ConfigurationDetailsTipOptionsgetTipOptions()Get tipOptionsinthashCode()ConfigurationDetailsisCashBackAllowed(Boolean isCashBackAllowed)ConfigurationDetailsisGiftSupported(String isGiftSupported)ConfigurationDetailsisManualEntryAllowed(Boolean isManualEntryAllowed)ConfigurationDetailsmarketCode(String marketCode)ConfigurationDetailspromptAmountConfirmation(Boolean promptAmountConfirmation)ConfigurationDetailspromptManualEntry(Boolean promptManualEntry)ConfigurationDetailspromptSignature(String promptSignature)voidsetAllowDebit(Boolean allowDebit)voidsetAllowPartialApprovals(Boolean allowPartialApprovals)voidsetBypassDeviceOnCapture(Boolean bypassDeviceOnCapture)voidsetCashbackOptions(ConfigurationDetailsCashbackOptions cashbackOptions)voidsetCheckForDuplicateTransactions(Boolean checkForDuplicateTransactions)voidsetIsCashBackAllowed(Boolean isCashBackAllowed)voidsetIsGiftSupported(String isGiftSupported)voidsetIsManualEntryAllowed(Boolean isManualEntryAllowed)voidsetMarketCode(String marketCode)voidsetPromptAmountConfirmation(Boolean promptAmountConfirmation)voidsetPromptManualEntry(Boolean promptManualEntry)voidsetPromptSignature(String promptSignature)voidsetSignatureThresholdAmount(Long signatureThresholdAmount)voidsetTipOptions(ConfigurationDetailsTipOptions tipOptions)ConfigurationDetailssignatureThresholdAmount(Long signatureThresholdAmount)ConfigurationDetailstipOptions(ConfigurationDetailsTipOptions tipOptions)StringtoJson()Convert an instance of ConfigurationDetails to an JSON stringStringtoString()static voidvalidateJsonObject(com.google.gson.JsonObject jsonObj)Validates the JSON Object and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_ALLOW_DEBIT
public static final String SERIALIZED_NAME_ALLOW_DEBIT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_PARTIAL_APPROVALS
public static final String SERIALIZED_NAME_ALLOW_PARTIAL_APPROVALS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BYPASS_DEVICE_ON_CAPTURE
public static final String SERIALIZED_NAME_BYPASS_DEVICE_ON_CAPTURE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASHBACK_OPTIONS
public static final String SERIALIZED_NAME_CASHBACK_OPTIONS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CHECK_FOR_DUPLICATE_TRANSACTIONS
public static final String SERIALIZED_NAME_CHECK_FOR_DUPLICATE_TRANSACTIONS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_CASH_BACK_ALLOWED
public static final String SERIALIZED_NAME_IS_CASH_BACK_ALLOWED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_GIFT_SUPPORTED
public static final String SERIALIZED_NAME_IS_GIFT_SUPPORTED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_MANUAL_ENTRY_ALLOWED
public static final String SERIALIZED_NAME_IS_MANUAL_ENTRY_ALLOWED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MARKET_CODE
public static final String SERIALIZED_NAME_MARKET_CODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROMPT_AMOUNT_CONFIRMATION
public static final String SERIALIZED_NAME_PROMPT_AMOUNT_CONFIRMATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROMPT_MANUAL_ENTRY
public static final String SERIALIZED_NAME_PROMPT_MANUAL_ENTRY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROMPT_SIGNATURE
public static final String SERIALIZED_NAME_PROMPT_SIGNATURE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNATURE_THRESHOLD_AMOUNT
public static final String SERIALIZED_NAME_SIGNATURE_THRESHOLD_AMOUNT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIP_OPTIONS
public static final String SERIALIZED_NAME_TIP_OPTIONS
- See Also:
- Constant Field Values
-
-
Method Detail
-
allowDebit
public ConfigurationDetails allowDebit(Boolean allowDebit)
-
getAllowDebit
@Nullable public Boolean getAllowDebit()
Allow transaction to be processed on Debit rails. If `false`, Debit card transactions will be processed on Credit rails.- Returns:
- allowDebit
-
setAllowDebit
public void setAllowDebit(Boolean allowDebit)
-
allowPartialApprovals
public ConfigurationDetails allowPartialApprovals(Boolean allowPartialApprovals)
-
getAllowPartialApprovals
@Nullable public Boolean getAllowPartialApprovals()
Determines if a transaction can be partially approved (Usually **null**).- Returns:
- allowPartialApprovals
-
setAllowPartialApprovals
public void setAllowPartialApprovals(Boolean allowPartialApprovals)
-
bypassDeviceOnCapture
public ConfigurationDetails bypassDeviceOnCapture(Boolean bypassDeviceOnCapture)
-
getBypassDeviceOnCapture
@Nullable public Boolean getBypassDeviceOnCapture()
Sets whether the device will be used to capture `Authorizations`. The device is required to be connected if `bypass_device_on_capture` is set to false. (defaults to true).- Returns:
- bypassDeviceOnCapture
-
setBypassDeviceOnCapture
public void setBypassDeviceOnCapture(Boolean bypassDeviceOnCapture)
-
cashbackOptions
public ConfigurationDetails cashbackOptions(ConfigurationDetailsCashbackOptions cashbackOptions)
-
getCashbackOptions
@Nullable public ConfigurationDetailsCashbackOptions getCashbackOptions()
Get cashbackOptions- Returns:
- cashbackOptions
-
setCashbackOptions
public void setCashbackOptions(ConfigurationDetailsCashbackOptions cashbackOptions)
-
checkForDuplicateTransactions
public ConfigurationDetails checkForDuplicateTransactions(Boolean checkForDuplicateTransactions)
-
getCheckForDuplicateTransactions
@Nullable public Boolean getCheckForDuplicateTransactions()
Sets whether the device will check for duplicate transactions.- Returns:
- checkForDuplicateTransactions
-
setCheckForDuplicateTransactions
public void setCheckForDuplicateTransactions(Boolean checkForDuplicateTransactions)
-
isCashBackAllowed
public ConfigurationDetails isCashBackAllowed(Boolean isCashBackAllowed)
-
getIsCashBackAllowed
@Nullable public Boolean getIsCashBackAllowed()
Sets whether the device will allow cash back.- Returns:
- isCashBackAllowed
-
setIsCashBackAllowed
public void setIsCashBackAllowed(Boolean isCashBackAllowed)
-
isGiftSupported
public ConfigurationDetails isGiftSupported(String isGiftSupported)
-
getIsGiftSupported
@Nullable public String getIsGiftSupported()
Sets whether the device will allow gifting funds.- Returns:
- isGiftSupported
-
setIsGiftSupported
public void setIsGiftSupported(String isGiftSupported)
-
isManualEntryAllowed
public ConfigurationDetails isManualEntryAllowed(Boolean isManualEntryAllowed)
-
getIsManualEntryAllowed
@Nullable public Boolean getIsManualEntryAllowed()
Sets whether the device will process payment details entered manually.- Returns:
- isManualEntryAllowed
-
setIsManualEntryAllowed
public void setIsManualEntryAllowed(Boolean isManualEntryAllowed)
-
marketCode
public ConfigurationDetails marketCode(String marketCode)
-
getMarketCode
@Nullable public String getMarketCode()
Used by the processor to handle the `transfer`. Usually **null**.- Returns:
- marketCode
-
setMarketCode
public void setMarketCode(String marketCode)
-
promptAmountConfirmation
public ConfigurationDetails promptAmountConfirmation(Boolean promptAmountConfirmation)
-
getPromptAmountConfirmation
@Nullable public Boolean getPromptAmountConfirmation()
Sets if the card holder needs to confirm the amount they will pay (defaults to **true**).- Returns:
- promptAmountConfirmation
-
setPromptAmountConfirmation
public void setPromptAmountConfirmation(Boolean promptAmountConfirmation)
-
promptManualEntry
public ConfigurationDetails promptManualEntry(Boolean promptManualEntry)
-
getPromptManualEntry
@Nullable public Boolean getPromptManualEntry()
Sets if the device defaults to manual entry as the default card input method. (defaults to **false**).- Returns:
- promptManualEntry
-
setPromptManualEntry
public void setPromptManualEntry(Boolean promptManualEntry)
-
promptSignature
public ConfigurationDetails promptSignature(String promptSignature)
-
getPromptSignature
@Nullable public String getPromptSignature()
Sets if the device will prompt the card holder for a signature by default. Available values include:<ul><li><strong>ALWAYS</strong><li><strong>NEVER</strong><li><strong>AMOUNT</strong>: Used in conjunction with `signature_threshold_amount` so when the threshold is reached the signature form appears on the device.- Returns:
- promptSignature
-
setPromptSignature
public void setPromptSignature(String promptSignature)
-
signatureThresholdAmount
public ConfigurationDetails signatureThresholdAmount(Long signatureThresholdAmount)
-
getSignatureThresholdAmount
@Nullable public Long getSignatureThresholdAmount()
The threshold to prompt a signature when `prompt_signature` is set to **AMOUNT** (defaults to 0).- Returns:
- signatureThresholdAmount
-
setSignatureThresholdAmount
public void setSignatureThresholdAmount(Long signatureThresholdAmount)
-
tipOptions
public ConfigurationDetails tipOptions(ConfigurationDetailsTipOptions tipOptions)
-
getTipOptions
@Nullable public ConfigurationDetailsTipOptions getTipOptions()
Get tipOptions- Returns:
- tipOptions
-
setTipOptions
public void setTipOptions(ConfigurationDetailsTipOptions tipOptions)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON Object- Throws:
IOException- if the JSON Object is invalid with respect to ConfigurationDetails
-
fromJson
public static ConfigurationDetails fromJson(String jsonString) throws IOException
Create an instance of ConfigurationDetails given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ConfigurationDetails
- Throws:
IOException- if the JSON string is invalid with respect to ConfigurationDetails
-
toJson
public String toJson()
Convert an instance of ConfigurationDetails to an JSON string- Returns:
- JSON string
-
-