|
ChipDna Mobile
|
Classes | |
| class | CCParameters |
| Parameters used in communication with ChipDNA Mobile. More... | |
Typedefs | |
| typedef NSString * | CCParameters::CCParameterKey |
Functions | |
| (void) | - CCParameters::setValue:forKey: |
| (void) | - CCParameters::removeValueForKey: |
| (NSString *) | - CCParameters::valueForKey: |
| (void) | - CCParameters::removeAllObjects |
| (NSArray *) | - CCParameters::allKeys |
| (NSArray *) | - CCParameters::allValues |
| - (typedef NSString*) CCParameterKey |
Parameter keys used in communication with ChipDNA Mobile
| - (NSArray *) allKeys |
Returns all keys currently within the the parameter collection.
| - (NSArray *) allValues |
Returns all values currently within the parameter collection.
| - (void) removeAllObjects |
Remove all objects from the Parameters collection.
| - (void) removeValueForKey: | (CCParameterKey) | aKey |
Remove a value for a CCParameterKey.
| akey | CCParameterKey for the value being removed. |
| - (void) setValue: | (NSString *) | value | |
| forKey: | (CCParameterKey) | aKey | |
Set a value for a CCParameterKey.
| value | Value of the parameter. |
| aKey | CCParameterKey for the value. |
| - (NSString *) valueForKey: | (CCParameterKey) | aKey |
Retrieve the value for a CCParameterKey.
| aKey | CCParameterKey for value to retrieve. |
| - (CCParameterKey const) CCParamAccessoryConnectionType |
Parameter key for connection type selected for accessory.
| - (CCParameterKey const) CCParamAccessoryName |
Parameter key for accessory name.
| - (CCParameterKey const) CCParamAcquirerResponseCode |
Parameter key for the acquirer response code.
| - (CCParameterKey const) CCParamAddressVerificationResult |
Parameter key for the address verification result. Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.
| - (CCParameterKey const) CCParamAmount |
Parameters key for the transaction amount.
| - (CCParameterKey const) CCParamAmountOnlineAuthorized |
Parameter key for the amount of a transaction authorized online.
| - (CCParameterKey const) CCParamAmountType |
| - (CCParameterKey const) CCParamApiKey |
Parameter key for setting Api Key used for communicating with the gateway.
| - (CCParameterKey const) CCParamApplicationIdentifier |
Parameter key for setting application identifier.
| - (CCParameterKey const) CCParamApplyFirmwareUpdate |
Parameter key for current device status XML string. XML can be converted into an DeviceStatus object usinglink ChipDnaMobileSerializer::deserializeDeviceStatus}.
| - (CCParameterKey const) CCParamAuthCode |
Parameter key for authorization code of a transaction.
| - (CCParameterKey const) CCParamAutoConfirm |
| - (CCParameterKey const) CCParamAutomaticReboot |
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 or False to delay. Parameter key indicating if the PIN pad reboot is automatic or manual. Values can be TRUE for automatic or False for manual.
| - (CCParameterKey const) CCParamAvailableCardApplications |
Parameter for the card applications XML to be presented to the Cardholder during application selection. The data converted using ChipDnaMobileSerializer#deserializedAvailableCardApplications:
| - (CCParameterKey const) CCParamAvailableCurrencies |
Parameter key for the currencies available XML for the terminal. The data converted using ChipDnaMobileSerializer#deserializedAvailableCurrencies:
| - (CCParameterKey const) CCParamAvailablePinPads |
Parameter key for available PIN pad XML string. XML can be converted into an object using ChipDnaMobileSerializer#deserializeAvailablePinPadsString:
| - (CCParameterKey const) CCParamBillingAddress1 |
Parameter key for Address Line One in Billing Information.
| - (CCParameterKey const) CCParamBillingAddress2 |
Parameter key for Address Line Two in Billing Information.
| - (CCParameterKey const) CCParamBillingCity |
Parameter key for the City in Billing Information.
| - (CCParameterKey const) CCParamBillingCountry |
Parameter key for the Country in Billing Information.
| - (CCParameterKey const) CCParamBillingEmailAddress |
Parameter key for the Email Address in Billing Information.
| - (CCParameterKey const) CCParamBillingPhoneNumber |
Parameter key for the Phone Number in Billing Information.
| - (CCParameterKey const) CCParamBillingPostalCode |
Parameter key for the Zip Code in Billing Information. Can be used interchangeably with BILLING_POSTAL_CODE
| - (CCParameterKey const) CCParamBillingState |
Parameter key for the State in Billing Information
| - (CCParameterKey const) CCParamBillingZipCode |
Parameter key for the Zip Code in Billing Information. Can be used interchangeably with BILLING_ZIP_CODE
| - (CCParameterKey const) CCParamBLEScanTime |
Parameter key for configuring the length of time Bluetooth Low Energy (BLE) devices will be scanned for. The value is required to be a string valued number between 1 and 30. The default value of 5 seconds will be used if this value is not passed into availablePinPadsRequest and connectAndConfigure.
| - (CCParameterKey const) CCParamCardEaseReference |
Parameter key for CardEase reference of a transaction.
| - (CCParameterKey const) CCParamCardHashCollection |
Parameter key for the card hash in XML format. Value can be converted to a CCCardHash object using ChipDnaMobileSerializer#deserializeCardHash:.
| - (CCParameterKey const) CCParamCardHolderFirstName |
Parameter key for the card holder first name.
| - (CCParameterKey const) CCParamCardHolderLastName |
Parameter key for the card holder last name.
| - (CCParameterKey const) CCParamCardReference |
Parameter key for the card reference.
| - (CCParameterKey const) CCParamCardSchemeId |
Parameter key for the card scheme ID.
| - (CCParameterKey const) CCParamCashTransactionsSupported |
Parameter key indicating if cash transactions are supported.
| - (CCParameterKey const) CCParamChangePassword |
Parameter key for changing the password after initialization.
| - (CCParameterKey const) CCParamChequeTransactionsSupported |
Parameter key indicating if cheque transaction are supported.
| - (CCParameterKey const) CCParamChipDnaStatus |
Parameter key for current status of ChipDNA.
| - (CCParameterKey const) CCParamClearIdleMessage |
Parameter key to clear the current status message and return display to default.
| - (CCParameterKey const) CCParamCloseTransaction |
Parameter key indicating whether a transaction should be closed.
| - (CCParameterKey const) CCParamCredentialOnFileFirstStore |
Parameter key to indicate the transaction is the first store for a Credential on File transaction.
| - (CCParameterKey const) CCParamCredentialOnFileReason |
Parameter key for Credential on File transactions to indicate the reason for the transaction. Values can be UNSCHEDULED, INSTALLMENT, INCREMENTAL, RESUBMISSION, DELAYED_CHARGE, RE_AUTH or NO_SHOW.
| - (CCParameterKey const) CCParamCscVerificationResult |
Parameter key for the CSC verification result. Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.
| - (CCParameterKey const) CCParamCurrency |
Parameter key for the currency for a transaction. If only one currency is available ChipDNA Mobile will default to that currency.
| - (CCParameterKey const) CCParamCustomerVaultCommand |
Parameter key for customer vault command
| - (CCParameterKey const) CCParamCustomerVaultId |
Parameter key for customer vault identifier
| - (CCParameterKey const) CCParamDateTimeFormat |
Parameter key for the format of the date/times returned.
| - (CCParameterKey const) CCParamDeferredAuthorizationReason |
Parameter key indicating the reason a deferred authorization is being offered.
| - (CCParameterKey const) CCParamDelayOnlineProcessing |
| - (CCParameterKey const) CCParamDestroy |
Parameter key to wipe all SDK app data and delete the configuration and offline database when value islink CCValueTrue TRUE}.
| - (CCParameterKey const) CCParamDeviceStatus |
Parameter key for DeviceStatus XML which can be converted using ChipDnaMobileSerializer#deserializeDeviceStatus:.
| - (CCParameterKey const) CCParamDeviceStatusUpdate |
Parameter key for updates on the progress of ChipDnaMobile#connectAndConfigure:.
| - (CCParameterKey const) CCParamDigitalSignatureSupported |
| - (CCParameterKey const) CCParamDisplayTime |
Parameter key for the length of time a message should be displayed in seconds. If not present time will be infinite.
| - (CCParameterKey const) CCParamDynamicTippingAmounts |
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”.
| - (CCParameterKey const) CCParamDynamicTippingHeader |
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.
| - (CCParameterKey const) CCParamDynamicTippingPercentages |
Parameter key for on-device dynamic tipping percentages. Value must be three comma-separated numeric values between 0 and 100.
| - (CCParameterKey const) CCParamEmailAddress |
Parameter key for an email address.
| - (CCParameterKey const) CCParamEmailReceiptSupported |
Parameter key indicating if receipting via email is supported.
| - (CCParameterKey const) CCParamEncodedRequest |
Parameter key for the encoded request
| - (CCParameterKey const) CCParamEnvironment |
Parameter key for setting and receive the current environment of ChipDNA Mobile. The value can be production or test.
| - (CCParameterKey const) CCParamErrorDescription |
Parameter key for returning text description of an error.
| - (CCParameterKey const) CCParamErrors |
Parameter key used when returning error codes. Multiple error codes may be returned in a comma separated list.
| - (CCParameterKey const) CCParamExpiryDate |
Parameter key to for the expiry date of a card returned by the PIN pad.
| - (CCParameterKey const) CCParamFirmwareDownloadPercentage |
Parameter key indicating the percentage of firmware downloaded to the device. Value is an integer bewteen 0 and 100.
| - (CCParameterKey const) CCParamFirmwareFile |
Parameter key indicating the name of the firmware file being downloaded to the device.
| - (CCParameterKey const) CCParamFirmwareUpdate |
Parameter key for FirmwareUpdate returned.
| - (CCParameterKey const) CCParamFirmwareUpdateAvailable |
| - (CCParameterKey const) CCParamFirmwareUpdateStatus |
Parameter key for current firmare update status XML string. XML can be converted into an FirmwareUpdateStatus object using ChipDnaMobileSerializer#deserializeFirmwareUpdateStatus.
| - (CCParameterKey const) CCParamForceTmsUpdate |
Parameter key to force a TMS update.
| - (CCParameterKey const) CCParamFullTmsUpdate |
Parameter key to trigger a full TMS update.
| - (CCParameterKey const) CCParamIdleMessage |
Parameter key for the idle message to be displayed.
| - (CCParameterKey const) CCParamLinkedRefundReferences |
Parameter key for the linked refund references linked to the transaction.
| - (CCParameterKey const) CCParamLinkedRefundsSupported |
Parameter key indicating if linked refunds are supported.
| - (CCParameterKey const) CCParamMaskedPan |
Parameter key for a masked PAN.
| - (CCParameterKey const) CCParamMaskedTrack2 |
Parameter key to for the masked track2 of a card returned by the PIN pad.
| - (CCParameterKey const) CCParamMerchantData |
Parameter key for the merchant data.
| - (CCParameterKey const) CCParamMerchantDefinedField01 |
Parameter key for merchant defined field 1.
| - (CCParameterKey const) CCParamMerchantDefinedField02 |
Parameter key for merchant defined field 2.
| - (CCParameterKey const) CCParamMerchantDefinedField03 |
Parameter key for merchant defined field 3.
| - (CCParameterKey const) CCParamMerchantDefinedField04 |
Parameter key for merchant defined field 4.
| - (CCParameterKey const) CCParamMerchantDefinedField05 |
Parameter key for merchant defined field 5.
| - (CCParameterKey const) CCParamMerchantDefinedField06 |
Parameter key for merchant defined field 6.
| - (CCParameterKey const) CCParamMerchantDefinedField07 |
Parameter key for merchant defined field 7.
| - (CCParameterKey const) CCParamMerchantDefinedField08 |
Parameter key for merchant defined field 8.
| - (CCParameterKey const) CCParamMerchantDefinedField09 |
Parameter key for merchant defined field 9.
| - (CCParameterKey const) CCParamMerchantDefinedField10 |
Parameter key for merchant defined field 10.
| - (CCParameterKey const) CCParamMerchantDefinedField11 |
Parameter key for merchant defined field 11.
| - (CCParameterKey const) CCParamMerchantDefinedField12 |
Parameter key for merchant defined field 12.
| - (CCParameterKey const) CCParamMerchantDefinedField13 |
Parameter key for merchant defined field 13.
| - (CCParameterKey const) CCParamMerchantDefinedField14 |
Parameter key for merchant defined field 14.
| - (CCParameterKey const) CCParamMerchantDefinedField15 |
Parameter key for merchant defined field 15.
| - (CCParameterKey const) CCParamMerchantDefinedField16 |
Parameter key for merchant defined field 16.
| - (CCParameterKey const) CCParamMerchantDefinedField17 |
Parameter key for merchant defined field 17.
| - (CCParameterKey const) CCParamMerchantDefinedField18 |
Parameter key for merchant defined field 18.
| - (CCParameterKey const) CCParamMerchantDefinedField19 |
Parameter key for merchant defined field 19.
| - (CCParameterKey const) CCParamMerchantDefinedField20 |
Parameter key for merchant defined field 20.
| - (CCParameterKey const) CCParamMerchantDisplayName |
Parameter key for configured merchant display name. The default name displayed on the PIN pad when it is idle.
| - (CCParameterKey const) CCParamMerchantName |
Parameter key for the merchant name
| - (CCParameterKey const) CCParamOfflineCompletionDateTime |
Parameter for the date and time that an offline request was completed.
| - (CCParameterKey const) CCParamOfflineCompletionState |
Parameter key indicating how a transaction from the offline queue was completed. This can be either CCValueOfflineCompletionStateProcessed or CCValueOfflineCompletionStateDeleted.
| - (CCParameterKey const) CCParamOfflineProcessingSupported |
Parameter key indicating if offline processing is supported.
| - (CCParameterKey const) CCParamOfflineRequestErrors |
Parameter for the errors associated with an offline request.
| - (CCParameterKey const) CCParamOfflineStatus |
Parameter key indicating the offline status of a transaction.
| - (CCParameterKey const) CCParamOnDeviceTippingPrompt |
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 “
” or “\r”. The value accepts UTF-8 characters and cannot be longer than 195 bytes.
| - (CCParameterKey const) CCParamOnlinePinPresent |
Parameter key indicating that an online pin block is present.
| - (CCParameterKey const) CCParamOperatorPin |
Parameter key for the operator pin.
| - (CCParameterKey const) CCParamOperatorPinRequired |
| - (CCParameterKey const) CCParamPANKeyEntry |
| - (CCParameterKey const) CCParamPar |
Parameter key for a PAR.
| - (CCParameterKey const) CCParamPassword |
Parameter key for attempting a password during initialization.
| - (CCParameterKey const) CCParamPaymentMethod |
| - (CCParameterKey const) CCParamPaymentPlatformStatus |
Parameter key for PaymentPlatformStatus XML which can be converted using ChipDnaMobileSerializer#deserializePaymentPlatformStatus:.
| - (CCParameterKey const) CCParamPaymentPlatformTest |
Parameter key used to request the return of a PaymentPlatformStatus object. This will require online connectivity.
| - (CCParameterKey const) CCParamPhoneNumber |
Parameter key for a telephone number.
| - (CCParameterKey const) CCParamPinPadConnectionType |
Parameter key for setting the connection type of the PIN pad to connect to.
| - (CCParameterKey const) CCParamPinPadIpAddress |
Parameter key for setting the IP address of the PIN pad to connect to.
| - (CCParameterKey const) CCParamPinPadName |
Parameter key for setting the PIN pad name of the PIN pad to connect to.
| - (CCParameterKey const) CCParamPinPadPort |
Parameter key for setting the IP port number of the PIN pad to connect to.
| - (CCParameterKey const) CCParamPreformattedCustomerReceipt |
Parameter key for the preformatted customer receipt text.
| - (CCParameterKey const) CCParamPreformattedMerchantReceipt |
Parameter key for the preformatted merchant receipt text.
| - (CCParameterKey const) CCParamPrintReceipt |
Parameter key for requesting that a receipt should be printed from the device if supported.
| - (CCParameterKey const) CCParamPurchaseOrderNumber |
Parameter key for the Purchase Order Number.
| - (CCParameterKey const) CCParamReceiptData |
Parameter key for the transactions receipt data in XML format. Which can be converted to an array of ReceiptFields using ChipDnaMobileSerializer#deserializeReceiptData: method.
| - (CCParameterKey const) CCParamReceiptEmailResult |
| - (CCParameterKey const) CCParamReceiptEmailSubject |
Parameter key for the emails subject field of receipts.
| - (CCParameterKey const) CCParamReceiptPrintResult |
| - (CCParameterKey const) CCParamReceiptSmsResult |
| - (CCParameterKey const) CCParamReceiptSourceEmail |
Parameter key for the receipts source email address.
| - (CCParameterKey const) CCParamReceiptSourceName |
Parameter key for the receipts source name.
| - (CCParameterKey const) CCParamReceiptText |
Parameter key for the receipt text.
| - (CCParameterKey const) CCParamReferralNumber |
Parameter key to for the phone number required for voice referral.
| - (CCParameterKey const) CCParamRefundOperatorPinSupported |
Parameter key indicating if an operator PIN must be supplied in order to perform standalone refunds.
| - (CCParameterKey const) CCParamRemainingAttempts |
Parameter key for remaining attempts for initialization password before SDK app data is destroyed.
| - (CCParameterKey const) CCParamRequestQueueStatus |
Parameter key for RequestQueueStatus XML which can be converted using ChipDnaMobileSerializer#deserializeRequestQueueStatus:.
| - (CCParameterKey const) CCParamResponseRequired |
| - (CCParameterKey const) CCParamResult |
Parameter key for the result value.
| - (CCParameterKey const) CCParamSaleReference |
Parameter key for the user reference of a linked sale transaction.
| - (CCParameterKey const) CCParamSelectedCardApplication |
Parameter for the card application selected by the Cardholder during application selection.
| - (CCParameterKey const) CCParamSendEmailReceipt |
Parameter key for requesting that a receipt should be sent via email.
| - (CCParameterKey const) CCParamSendSmsReceipt |
Parameter key for requesting that a receipt should be send via SMS.
| - (CCParameterKey const) CCParamSignatureData |
Parameter key to supply digital signature data as a base64 string.
| - (CCParameterKey const) CCParamSmsReceiptSupported |
Parameter key indicating if receipting via SMS is supported.
| - (CCParameterKey const) CCParamStandaloneRefundsSupported |
Parameter key indicating if standalone refunds are supported.
| - (CCParameterKey const) CCParamTaxAmount |
Parameter key for the Tax Amount.
| - (CCParameterKey const) CCParamTerminalId |
Parameter key for setting terminal ID.
| - (CCParameterKey const) CCParamTerminalStatus |
Parameter key for TerminalStatus XML which can be converted using ChipDnaMobileSerializer#deserailizeTerminalStatus:.
| - (CCParameterKey const) CCParamTipAmount |
Parameter key for the tip amount.
| - (CCParameterKey const) CCParamTippingSupported |
Parameter key indicating which version of tipping is supported.
| - (CCParameterKey const) CCParamTippingType |
Parameter key for tipping type being used for a transaction. Values can be END_OF_DAY, {link CCParameters::CCValueOnDeviceTipping ON_DEVICE_TIPPING} or BOTH.
| - (CCParameterKey const) CCParamTmsStatus |
Parameter key for TmsStatus XML which can be converted using ChipDnaMobileSerializer#deserializeTmsStatus:.
| - (CCParameterKey const) CCParamTmsUpdateUtc |
Parameter key for date/time of last TMS update time in UTC.
| - (CCParameterKey const) CCParamTrack2ClearText |
Parameter key to for the unencrypted clear text track2 of a card returned by the pinpad.
| - (CCParameterKey const) CCParamTransactionDateTime |
Parameter key for a transactions local date and time.
| - (CCParameterKey const) CCParamTransactionDateTimeUtc |
Parameter key for a transactions UTC date time.
| - (CCParameterKey const) CCParamTransactionHistorySupported |
Parameter key indicating if transaction history information is supported.
| - (CCParameterKey const) CCParamTransactionId |
Parameter key for transaction identifier of a transaction.
| - (CCParameterKey const) CCParamTransactionKey |
Parameter key for setting transaction key.
| - (CCParameterKey const) CCParamTransactionResult |
Parameter key for result of a transaction. Value can be APPROVED, DECLINED or CCParameters#CCValuePartiallyApproved.
| - (CCParameterKey const) CCParamTransactionState |
Parameter key for transaction state. Value can be COMMITTED, UNCOMMITTED, VOID or UNCOMMITTED_VOID.
| - (CCParameterKey const) CCParamTransactionType |
Parameter key for the transaction type. Can be a value of SALE, REFUND or ACCOUNT_VERIFICATION..
| - (CCParameterKey const) CCParamTransactionUpdate |
Parameter key for TransactionUpdate returned;
| - (CCParameterKey const) CCParamUserNotification |
Parameter key for UserNotification returned;
| - (CCParameterKey const) CCParamUserReference |
Parameter key for the user reference. User reference must be unique per transaction.
| - (CCParameterKey const) CCParamVersionInformation |
Parameter key for VersionInformation XML which can be converted using ChipDnaMobileSerializer#deserializeVersionInformation:.
| - (CCParameterKey const) CCParamWebMisPassword |
Parameter key for setting WebMIS password
| - (CCParameterKey const) CCParamWebMisUsername |
Parameter key for setting WebMIS username
| - (CCParameterKey const) CCParamZipCodeVerificationResult |
Parameter key for the zip code verification result. Value can be Matched, NotChecked, NotMatched, NotSupplied or PartialMatch.
1.9.5