Package com.creditcall.chipdnamobile

Class ParameterKeys

  • public class ParameterKeys
extends java.lang.Object
    Defines string constants for parameter keys used throughout the ChipDNA Mobile SDK.

    Since:
    1.0
    Author:
    Creditcall
    See Also:
    ParameterValues, Parameters, ChipDnaMobile

    • Field Detail

      • Result

        public static final java.lang.String Result
        Parameter key for result value.
        See Also:
        Constant Field Values

      • Errors

        public static final java.lang.String Errors
        Parameter key used when returning comma separated error codes.
        See Also:
        Constant Field Values

      • ErrorDescription

        public static final java.lang.String ErrorDescription
        Parameter key for returning text description of an error.
        See Also:
        Constant Field Values

      • Password

        public static final java.lang.String Password
        Parameter key for attempting a password during initialization.
        See Also:
        Constant Field Values

      • ChangePassword

        public static final java.lang.String ChangePassword
        Parameter key for changing the password after initialization.
        See Also:
        Constant Field Values

      • RemainingAttempts

        public static final java.lang.String RemainingAttempts
        Parameter key for remaining attempts for initialization password before SDK app data is destroyed.
        See Also:
        Constant Field Values

      • Destroy

        public static final java.lang.String Destroy
        Parameter key to wipe all SDK app data and delete the configuration and offline database when value is True.
        See Also:
        Constant Field Values

      • ApplicationIdentifier

        public static final java.lang.String ApplicationIdentifier
        Parameter key for setting application identifier.
        See Also:
        Constant Field Values

      • TerminalId

        public static final java.lang.String TerminalId
        Parameter key for setting terminal ID.
        See Also:
        Constant Field Values

      • TransactionKey

        public static final java.lang.String TransactionKey
        Parameter key for setting transaction key.
        See Also:
        Constant Field Values

      • Environment

        public static final java.lang.String Environment
        Parameter key for setting and receive the current environment of ChipDNA Mobile. The value can be production or test.
        See Also:
        Constant Field Values

      • WebMisUsername

        public static final java.lang.String WebMisUsername
        Parameter key for setting WebMIS username.
        See Also:
        Constant Field Values

      • WebMisPassword

        public static final java.lang.String WebMisPassword
        Parameter key for setting WebMIS password.
        See Also:
        Constant Field Values

      • ApiKey

        public static final java.lang.String ApiKey
        Parameter key for setting Api Key used for communicating with the gateway.
        See Also:
        Constant Field Values

      • RegistrationUrl

        public static final java.lang.String RegistrationUrl
        Parameter key for the Registration URL.
        See Also:
        Constant Field Values

      • PinPadName

        public static final java.lang.String PinPadName
        Parameter key for setting the PIN pad name of the PIN pad to connect to.
        See Also:
        Constant Field Values

      • PinPadConnectionType

        public static final java.lang.String PinPadConnectionType
        Parameter key for setting the connection type of the PIN pad to connect to.
        See Also:
        Constant Field Values

      • PinPadIpAddress

        public static final java.lang.String PinPadIpAddress
        Parameter key for for setting the IP address of the PIN pad to connect to.
        See Also:
        Constant Field Values

      • PinPadPort

        public static final java.lang.String PinPadPort
        Parameter key for setting the IP port number of the PIN pad to connect to.
        See Also:
        Constant Field Values

      • DeviceStatusUpdate

        public static final java.lang.String DeviceStatusUpdate
        Parameter key for current device status XML string. XML can be converted into an DeviceStatus object using @{link ChipDnaMobileSerializer#deserializeDeviceStatus}.
        See Also:
        Constant Field Values

      • AutomaticReboot

        public static final java.lang.String AutomaticReboot
        Parameter key indicating if the PIN pad reboot is automatic or manual. Values can be True for automatic or False for manual.
        See Also:
        Constant Field Values

      • FirmwareFile

        public static final java.lang.String FirmwareFile
        Parameter key indicating the name of the firmware file being downloaded to the device.
        See Also:
        Constant Field Values

      • FirmwareDownloadPercentage

        public static final java.lang.String FirmwareDownloadPercentage
        Parameter key indicating the percentage of firmware downloaded to the device. Value is an integer between 0 and 100.
        See Also:
        Constant Field Values

      • FirmwareUpdateAvailable

        public static final java.lang.String FirmwareUpdateAvailable
        Parameter key indicating if a firmware update is available. Values can be True or False.
        See Also:
        Constant Field Values

      • ApplyFirmwareUpdate

        public static final java.lang.String ApplyFirmwareUpdate
        Parameter key indicating if a firmware update is to be performed if one is available. Values can be True to update firmware during this connect and configure / request TMS update or False to delay.
        See Also:
        Constant Field Values

      • Amount

        public static final java.lang.String Amount
        Parameter key for the transaction amount.
        See Also:
        Constant Field Values

      • UserReference

        public static final java.lang.String UserReference
        Parameter key for the user reference. User reference must be unique per transaction.
        See Also:
        Constant Field Values

      • Currency

        public static final java.lang.String Currency
        Parameter key for the currency for a transaction. If only one currency is available ChipDNA Mobile will default to that currency.
        See Also:
        Constant Field Values

      • OnDeviceTippingPrompt

        public static final java.lang.String OnDeviceTippingPrompt
        Parameter key to add a custom on-device tipping prompt. With the Miura M020 and M021 the value can have a maximum of 4 lines with a maximum of 21 characters in each line, with new lines indicated by "\n" or "\r". The value accepts UTF-8 characters and cannot be longer than 195 bytes.
        See Also:
        Constant Field Values

      • DynamicTippingAmounts

        public static final java.lang.String DynamicTippingAmounts
        Parameter key for on-device dynamic tipping amounts in minor units. Value must be three comma-separated numeric values between 0 and 1000000. For example, for tip amounts of $3.00, $4.50, and $10.00, the value entered must be "300,450,1000".
        See Also:
        Constant Field Values

      • DynamicTippingPercentages

        public static final java.lang.String DynamicTippingPercentages
        Parameter key for on-device dynamic tipping percentages. Value must be three comma-separated numeric values between 0 and 100.
        See Also:
        Constant Field Values

      • DynamicTippingHeader

        public static final java.lang.String DynamicTippingHeader
        Parameter key for on-device dynamic tipping header. With the Miura M020 and M021 the value accepts UTF-8 characters and cannot be longer than 63 bytes. The value must not be empty.
        See Also:
        Constant Field Values

      • PaymentMethod

        public static final java.lang.String PaymentMethod
        Parameter key to indicate how a transaction will be processed. Values can be CASH, CHEQUE or CARD.
        See Also:
        Constant Field Values

      • PANKeyEntry

        public static final java.lang.String PANKeyEntry
        Parameter key for PAN key entry. Value is either True or False.
        See Also:
        Constant Field Values

      • CredentialOnFileFirstStore

        public static final java.lang.String CredentialOnFileFirstStore
        Parameter key to indicate the transaction is the first store for a Credential on File transaction.
        See Also:
        Constant Field Values

      • OperatorPin

        public static final java.lang.String OperatorPin
        Parameter key for the operator pin.
        See Also:
        Constant Field Values

      • CustomerVaultId

        public static final java.lang.String CustomerVaultId
        Parameter key for customer vault identifier.
        See Also:
        Constant Field Values

      • CustomerVaultCommand

        public static final java.lang.String CustomerVaultCommand
        Parameter key for customer vault command.
        See Also:
        Constant Field Values

      • MerchantDefinedField01

        public static final java.lang.String MerchantDefinedField01
        Parameter key for merchant defined field 1.
        See Also:
        Constant Field Values

      • MerchantDefinedField02

        public static final java.lang.String MerchantDefinedField02
        Parameter key for merchant defined field 2.
        See Also:
        Constant Field Values

      • MerchantDefinedField03

        public static final java.lang.String MerchantDefinedField03
        Parameter key for merchant defined field 3.
        See Also:
        Constant Field Values

      • MerchantDefinedField04

        public static final java.lang.String MerchantDefinedField04
        Parameter key for merchant defined field 4.
        See Also:
        Constant Field Values

      • MerchantDefinedField05

        public static final java.lang.String MerchantDefinedField05
        Parameter key for merchant defined field 5.
        See Also:
        Constant Field Values

      • MerchantDefinedField06

        public static final java.lang.String MerchantDefinedField06
        Parameter key for merchant defined field 6.
        See Also:
        Constant Field Values

      • MerchantDefinedField07

        public static final java.lang.String MerchantDefinedField07
        Parameter key for merchant defined field 7.
        See Also:
        Constant Field Values

      • MerchantDefinedField08

        public static final java.lang.String MerchantDefinedField08
        Parameter key for merchant defined field 8.
        See Also:
        Constant Field Values

      • MerchantDefinedField09

        public static final java.lang.String MerchantDefinedField09
        Parameter key for merchant defined field 9.
        See Also:
        Constant Field Values

      • MerchantDefinedField10

        public static final java.lang.String MerchantDefinedField10
        Parameter key for merchant defined field 10.
        See Also:
        Constant Field Values

      • MerchantDefinedField11

        public static final java.lang.String MerchantDefinedField11
        Parameter key for merchant defined field 11.
        See Also:
        Constant Field Values

      • MerchantDefinedField12

        public static final java.lang.String MerchantDefinedField12
        Parameter key for merchant defined field 12.
        See Also:
        Constant Field Values

      • MerchantDefinedField13

        public static final java.lang.String MerchantDefinedField13
        Parameter key for merchant defined field 13.
        See Also:
        Constant Field Values

      • MerchantDefinedField14

        public static final java.lang.String MerchantDefinedField14
        Parameter key for merchant defined field 14.
        See Also:
        Constant Field Values

      • MerchantDefinedField15

        public static final java.lang.String MerchantDefinedField15
        Parameter key for merchant defined field 15.
        See Also:
        Constant Field Values

      • MerchantDefinedField16

        public static final java.lang.String MerchantDefinedField16
        Parameter key for merchant defined field 16.
        See Also:
        Constant Field Values

      • MerchantDefinedField17

        public static final java.lang.String MerchantDefinedField17
        Parameter key for merchant defined field 17.
        See Also:
        Constant Field Values

      • MerchantDefinedField18

        public static final java.lang.String MerchantDefinedField18
        Parameter key for merchant defined field 18.
        See Also:
        Constant Field Values

      • MerchantDefinedField19

        public static final java.lang.String MerchantDefinedField19
        Parameter key for merchant defined field 19.
        See Also:
        Constant Field Values

      • MerchantDefinedField20

        public static final java.lang.String MerchantDefinedField20
        Parameter key for merchant defined field 20.
        See Also:
        Constant Field Values

      • CloseTransaction

        public static final java.lang.String CloseTransaction
        Parameter key indicating whether a transaction should be closed.
        See Also:
        Constant Field Values

      • TipAmount

        public static final java.lang.String TipAmount
        Parameter key indicating the tip amount.
        See Also:
        Constant Field Values

      • SaleReference

        public static final java.lang.String SaleReference
        Parameter key for the user reference of a linked sale transaction.
        See Also:
        Constant Field Values

      • AuthCode

        public static final java.lang.String AuthCode
        Parameter key for authorization code of a transaction.
        See Also:
        Constant Field Values

      • CardEaseReference

        public static final java.lang.String CardEaseReference
        Parameter key for CardEase reference of a transaction.
        See Also:
        Constant Field Values

      • TransactionId

        public static final java.lang.String TransactionId
        Parameter key for transaction identifier of a transaction.
        See Also:
        Constant Field Values

      • MaskedPan

        public static final java.lang.String MaskedPan
        Parameter key for a masked PAN.
        See Also:
        Constant Field Values

      • AmountOnlineAuthorized

        public static final java.lang.String AmountOnlineAuthorized
        Parameter key for the amount of a transaction authorized online.
        See Also:
        Constant Field Values

      • TransactionDateTime

        public static final java.lang.String TransactionDateTime
        Parameter key for a transactions local date and time.
        See Also:
        Constant Field Values

      • TransactionDateTimeUtc

        public static final java.lang.String TransactionDateTimeUtc
        Parameter key for a transactions UTC date time.
        See Also:
        Constant Field Values

      • CardReference

        public static final java.lang.String CardReference
        Parameter key for the card reference.
        See Also:
        Constant Field Values

      • CardSchemeId

        public static final java.lang.String CardSchemeId
        Parameter key for the card scheme ID.
        See Also:
        Constant Field Values

      • CardHolderFirstName

        public static final java.lang.String CardHolderFirstName
        Parameter key for the card holder first name.
        See Also:
        Constant Field Values

      • CardHolderLastName

        public static final java.lang.String CardHolderLastName
        Parameter key for the card holder last name.
        See Also:
        Constant Field Values

      • AcquirerResponseCode

        public static final java.lang.String AcquirerResponseCode
        Parameter key for the acquirer response code.
        See Also:
        Constant Field Values

      • DateTimeFormat

        public static final java.lang.String DateTimeFormat
        Parameter key for the format of the date/times returned.
        See Also:
        Constant Field Values

      • PreformattedMerchantReceipt

        public static final java.lang.String PreformattedMerchantReceipt
        Parameter key for the preformatted merchant receipt text.
        See Also:
        Constant Field Values

      • PreformattedCustomerReceipt

        public static final java.lang.String PreformattedCustomerReceipt
        Parameter key for the preformatted customer receipt text.
        See Also:
        Constant Field Values

      • MerchantName

        public static final java.lang.String MerchantName
        Parameter key for the merchant name.
        See Also:
        Constant Field Values

      • MerchantData

        public static final java.lang.String MerchantData
        Parameter key for the merchant data.
        See Also:
        Constant Field Values

      • ResponseRequired

        public static final java.lang.String ResponseRequired
        Parameter key indicating if a response is required to the triggered action. Value will be either True, indicating a response is required, or False if not.
        See Also:
        Constant Field Values

      • OperatorPinRequired

        public static final java.lang.String OperatorPinRequired
        Parameter key indicating if an operator pin must be supplied when responding to an action. Value can be either True or False. If not supplied, value is False.
        See Also:
        Constant Field Values

      • OnlinePinPresent

        public static final java.lang.String OnlinePinPresent
        Parameter key indicating that an online pin block is present.
        See Also:
        Constant Field Values

      • DeferredAuthorizationReason

        public static final java.lang.String DeferredAuthorizationReason
        Parameter key for the reason a deferred authorization is being offered.
        See Also:
        Constant Field Values

      • ReferralNumber

        public static final java.lang.String ReferralNumber
        Parameter key for the phone number required for voice referral.
        See Also:
        Constant Field Values

      • DigitalSignatureSupported

        public static final java.lang.String DigitalSignatureSupported
        Parameter key indicating if digital signature is supported. Value can be either True or False. If not supplied, value is False.
        See Also:
        Constant Field Values

      • SignatureData

        public static final java.lang.String SignatureData
        Parameter key to supply digital signature data as a base64 string.
        See Also:
        Constant Field Values

      • Track2ClearText

        public static final java.lang.String Track2ClearText
        Parameter key for the unencrypted clear text track2 of a card returned by the pinpad.
        See Also:
        Constant Field Values

      • MaskedTrack2

        public static final java.lang.String MaskedTrack2
        Parameter key for the masked track2 of a card returned by the PIN pad.
        See Also:
        Constant Field Values

      • ExpiryDate

        public static final java.lang.String ExpiryDate
        Parameter key for the expiry date of a card returned by the PIN pad.
        See Also:
        Constant Field Values

      • IdleMessage

        public static final java.lang.String IdleMessage
        Parameter key for the idle message to be displayed.
        See Also:
        Constant Field Values

      • DisplayTime

        public static final java.lang.String DisplayTime
        Parameter key for the length of time a message should be displayed in seconds. If not present time will be infinite.
        See Also:
        Constant Field Values

      • ChipDnaStatus

        public static final java.lang.String ChipDnaStatus
        Parameter key for current status of ChipDNA.
        See Also:
        Constant Field Values

      • LinkedRefundsSupported

        public static final java.lang.String LinkedRefundsSupported
        Parameter key indicating if linked refunds are supported.
        See Also:
        Constant Field Values

      • StandaloneRefundsSupported

        public static final java.lang.String StandaloneRefundsSupported
        Parameter key indicating if standalone refunds are supported.
        See Also:
        Constant Field Values

      • CashTransactionsSupported

        public static final java.lang.String CashTransactionsSupported
        Parameter key indicating if cash transactions are supported.
        See Also:
        Constant Field Values

      • ChequeTransactionsSupported

        public static final java.lang.String ChequeTransactionsSupported
        Parameter key indicating if cheque transaction are supported.
        See Also:
        Constant Field Values

      • TransactionHistorySupported

        public static final java.lang.String TransactionHistorySupported
        Parameter key indicating if transaction history information is supported.
        See Also:
        Constant Field Values

      • OfflineProcessingSupported

        public static final java.lang.String OfflineProcessingSupported
        Parameter key indicating if offline processing is supported.
        See Also:
        Constant Field Values

      • RefundOperatorPinSupported

        public static final java.lang.String RefundOperatorPinSupported
        Parameter key indicating if an operator PIN must be supplied in order to perform standalone refunds.
        See Also:
        Constant Field Values

      • EmailReceiptSupported

        public static final java.lang.String EmailReceiptSupported
        Parameter key indicating if receipting via email is supported.
        See Also:
        Constant Field Values

      • SmsReceiptSupported

        public static final java.lang.String SmsReceiptSupported
        Parameter key indicating if receipting via SMS is supported.
        See Also:
        Constant Field Values

      • TippingSupported

        public static final java.lang.String TippingSupported
        Parameter key indicating which version of tipping is supported.
        See Also:
        Constant Field Values

      • FullTmsUpdate

        public static final java.lang.String FullTmsUpdate
        Parameter key to trigger a full TMS update. Value can be either True or False.
        See Also:
        Constant Field Values

      • ForceTmsUpdate

        public static final java.lang.String ForceTmsUpdate
        Parameter key to force a TMS update. Value can be either True or False.
        See Also:
        Constant Field Values

      • TmsUpdateUtc

        public static final java.lang.String TmsUpdateUtc
        Parameter key for date/time of last TMS update time in UTC.
        See Also:
        Constant Field Values

      • OfflineStatus

        public static final java.lang.String OfflineStatus
        Parameter key indicating the offline status of a transaction.
        See Also:
        Constant Field Values

      • LinkedRefundReferences

        public static final java.lang.String LinkedRefundReferences
        Parameter key for the linked refund references linked to the transaction.
        See Also:
        Constant Field Values

      • OfflineCompletionDateTime

        public static final java.lang.String OfflineCompletionDateTime
        Parameter key for the date and time that an offline request was completed.
        See Also:
        Constant Field Values

      • OfflineRequestErrors

        public static final java.lang.String OfflineRequestErrors
        Parameter key for the errors associated with an offline request.
        See Also:
        Constant Field Values

      • ReceiptText

        public static final java.lang.String ReceiptText
        Parameter key for the receipt text.
        See Also:
        Constant Field Values

      • EmailAddress

        public static final java.lang.String EmailAddress
        Parameter key for an email address.
        See Also:
        Constant Field Values

      • PhoneNumber

        public static final java.lang.String PhoneNumber
        Parameter key for a phone number.
        See Also:
        Constant Field Values

      • ReceiptSourceName

        public static final java.lang.String ReceiptSourceName
        Parameter key for the receipts source name.
        See Also:
        Constant Field Values

      • ReceiptSourceEmail

        public static final java.lang.String ReceiptSourceEmail
        Parameter key for the receipts source email address.
        See Also:
        Constant Field Values

      • ReceiptEmailSubject

        public static final java.lang.String ReceiptEmailSubject
        Parameter key for the emails subject field of receipts.
        See Also:
        Constant Field Values

      • SendEmailReceipt

        public static final java.lang.String SendEmailReceipt
        Parameter key for requesting that a receipt should be sent via email.
        See Also:
        Constant Field Values

      • SendSmsReceipt

        public static final java.lang.String SendSmsReceipt
        Parameter key for requesting that a receipt should be sent via SMS.
        See Also:
        Constant Field Values

      • PrintReceipt

        public static final java.lang.String PrintReceipt
        Parameter key for requesting that a receipt should be printed from the device if supported.
        See Also:
        Constant Field Values

      • SearchConnectionTypeBluetooth

        public static final java.lang.String SearchConnectionTypeBluetooth
        Parameter for requesting for the SDK to search for PIN pads connected via Bluetooth.
        See Also:
        Constant Field Values

      • SearchConnectionTypeBluetoothLe

        public static final java.lang.String SearchConnectionTypeBluetoothLe
        Parameter for requesting for the SDK to search for PIN pads via Bluetooth Low Energy.
        See Also:
        Constant Field Values

      • SearchConnectionTypeUsb

        public static final java.lang.String SearchConnectionTypeUsb
        Parameter for requesting for the SDK to search for PIN pads connected via USB.
        See Also:
        Constant Field Values

      • SearchOnlyOnlineBluetoothLePinPads

        public static final java.lang.String SearchOnlyOnlineBluetoothLePinPads
        Parameter for requesting for the SDK to search for only online PIN pads connected via Bluetooth Low Energy.
        See Also:
        Constant Field Values

      • AutoConfirm

        public static final java.lang.String AutoConfirm
        Parameter key to trigger auto confirmation of a transaction. Value is either True or False.
        See Also:
        Constant Field Values

      • BillingAddress1

        public static final java.lang.String BillingAddress1
        Parameter key for Address Line One in Billing Information.
        See Also:
        Constant Field Values

      • BillingAddress2

        public static final java.lang.String BillingAddress2
        Parameter key for Address Line Two in Billing Information.
        See Also:
        Constant Field Values

      • BillingCity

        public static final java.lang.String BillingCity
        Parameter key for the City in Billing Information.
        See Also:
        Constant Field Values

      • BillingState

        public static final java.lang.String BillingState
        Parameter key for the State in Billing Information.
        See Also:
        Constant Field Values

      • BillingZipCode

        public static final java.lang.String BillingZipCode
        Parameter key for the Zip Code in Billing Information. Can be used interchangeably with BILLING_ZIP_CODE
        See Also:
        Constant Field Values

      • BillingPostalCode

        public static final java.lang.String BillingPostalCode
        Parameter key for the Zip Code in Billing Information. Can be used interchangeably with BILLING_POSTAL_CODE
        See Also:
        Constant Field Values

      • BillingCountry

        public static final java.lang.String BillingCountry
        Parameter key for the Country in Billing Information.
        See Also:
        Constant Field Values

      • BillingEmailAddress

        public static final java.lang.String BillingEmailAddress
        Parameter key for the Email Address in Billing Information.
        See Also:
        Constant Field Values

      • BillingPhoneNumber

        public static final java.lang.String BillingPhoneNumber
        Parameter key for the Phone Number in Billing Information.
        See Also:
        Constant Field Values

      • PurchaseOrderNumber

        public static final java.lang.String PurchaseOrderNumber
        Parameter key for the Purchase Order Number.
        See Also:
        Constant Field Values

      • TaxAmount

        public static final java.lang.String TaxAmount
        Parameter key for the Tax Amount.
        See Also:
        Constant Field Values

      • SelectedApplication

        public static final java.lang.String SelectedApplication
        Parameter key for the card application selected by the Cardholder during application selection.
        See Also:
        Constant Field Values

      • MerchantDisplayName

        public static final java.lang.String MerchantDisplayName
        Parameter key for the configured merchant display name. The default name displayed on the PIN pad when it is idle.
        See Also:
        Constant Field Values

      • DelayOnlineProcessing

        public static final java.lang.String DelayOnlineProcessing
        Parameter key for to delay online processing.
        See Also:
        Constant Field Values

      • EncodedRequest

        public static final java.lang.String EncodedRequest
        Parameter key for encoded requests.
        See Also:
        Constant Field Values

      • AddressVerificationResult

        public static final java.lang.String AddressVerificationResult
        Parameter key for address verification result.

        Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.

        See Also:
        Constant Field Values

      • ZipCodeVerificationResult

        public static final java.lang.String ZipCodeVerificationResult
        Parameter key for zip code verification result.

        Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.

        See Also:
        Constant Field Values

      • CscVerificationResult

        public static final java.lang.String CscVerificationResult
        Parameter key for CSC verification result.

        Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.

        See Also:
        Constant Field Values

    • Constructor Detail

      • ParameterKeys

        public ParameterKeys()