Enums

The following enums are available globally.

  • Helper enum for ISO8601 Formatted datestrings

  • Year: Year
  • YearMonth: Year and month

    • Date

    Year, month and day

  • DateTime: same as Date including hours and minutes
  • DateTimeSec: same as DateTime including seconds
  • DateTimeMilliSec: same as DateTimeSec including milliseconds

    • See more

    Declaration

    Swift

    public enum ISO8601Format: String

  • Date format enum

    • ISO8601: ISO8601 Date format
    • DotNet: DotNet Date format
    • RSS: RSS Date format
    • AltRSS: AltRSS Date format
    • Custom: Custom Date format
    See more

    Declaration

    Swift

    public enum DateFormat

  • A mirror of the backend error set

    • General_Error: General_Error
    • General_Model_Error: General_Model_Error
    • Unauthorized: Unauthorized
    • Payment_System_Error: Payment_System_Error
    • Payment_Declined: Payment_Declined
    • Payment_Failed: Payment_Failed
    • Transaction_Not_Found: Transaction_Not_Found
    • Validation_Passed: Validation_Passed
    • Uncaught_Error: Uncaught_Error
    • Server_Error: Server_Error
    • Invalid_From_Date: Invalid_From_Date
    • Invalid_To_Date: Invalid_To_Date
    • CantFindWebPayment: CantFindWebPayment
    • General_Error_Simple_Application: General_Error_Simple_Application
    • InvalidApiVersion: InvalidApiVersion
    • MissingApiVersion: MissingApiVersion
    • PreAuthExpired: PreAuthExpired
    • Collection_Original_Transaction_Wrong_Type: Collection_Original_Transaction_Wrong_Type
    • Currency_Must_Equal_Original_Transaction: Currency_Must_Equal_Original_Transaction
    • Cannot_Collect_A_Voided_Transaction: Cannot_Collect_A_Voided_Transaction
    • Collection_Exceeds_PreAuth: Collection_Exceeds_PreAuth
    • Refund_Original_Transaction_Wrong_Type: Refund_Original_Transaction_Wrong_Type
    • Cannot_Refund_A_Voided_Transaction: Cannot_Refund_A_Voided_Transaction
    • Refund_Exceeds_Original_Transaction: Refund_Exceeds_Original_Transaction
    • Void_Original_Transaction_Wrong_Type: Void_Original_Transaction_Wrong_Type
    • Void_Original_Transaction_Is_Already_Void: Void_Original_Transaction_Is_Already_Void
    • Void_Original_Transaction_Has_Been_Collected: Void_Original_Transaction_Has_Been_Collected
    • Void_Original_Transaction_Amount_Not_Equal_To_Preauth: Void_Original_Transaction_Amount_Not_Equal_To_Preauth
    • UnableToAccept: UnableToAccept
    • AccountLocationNotFound: AccountLocationNotFound
    • AccessDeniedToTransaction: AccessDeniedToTransaction
    • NoConsumerForTransaction: NoConsumerForTransaction
    • TransactionNotEnrolledInThreeDSecure: TransactionNotEnrolledInThreeDSecure
    • TransactionAlreadyAuthorizedByThreeDSecure: TransactionAlreadyAuthorizedByThreeDSecure
    • ThreeDSecureNotSuccessful: ThreeDSecureNotSuccessful
    • ApUnableToDecrypt: ApUnableToDecrypt
    • ReferencedTransactionNotFound: ReferencedTransactionNotFound
    • ReferencedTransactionNotSuccessful: ReferencedTransactionNotSuccessful
    • TestCardNotAllowed: TestCardNotAllowed
    • Collection_Not_Valid: Collection_Not_Valid
    • Refund_Original_Transaction_Null: Refund_Original_Transaction_Null
    • Refund_Not_Valid: Refund_Not_Valid
    • Void_Not_Valid: Void_Not_Valid
    • Unknown: Unknown
    • CardTokenInvalid: CardTokenInvalid
    • UnknownPaymentModel: UnknownPaymentModel
    • UnableToRouteTransaction: UnableToRouteTransaction
    • CardTypeNotSupported: CardTypeNotSupported
    • CardCv2Invalid: CardCv2Invalid
    • CardTokenDoesntMatchConsumer: CardTokenDoesntMatchConsumer
    • WebPaymentReferenceInvalid: WebPaymentReferenceInvalid
    • WebPaymentAccountLocationNotFound: WebPaymentAccountLocationNotFound
    • RegisterCardWithWrongTransactionType: RegisterCardWithWrongTransactionType
    • InvalidAmountToRegisterCard: InvalidAmountToRegisterCard
    • ContentTypeNotSpecifiedOrUnsupported: ContentTypeNotSpecifiedOrUnsupported
    • InternalErrorAuthenticating: InternalErrorAuthenticating
    • TransactionNotFound: TransactionNotFound
    • ResourceNotFound: ResourceNotFound
    • LackOfPermissionsUnauthorized: LackOfPermissionsUnauthorized
    • ContentTypeNotSupported: ContentTypeNotSupported
    • AuthenticationFailure: AuthenticationFailure
    • Not_Found: Not_Found
    • MustProcessPreAuthByToken: MustProcessPreAuthByToken
    • ApplicationModelIsNull: ApplicationModelIsNull
    • ApplicationModelRequiresReference: ApplicationModelRequiresReference
    • ApplicationHasAlreadyGoneLive: ApplicationHasAlreadyGoneLive
    • MissingProductSelection: MissingProductSelection
    • AccountNotInSandbox: AccountNotInSandbox
    • ApplicationRecIdRequired: ApplicationRecIdRequired
    • RequestNotProperlyFormatted: RequestNotProperlyFormatted
    • NoApplicationReferenceFound: NoApplicationReferenceFound
    • NotSupportedFileType: NotSupportedFileType
    • ErrorWithFileUpload: ErrorWithFileUpload
    • EmptyApplicationReference: EmptyApplicationReference
    • ApplicationDoesNotExist: ApplicationDoesNotExist
    • UnknownSortSpecified: UnknownSortSpecified
    • PageSizeLessThanOne: PageSizeLessThanOne
    • PageSizeMoreThanFiveHundred: PageSizeMoreThanFiveHundred
    • OffsetLessThanZero: OffsetLessThanZero
    • InvalidMerchantId: InvalidMerchantId
    • MerchantIdNotFound: MerchantIdNotFound
    • NoProductsWereFound: NoProductsWereFound
    • OnlyTheJudoPartnerCanSubmitSimpleApplications: OnlyTheJudoPartnerCanSubmitSimpleApplications
    • UnableToParseDocument: UnableToParseDocument
    • UnableToFindADefaultAccountLocation: UnableToFindADefaultAccountLocation
    • WebpaymentsShouldBeCreatedByPostingToUrl: WebpaymentsShouldBeCreatedByPostingToUrl
    • InvalidMd: InvalidMd
    • InvalidReceiptId: InvalidReceiptId
    • ParameterError: ParameterError
    • ResponseParseError: ResponseParseError
    • LuhnValidationError: LuhnValidationError
    • JudoIDInvalidError: JudoIDInvalidError
    • SerializationError: SerializationError
    • RequestError: RequestError
    • TokenSecretError: TokenSecretError
    • AmountMissingError: AmountMissingError
    • CardAndTokenError: CardAndTokenError
    • CardOrTokenMissingError: CardOrTokenMissingError
    • PKPaymentMissingError: PKPaymentMissingError
    • JailbrokenDeviceDisallowedError: JailbrokenDeviceDisallowedError
    • InvalidOperationError: InvalidOperationError
    • DuplicateTransactionError: DuplicateTransactionError
    • CurrencyNotSupportedError: CurrencyNotSupportedError
    • LocationServicesDisabled: LocationServicesDisabled
    • CardLengthMismatchError: CardLengthMismatchError
    • InputLengthMismatchError: InputLengthMismatchError
    • InvalidCardNumber: InvalidCardNumber
    • InvalidEntry: InvalidEntry
    • InvalidCardNetwork: InvalidCardNetwork
    • InvalidPostCodeError: InvalidPostCodeError
    • ThreeDSAuthRequest: ThreeDSAuthRequest
    • Failed3DSError: Failed3DSError
    • UnknownError: UnknownError
    • UserDidCancel: UserDidCancel
    See more

    Declaration

    Swift

    public enum JudoErrorCode: Int

  • The DateTextField allows two different modes of input.

    • Picker: Use a custom UIPickerView with month and year fields
    • Text: Use a common Numpad Keyboard as text input method
    See more

    Declaration

    Swift

    public enum DateInputType

  • Mirror of the judo API Error category

    • Unknown: Unknown Error Cateogry
    • RequestError: Request Error Category
    • ModelError: Model Error Category
    • ConfigError: Config Error Category
    • ProcessingError: Processing Error Category
    • ExceptionError: Exception Error Category
    See more

    Declaration

    Swift

    public enum JudoErrorCategory: Int

  • Type of Transaction

    • Payment: A Payment Transaction
    • PreAuth: A Pre-auth Transaction
    • Refund: A Refund Transaction
    • RegisterCard: Register a Card
    • Collection: A Pre-Auth Collection
    • VOID: A Pre-Auth Void
    See more

    Declaration

    Swift

    public enum TransactionType: String

  • Result of a Transaction

    • Success: Successful transaction
    • Declined: Declined transaction
    • Error: Something went wrong
    See more

    Declaration

    Swift

    public enum TransactionResult: String

  • Card Logo Type enum

    • Visa: Visa card logo
    • MasterCard: MasterCard card logo
    • AMEX: AMEX card logo
    • Maestro: Maestro card logo
    • CID: CID logo
    • CVC: CVC logo
    • Unknown: Unknown placeholder logo
    See more

    Declaration

    Swift

    public enum CardLogoType

  • BillingCountry

    BillingCountry enum to simplify identifying a billing country for a given card

    See more

    Declaration

    Swift

    public enum BillingCountry: Int

  • A Mirror of the backend error set

    • JudoId_Not_Supplied: JudoId_Not_Supplied description
    • JudoId_Not_Supplied_1: JudoId_Not_Supplied_1 description
    • JudoId_Not_Valid: JudoId_Not_Valid description
    • JudoId_Not_Valid_1: JudoId_Not_Valid_1 description
    • Amount_Greater_Than_0: Amount_Greater_Than_0 description
    • Amount_Not_Valid: Amount_Not_Valid description
    • Amount_Two_Decimal_Places: Amount_Two_Decimal_Places description
    • Amount_Between_0_And_5000: Amount_Between_0_And_5000 description
    • Partner_Service_Fee_Not_Valid: Partner_Service_Fee_Not_Valid description
    • Partner_Service_Fee_Between_0_And_5000: Partner_Service_Fee_Between_0_And_5000 description
    • Consumer_Reference_Not_Supplied: Consumer_Reference_Not_Supplied description
    • Consumer_Reference_Not_Supplied_1: Consumer_Reference_Not_Supplied_1 description
    • Consumer_Reference_Length: Consumer_Reference_Length description
    • Consumer_Reference_Length_1: Consumer_Reference_Length_1 description
    • Consumer_Reference_Length_2: Consumer_Reference_Length_2 description
    • Payment_Reference_Not_Supplied: Payment_Reference_Not_Supplied description
    • Payment_Reference_Not_Supplied_1: Payment_Reference_Not_Supplied_1 description
    • Payment_Reference_Not_Supplied_2: Payment_Reference_Not_Supplied_2 description
    • Payment_Reference_Not_Supplied_3: Payment_Reference_Not_Supplied_3 description
    • Payment_Reference_Length: Payment_Reference_Length description
    • Payment_Reference_Length_1: Payment_Reference_Length_1 description
    • Payment_Reference_Length_2: Payment_Reference_Length_2 description
    • Payment_Reference_Length_3: Payment_Reference_Length_3 description
    • Payment_Reference_Length_4: Payment_Reference_Length_4 description
    • Currency_Required: Currency_Required description
    • Currency_Length: Currency_Length description
    • Currency_Not_Supported: Currency_Not_Supported description
    • Device_Category_Unknown: Device_Category_Unknown description
    • Card_Number_Not_Supplied: Card_Number_Not_Supplied description
    • Test_Cards_Only_In_Sandbox: Test_Cards_Only_In_Sandbox description
    • Card_Number_Invalid: Card_Number_Invalid description
    • Three_Digit_CV2_Not_Supplied: Three_Digit_CV2_Not_Supplied description
    • Four_Digit_CV2_Not_Supplied: Four_Digit_CV2_Not_Supplied description
    • CV2_Not_Valid: CV2_Not_Valid description
    • CV2_Not_Valid_1: CV2_Not_Valid_1 description
    • Start_Date_Or_Issue_Number_Must_Be_Supplied: Start_Date_Or_Issue_Number_Must_Be_Supplied description
    • Start_Date_Not_Supplied: Start_Date_Not_Supplied description
    • Start_Date_Wrong_Length: Start_Date_Wrong_Length description
    • Start_Date_Not_Valid: Start_Date_Not_Valid description
    • Start_Date_Not_Valid_Format: Start_Date_Not_Valid_Format description
    • Start_Date_Too_Far_In_Past: Start_Date_Too_Far_In_Past description
    • Start_Date_Month_Outside_Expected_Range: Start_Date_Month_Outside_Expected_Range description
    • Issue_Number_Outside_Expected_Range: Issue_Number_Outside_Expected_Range description
    • Expiry_Date_Not_Supplied: Expiry_Date_Not_Supplied description
    • Expiry_Date_Wrong_Length: Expiry_Date_Wrong_Length description
    • Expiry_Date_Not_Valid: Expiry_Date_Not_Valid description
    • Expiry_Date_In_Past: Expiry_Date_In_Past description
    • Expiry_Date_Too_Far_In_Future: Expiry_Date_Too_Far_In_Future description
    • Expiry_Date_Month_Outside_Expected_Range: Expiry_Date_Month_Outside_Expected_Range description
    • Postcode_Not_Valid: Postcode_Not_Valid description
    • Postcode_Not_Supplied: Postcode_Not_Supplied description
    • Postcode_Is_Invalid: Postcode_Is_Invalid description
    • Card_Token_Not_Supplied: Card_Token_Not_Supplied description
    • Card_Token_Original_Transaction_Failed: Card_Token_Original_Transaction_Failed description
    • ThreeDSecure_PaRes_Not_Supplied: ThreeDSecure_PaRes_Not_Supplied description
    • ReceiptId_Not_Supplied: ReceiptId_Not_Supplied description
    • ReceiptId_Is_Invalid: ReceiptId_Is_Invalid description
    • Transaction_Type_In_Url_Invalid: Transaction_Type_In_Url_Invalid description
    • Partner_Application_Reference_Not_Supplied: Partner_Application_Reference_Not_Supplied description
    • Partner_Application_Reference_Not_Supplied_1: Partner_Application_Reference_Not_Supplied_1 description
    • Type_Of_Company_Not_Supplied: Type_Of_Company_Not_Supplied description
    • Type_Of_Company_Unknown: Type_Of_Company_Unknown description
    • Principle_Not_Supplied: Principle_Not_Supplied description
    • Principle_Salutation_Unknown: Principle_Salutation_Unknown description
    • Principle_First_Name_Not_Supplied: Principle_First_Name_Not_Supplied description
    • Principle_First_Name_Length: Principle_First_Name_Length description
    • Principle_First_Name_Not_Supplied_1: Principle_First_Name_Not_Supplied_1 description
    • Principle_Last_Name_Not_Supplied: Principle_Last_Name_Not_Supplied description
    • Principle_Last_Name_Length: Principle_Last_Name_Length description
    • Principle_Last_Name_Not_Supplied_1: Principle_Last_Name_Not_Supplied_1 description
    • Principle_Email_Or_Mobile_Not_Supplied: Principle_Email_Or_Mobile_Not_Supplied description
    • Principle_Email_Address_Not_supplied: Principle_Email_Address_Not_supplied description
    • Principle_Email_Address_Length: Principle_Email_Address_Length description
    • Principle_Email_Address_Not_Valid: Principle_Email_Address_Not_Valid description
    • Principle_Email_Address_Domain_Not_Valid: Principle_Email_Address_Domain_Not_Valid description
    • Principle_Mobile_Or_Email_Not_Supplied: Principle_Mobile_Or_Email_Not_Supplied description
    • Principle_Mobile_Number_Not_Valid: Principle_Mobile_Number_Not_Valid description
    • Principle_Mobile_Number_Not_Valid_1: Principle_Mobile_Number_Not_Valid_1 description
    • Principle_Mobile_Number_Length: Principle_Mobile_Number_Length description
    • Principle_Home_Phone_Not_Valid: Principle_Home_Phone_Not_Valid description
    • Principle_Date_Of_Birth_Not_Supplied: Principle_Date_Of_Birth_Not_Supplied description
    • Principle_Date_Of_Birth_Not_Valid: Principle_Date_Of_Birth_Not_Valid description
    • Principle_Date_Of_Birth_Age: Principle_Date_Of_Birth_Age description
    • Location_Trading_Name_Not_Supplied: Location_Trading_Name_Not_Supplied description
    • Location_Partner_Reference_Not_Supplied: Location_Partner_Reference_Not_Supplied description
    • Location_Partner_Reference_Not_Supplied_1: Location_Partner_Reference_Not_Supplied_1 description
    • Location_Partner_Reference_Length: Location_Partner_Reference_Length description
    • First_Name_Not_supplied: First_Name_Not_supplied description
    • First_Name_Length: First_Name_Length description
    • Last_Name_Not_Supplied: Last_Name_Not_Supplied description
    • Last_Name_Length: Last_Name_Length description
    • Email_Address_Not_Supplied: Email_Address_Not_Supplied description
    • Email_Address_Length: Email_Address_Length description
    • Email_Address_Not_Valid: Email_Address_Not_Valid description
    • Email_Address_Domain_Not_Valid: Email_Address_Domain_Not_Valid description
    • Schedule_Start_Date_Not_Supplied: Schedule_Start_Date_Not_Supplied description
    • Schedule_Start_Date_Format_Not_Valid: Schedule_Start_Date_Format_Not_Valid description
    • Schedule_End_Date_Not_Supplied: Schedule_End_Date_Not_Supplied description
    • Schedule_End_Date_Format_Not_Valid: Schedule_End_Date_Format_Not_Valid description
    • Schedule_End_Date_Must_Be_Greater_Than_Start_Date: Schedule_End_Date_Must_Be_Greater_Than_Start_Date description
    • Schedule_Repeat_Not_Supplied: Schedule_Repeat_Not_Supplied description
    • Schedule_Repeat_Must_Be_Greater_Than_1: Schedule_Repeat_Must_Be_Greater_Than_1 description
    • Schedule_Interval_Not_Valid: Schedule_Interval_Not_Valid description
    • Schedule_Interval_Must_Be_Minimum_5: Schedule_Interval_Must_Be_Minimum_5 description
    • ItemsPerPage_Not_Supplied: ItemsPerPage_Not_Supplied description
    • ItemsPerPage_Out_Of_Range: ItemsPerPage_Out_Of_Range description
    • PageNumber_Not_Supplied: PageNumber_Not_Supplied description
    • PageNumber_Out_Of_Range: PageNumber_Out_Of_Range description
    • Legal_Name_Not_Supplied: Legal_Name_Not_Supplied description
    • Company_Number_Not_Supplied: Company_Number_Not_Supplied description
    • Company_Number_Wrong_Length: Company_Number_Wrong_Length description
    • Current_Address_Not_Supplied: Current_Address_Not_Supplied description
    • Building_Number_Or_Name_Not_Supplied: Building_Number_Or_Name_Not_Supplied description
    • Building_Number_Or_Name_Length: Building_Number_Or_Name_Length description
    • Address_Line1_Not_Supplied: Address_Line1_Not_Supplied description
    • Address_Line1_Length: Address_Line1_Length description
    • SortCode_Not_Supplied: SortCode_Not_Supplied description
    • SortCode_Not_Valid: SortCode_Not_Valid description
    • Account_Number_Not_Supplied: Account_Number_Not_Supplied description
    • Account_number_Not_Valid: Account_number_Not_Valid description
    • Location_Turnover_Greater_Than_0: Location_Turnover_Greater_Than_0 description
    • Average_Transaction_Value_Not_Supplied: Average_Transaction_Value_Not_Supplied description
    • Average_Transaction_Value_Greater_Than_0: Average_Transaction_Value_Greater_Than_0 description
    • Average_Transaction_Value_Greater_Than_Turnover: Average_Transaction_Value_Greater_Than_Turnover description
    • MccCode_Not_Supplied: MccCode_Not_Supplied description
    • MccCode_Unknown: MccCode_Unknown description
    • Generic_Is_Invalid: Generic_Is_Invalid description
    • Generic_Html_Invalid: Generic_Html_Invalid description
    See more

    Declaration

    Swift

    public enum JudoModelErrorCode: Int

Card.Configurations Protocol extensions

  • The CardNetwork enum depicts the Card Network type of a given Card object

    • Visa: Visa Card Network
    • MasterCard: MasterCard Network
    • AMEX: American Express Card Network
    • DinersClub: Diners Club Network
    • Maestro: Maestro Card Network
    • ChinaUnionPay: China UnionPay Network
    • Discover: Discover Network
    • InterPayment: InterPayment Network
    • InstaPayment: InstaPayment Network
    • JCB: JCB Network
    • Dankort: Dankort Network
    • UATP: UATP Network
    • Unknown: Unknown
    See more

    Declaration

    Swift

    public enum CardNetwork: Int64

  • The CardType enum is a value type for CardNetwork to further identify card types

    • Debit: Debit Card type
    • Credit: Credit Card type
    • Unknown: Unknown Card type
    See more

    Declaration

    Swift

    public enum CardType: Int

Pagination

  • Enum to identify sorting direction

    • Descending: Descended Sorting
    • Ascending: Ascended Sorting
    See more

    Declaration

    Swift

    public enum Sort: String