ChipDna Mobile
Loading...
Searching...
No Matches
Modules | Classes | Variables
ChipDnaMobileError

Modules

 ConfigurationError
 
 PaymentDeviceError
 
 TransactionError
 

Classes

class  ErrorCodes
 

Variables

NSString *const JailbrokenDevice
 
NSString *const UnableToOpenURL
 
NSString *const UnableToSpecifyCommunicationProtocol
 
NSString *const UnableToSendRequest
 
NSString *const UnableToGetHttpResponseCode
 
NSString *const UnsuccessfulHttpRequest
 
NSString *const UnableToReadResponse
 
NSString *const UnableToRetrieveResponse
 
NSString *const UnableToWriteRequestXml
 
NSString *const UnableToParseResponseXml
 
NSString *const UnableToReadResponseXml
 
NSString *const ErrorParsingResponseXml
 
NSString *const ResponseXmlNotFound
 
NSString *const EmptyPropertySet
 
NSString *const ErrorParsingPropertyXML
 
NSString *const SpecifiedUrlMalformed
 
NSString *const CardEaseTerminalId
 
NSString *const TransactionKey
 
NSString *const PinpadNotPaired
 
NSString *const PrinterNotPaired
 
NSString *const WebMISUsername
 
NSString *const WebMISPassword
 
NSString *const ApiKey
 
NSString *const AmbiguousIdentifier
 
NSString *const RegistrationFailed
 
NSString *const RegistrationFailedToRetrieveTerminalId
 
NSString *const RegistrationFailedToRetrieveTransactionKey
 
NSString *const MerchantConfigurationError
 
NSString *const MissingField
 
NSString *const InvalidField
 
NSString *const InvalidHTTPMethod
 
NSString *const AccessDenied
 
NSString *const DeviceConfiguration
 
NSString *const UnexpectedField
 
NSString *const DataTypeError
 
NSString *const ParseError
 
NSString *const ServerError
 
NSString *const GeneralError
 
NSString *const GatewayGeneralError
 
NSString *const GatewayProcessError
 
NSString *const ParameterMissing
 
NSString *const ParameterValueInvalid
 
NSString *const UserReferenceMissing
 
NSString *const InvalidUserReference
 
NSString *const OperatorPinMissing
 
NSString *const InvalidOperatorPin
 
NSString *const InvalidPaymentMethod
 
NSString *const TransactionTypeMissing
 
NSString *const InvalidTransactionType
 
NSString *const TippingTypeInvalid
 
NSString *const OnDeviceTippingPromptInvalid
 
NSString *const OnDeviceTippingPromptNotSupported
 
NSString *const DynamicTippingNotSupported
 
NSString *const DynamicTippingAmountsAndPercentagesNotSupported
 
NSString *const DynamicTippingValueInvalid
 
NSString *const DynamicTippingHeaderInvalid
 
NSString *const InvalidAuthCode
 
NSString *const AuthCodeMissing
 
NSString *const PhoneNumberMissing
 
NSString *const InvalidPhoneNumber
 
NSString *const EmailAddressMissing
 
NSString *const InvalidEmailAddress
 
NSString *const SourceNameMissing
 
NSString *const SourceEmailMissing
 
NSString *const InvalidSourceEmail
 
NSString *const ReceiptTextMissing
 
NSString *const InvalidReceiptType
 
NSString *const ReceiptSubjectMissing
 
NSString *const DisplayTextMissing
 
NSString *const SaleReferenceMissing
 
NSString *const InvalidPinPadName
 
NSString *const InvalidConnectionType
 
NSString *const InvalidPinPadIpAddress
 
NSString *const InvalidPinPadPort
 
NSString *const PinPadNameMismatch
 
NSString *const UnsupportedPaymentDevice
 
NSString *const FailedToCreate
 
NSString *const FailedToOpen
 
NSString *const FailedToRead
 
NSString *const FailedToWrite
 
NSString *const FailedToClose
 
NSString *const FailedToUpgrade
 
NSString *const FailedToMigrate
 
NSString *const FailedToChangePassword
 
NSString *const IncorrectPassword
 
NSString *const ProvidedSignatureUnsupportedFormat
 
NSString *const ProvidedSignatureInvalidFormat
 
NSString *const ProvidedSignatureOnlyContainsWhiteSpace
 
NSString *const ProvidedSignatureTooSmall
 
NSString *const CroppedSignatureTooSmall
 
NSString *const ResizedSignatureTooSmall
 
NSString *const SignatureDataMissing
 
NSString *const ReceiptSourceSMSNotSupported
 
NSString *const ReceiptSourceEmailNotSupported
 
NSString *const ProcessReceiptNotSupported
 
NSString *const SOAPError
 
NSString *const InvalidTimeZoneOffset
 
NSString *const LogOnDenied
 
NSString *const LogOnManuallyDisabled
 
NSString *const LogOnAutomaticallyDisabled
 
NSString *const LogOnLocked
 
NSString *const InvalidLoginPlatform
 
NSString *const DataNotAvailable
 
NSString *const UnexpectedChipDnaError
 
NSString *const BLEScanTimeValueInvalid
 
NSString *const CustomTippingPromptWithoutAmountConfirmationNotAllowed
 

Detailed Description

The possible error codes that can be returned for a ChipDnaMobie Error type.

Variable Documentation

◆ AccessDenied

NSString* const AccessDenied
extern

Access to the gateway has been denied.

◆ AmbiguousIdentifier

NSString* const AmbiguousIdentifier
extern

An attempt to set more than one identifier has been made.

◆ ApiKey

NSString* const ApiKey
extern

There is a format error with the Api Key.

◆ AuthCodeMissing

NSString* const AuthCodeMissing
extern

Authorization code parameter missing.

◆ BLEScanTimeValueInvalid

NSString* const BLEScanTimeValueInvalid
extern

BLEScanTime is invalid.

◆ CardEaseTerminalId

NSString* const CardEaseTerminalId
extern

There is a format error with the CardEase Terminal ID.

◆ CroppedSignatureTooSmall

NSString* const CroppedSignatureTooSmall
extern

The signature is too small after cropping out white space.

◆ CustomTippingPromptWithoutAmountConfirmationNotAllowed

NSString* const CustomTippingPromptWithoutAmountConfirmationNotAllowed
extern

A custom on-device tipping prompt without amount confirmation is not supported..

◆ DataNotAvailable

NSString* const DataNotAvailable
extern

The request did not return any results. This might be because there are no results for the given data range or because the provided data does not generate any results (for example, incorrect guid for retrieving transaction details).

◆ DataTypeError

NSString* const DataTypeError
extern

An incorrect data type has been used.

◆ DeviceConfiguration

NSString* const DeviceConfiguration
extern

The configuration on the device is incorrect.

◆ DisplayTextMissing

NSString* const DisplayTextMissing
extern

The text to display cannot be nil.

◆ DynamicTippingAmountsAndPercentagesNotSupported

NSString* const DynamicTippingAmountsAndPercentagesNotSupported
extern

Dynamic tipping amounts and dynamic tipping percentages cannot be supplied together.

◆ DynamicTippingHeaderInvalid

NSString* const DynamicTippingHeaderInvalid
extern

The dynamic tipping header value is invalid.

◆ DynamicTippingNotSupported

NSString* const DynamicTippingNotSupported
extern

Dynamic tipping is not supported.

◆ DynamicTippingValueInvalid

NSString* const DynamicTippingValueInvalid
extern

The dynamic tipping value is invalid.

◆ EmailAddressMissing

NSString* const EmailAddressMissing
extern

Email address is missing.

◆ EmptyPropertySet

NSString* const EmptyPropertySet
extern

No properties returned by TMS.

◆ ErrorParsingPropertyXML

NSString* const ErrorParsingPropertyXML
extern

Error parsing properties in Property element in response XML.

◆ ErrorParsingResponseXml

NSString* const ErrorParsingResponseXml
extern

Error parsing response XML.

◆ FailedToChangePassword

NSString* const FailedToChangePassword
extern

Unable to change database password.

◆ FailedToClose

NSString* const FailedToClose
extern

Unable to close the database on mobile device storage.

◆ FailedToCreate

NSString* const FailedToCreate
extern

Unable to create a database on the mobile device.

◆ FailedToMigrate

NSString* const FailedToMigrate
extern

Unable to migrate the database on mobile device storage.

◆ FailedToOpen

NSString* const FailedToOpen
extern

Unable to open the database on mobile device storage.

◆ FailedToRead

NSString* const FailedToRead
extern

Unable to read from database on the mobile device storage.

◆ FailedToUpgrade

NSString* const FailedToUpgrade
extern

Unable to upgrade the database on the mobile device.

◆ FailedToWrite

NSString* const FailedToWrite
extern

Unable to write to the database on mobile device storage.

◆ GatewayGeneralError

NSString* const GatewayGeneralError
extern

There has been a general error with the gateway.

◆ GatewayProcessError

NSString* const GatewayProcessError
extern

There has been a process error with the gateway.

◆ GeneralError

NSString* const GeneralError
extern

There has been a general error with the gateway.

◆ IncorrectPassword

NSString *const IncorrectPassword
extern

The password given was incorrect.

The password entered was incorrect.

◆ InvalidAuthCode

NSString* const InvalidAuthCode
extern

Invalid authorization code parameter value.

◆ InvalidConnectionType

NSString* const InvalidConnectionType
extern

Invalid connection type value.

◆ InvalidEmailAddress

NSString* const InvalidEmailAddress
extern

Invalid emails address parameter value.

◆ InvalidField

NSString* const InvalidField
extern

Field within the request is invalid.

◆ InvalidHTTPMethod

NSString* const InvalidHTTPMethod
extern

Invalid HTTP method.

◆ InvalidLoginPlatform

NSString* const InvalidLoginPlatform
extern

The invalid login platform is used.

◆ InvalidOperatorPin

NSString* const InvalidOperatorPin
extern

Operator pin entered wasn't valid. Must be a 4 numeric characters long.

◆ InvalidPaymentMethod

NSString* const InvalidPaymentMethod
extern

Invalid payment method parameter value.

◆ InvalidPhoneNumber

NSString* const InvalidPhoneNumber
extern

Invalid phone number parameter value.

◆ InvalidPinPadIpAddress

NSString* const InvalidPinPadIpAddress
extern

Invalid PIN pad IP address value.

◆ InvalidPinPadName

NSString* const InvalidPinPadName
extern

Invalid PIN pad name value.

◆ InvalidPinPadPort

NSString* const InvalidPinPadPort
extern

Invalid PIN pad port value.

◆ InvalidReceiptType

NSString* const InvalidReceiptType
extern

The receipt type is invalid.

◆ InvalidSourceEmail

NSString* const InvalidSourceEmail
extern

Source email address is invalid.

◆ InvalidTimeZoneOffset

NSString* const InvalidTimeZoneOffset
extern

The time zone offset is invalid.

◆ InvalidTransactionType

NSString* const InvalidTransactionType
extern

Invalid transaction type parameter value.

◆ InvalidUserReference

NSString* const InvalidUserReference
extern

User reference entered wasn't valid. Must be a unique per transaction and between 1 and 50 characters long.

◆ JailbrokenDevice

NSString* const JailbrokenDevice
extern

The device appears to be jailbroken.

◆ LogOnAutomaticallyDisabled

NSString* const LogOnAutomaticallyDisabled
extern

Log on is automatically disabled.

◆ LogOnDenied

NSString* const LogOnDenied
extern

Log on is denied.

◆ LogOnLocked

NSString* const LogOnLocked
extern

Log on is locked.

◆ LogOnManuallyDisabled

NSString* const LogOnManuallyDisabled
extern

Log on is manually disabled.

◆ MerchantConfigurationError

NSString* const MerchantConfigurationError
extern

Merchant's configuration is incorrect.

◆ MissingField

NSString* const MissingField
extern

Request is missing a required field.

◆ OnDeviceTippingPromptInvalid

NSString* const OnDeviceTippingPromptInvalid
extern

The on-device tipping prompt is invalid.

◆ OnDeviceTippingPromptNotSupported

NSString* const OnDeviceTippingPromptNotSupported
extern

A custom on-device tipping prompt is not supported.

◆ OperatorPinMissing

NSString* const OperatorPinMissing
extern

Operator pin required and not found.

◆ ParameterMissing

NSString* const ParameterMissing
extern

A required parameter is missing.

◆ ParameterValueInvalid

NSString* const ParameterValueInvalid
extern

The value of a parameter is invalid.

◆ ParseError

NSString* const ParseError
extern

Failed to parse the request.

◆ PhoneNumberMissing

NSString* const PhoneNumberMissing
extern

Phone number parameter is missing.

◆ PinPadNameMismatch

NSString* const PinPadNameMismatch
extern

Configured PIN pad name does not match that of the connected PIN pad.

◆ PinpadNotPaired

NSString* const PinpadNotPaired
extern

The selected PIN pad is not paired.

◆ PrinterNotPaired

NSString* const PrinterNotPaired
extern

The selected Printer is not paired.

◆ ProcessReceiptNotSupported

NSString* const ProcessReceiptNotSupported
extern

Receipt processing is not supported.

◆ ProvidedSignatureInvalidFormat

NSString* const ProvidedSignatureInvalidFormat
extern

The signature format in invalid.

◆ ProvidedSignatureOnlyContainsWhiteSpace

NSString* const ProvidedSignatureOnlyContainsWhiteSpace
extern

The signature only contains white space.

◆ ProvidedSignatureTooSmall

NSString* const ProvidedSignatureTooSmall
extern

The signature is too small.

◆ ProvidedSignatureUnsupportedFormat

NSString* const ProvidedSignatureUnsupportedFormat
extern

The signature format is unsupported.

◆ ReceiptSourceEmailNotSupported

NSString* const ReceiptSourceEmailNotSupported
extern

Email receipting is not supported.

◆ ReceiptSourceSMSNotSupported

NSString* const ReceiptSourceSMSNotSupported
extern

SMS receipting is not supported.

◆ ReceiptSubjectMissing

NSString* const ReceiptSubjectMissing
extern

The receipt subject text is missing.

◆ ReceiptTextMissing

NSString* const ReceiptTextMissing
extern

Receipt text is missing.

◆ RegistrationFailed

NSString* const RegistrationFailed
extern

The registration request has failed.

◆ RegistrationFailedToRetrieveTerminalId

NSString* const RegistrationFailedToRetrieveTerminalId
extern

Registration failed to retrieve a terminal ID.

◆ RegistrationFailedToRetrieveTransactionKey

NSString* const RegistrationFailedToRetrieveTransactionKey
extern

Registration failed to retrieve a transaction key.

◆ ResizedSignatureTooSmall

NSString* const ResizedSignatureTooSmall
extern

The signature is too small after cropping out white space and resizing.

◆ ResponseXmlNotFound

NSString* const ResponseXmlNotFound
extern

Response XML not found.

◆ SaleReferenceMissing

NSString* const SaleReferenceMissing
extern

The sale reference is missing.

◆ ServerError

NSString* const ServerError
extern

There has been an error with the server.

◆ SignatureDataMissing

NSString* const SignatureDataMissing
extern

Signature data is missing.

◆ SOAPError

NSString* const SOAPError
extern

The SOAP error occurred.

◆ SourceEmailMissing

NSString* const SourceEmailMissing
extern

Source email address is missing.

◆ SourceNameMissing

NSString* const SourceNameMissing
extern

Source name is missing.

◆ SpecifiedUrlMalformed

NSString* const SpecifiedUrlMalformed
extern

Specified URL is malformed.

◆ TippingTypeInvalid

NSString* const TippingTypeInvalid
extern

Invalid tipping type parameter value.

◆ TransactionKey

NSString* const TransactionKey
extern

There is a format error with the Transaction Key.

◆ TransactionTypeMissing

NSString* const TransactionTypeMissing
extern

Transaction type parameter method missing.

◆ UnableToGetHttpResponseCode

NSString* const UnableToGetHttpResponseCode
extern

Unable to retrieve HTTP response code.

◆ UnableToOpenURL

NSString* const UnableToOpenURL
extern

Unable to open the specified URL.

◆ UnableToParseResponseXml

NSString* const UnableToParseResponseXml
extern

Unable to parse response XML.

◆ UnableToReadResponse

NSString* const UnableToReadResponse
extern

Unable to read HTTP response data.

◆ UnableToReadResponseXml

NSString* const UnableToReadResponseXml
extern

Unable to read HTTP response data.

◆ UnableToRetrieveResponse

NSString* const UnableToRetrieveResponse
extern

Unable to retrieve server response.

◆ UnableToSendRequest

NSString* const UnableToSendRequest
extern

Unable to send request.

◆ UnableToSpecifyCommunicationProtocol

NSString* const UnableToSpecifyCommunicationProtocol
extern

Unable to specify communication protocol.

◆ UnableToWriteRequestXml

NSString* const UnableToWriteRequestXml
extern

Unable to write request XML.

◆ UnexpectedChipDnaError

NSString* const UnexpectedChipDnaError
extern

ChipDNA encountered an unexpected error.

◆ UnexpectedField

NSString* const UnexpectedField
extern

There was an unexpected field within the request.

◆ UnsuccessfulHttpRequest

NSString* const UnsuccessfulHttpRequest
extern

The response to the HTTP request was not equal to 200(OK).

◆ UnsupportedPaymentDevice

NSString* const UnsupportedPaymentDevice
extern

The device model is not supported by ChipDNA.

◆ UserReferenceMissing

NSString* const UserReferenceMissing
extern

No user reference found.

◆ WebMISPassword

NSString* const WebMISPassword
extern

There is a format error with the Test WebMIS Password.

◆ WebMISUsername

NSString* const WebMISUsername
extern

There is a format error with the WebMIS Username.