Classes

The following classes are available globally.

  • Record containing account details.

    See more

    Declaration

    Objective-C

    @interface ZKAccount : NSObject

    Swift

    class ZKAccount : NSObject
  • Record containing account’s crypto related properties.

    See

    ZKAccount
    See more

    Declaration

    Objective-C

    @interface ZKAccountCryptoProperties : NSObject

    Swift

    class ZKAccountCryptoProperties : NSObject
  • Record containing account data snapshot.

    See more

    Declaration

    Objective-C

    @interface ZKAccountDataSnapshot : NSObject

    Swift

    class ZKAccountDataSnapshot : NSObject
  • Record containing account’s fiat related properties.

    See

    ZKAccount
    See more

    Declaration

    Objective-C

    @interface ZKAccountFiatProperties : NSObject

    Swift

    class ZKAccountFiatProperties : NSObject
  • Account type, ‘STANDARD’, ‘COMPATIBILITY’ or ‘SEGWIT’.

    Only relevant for Bitcoin accounts. All other accounts are ‘STANDARD’ account type.

    See more

    Declaration

    Objective-C

    @interface ZKAccountType : NSObject

    Swift

    class ZKAccountType : NSObject
  • Record describing user address details

    See more

    Declaration

    Objective-C

    @interface ZKAddress : NSObject

    Swift

    class ZKAddress : NSObject
  • Record containing basic card details.

    See more

    Declaration

    Objective-C

    @interface ZKCard : NSObject

    Swift

    class ZKCard : NSObject
  • Record containing sensitive card details.

    See more

    Declaration

    Objective-C

    @interface ZKCardDetails : NSObject

    Swift

    class ZKCardDetails : NSObject
  • Card status, for example ‘ACTIVE’.

    See more

    Declaration

    Objective-C

    @interface ZKCardStatus : NSObject

    Swift

    class ZKCardStatus : NSObject
  • Card type, ‘VIRTUAL’ or ‘PHYSICAL’.

    See more

    Declaration

    Objective-C

    @interface ZKCardType : NSObject

    Swift

    class ZKCardType : NSObject
  • Record containing result of the compose exchange method on ZKWallet object.

    See more

    Declaration

    Objective-C

    @interface ZKComposedExchange : NSObject

    Swift

    class ZKComposedExchange : NSObject
  • Record containing result of one of the transaction compose methods on ZKWallet object.

    See

    ZKWallet
    See more

    Declaration

    Objective-C

    @interface ZKComposedTransaction : NSObject

    Swift

    class ZKComposedTransaction : NSObject
  • Currency code, for example ‘GBP’.

    See more

    Declaration

    Objective-C

    @interface ZKCurrencyCode : NSObject

    Swift

    class ZKCurrencyCode : NSObject
  • Curency type, ‘FIAT’ or ‘CRYPTO’.

    See more

    Declaration

    Objective-C

    @interface ZKCurrencyType : NSObject

    Swift

    class ZKCurrencyType : NSObject
  • Record containing exchange details.

    See more

    Declaration

    Objective-C

    @interface ZKExchange : NSObject

    Swift

    class ZKExchange : NSObject
  • Record containing Zumo exchange rates for information purposes only. Can be used to display amounts in local currency to the user.

    See more

    Declaration

    Objective-C

    @interface ZKExchangeRate : NSObject

    Swift

    class ZKExchangeRate : NSObject
  • Record containing Zumo exchange setting used in making exchanges.

    See more

    Declaration

    Objective-C

    @interface ZKExchangeSetting : NSObject

    Swift

    class ZKExchangeSetting : NSObject
  • Exchange status, for example ‘PENDING’.

    Once exchange is submitted it has to be confirmed. Once exchange is confirmed its status will change from pending to confirmed.

    See Make Exchanges guide for details.

    See more

    Declaration

    Objective-C

    @interface ZKExchangeStatus : NSObject

    Swift

    class ZKExchangeStatus : NSObject
  • Network type, for example ‘MAINNET’.

    See more

    Declaration

    Objective-C

    @interface ZKNetworkType : NSObject

    Swift

    class ZKNetworkType : NSObject
  • Record containing Zumo exchange rate quote used in making exchanges.

    See more

    Declaration

    Objective-C

    @interface ZKQuote : NSObject

    Swift

    class ZKQuote : NSObject
  • Time intervals, for example ‘hour’.

    See more

    Declaration

    Objective-C

    @interface ZKTimeInterval : NSObject

    Swift

    class ZKTimeInterval : NSObject
  • Record containing transaction details.

    See more

    Declaration

    Objective-C

    @interface ZKTransaction : NSObject

    Swift

    class ZKTransaction : NSObject
  • Record containing properties associated with a card transaction.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionCardProperties : NSObject

    Swift

    class ZKTransactionCardProperties : NSObject
  • Record containing transaction’s crypto properties.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionCryptoProperties : NSObject

    Swift

    class ZKTransactionCryptoProperties : NSObject
  • Transaction direction, ‘INCOMING’ or ‘OUTGOING’.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionDirection : NSObject

    Swift

    class ZKTransactionDirection : NSObject
  • Record containing crypto transaction fee rate

    See more

    Declaration

    Objective-C

    @interface ZKTransactionFeeRate : NSObject

    Swift

    class ZKTransactionFeeRate : NSObject
  • Record containing transaction’s fiat properties.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionFiatProperties : NSObject

    Swift

    class ZKTransactionFiatProperties : NSObject
  • Transaction status, for example ‘PENDING’.

    Once transaction is submitted it has to be confirmed. This might take variable amount of time depending on the selected fee rate. Once a transaction is confirmed its status will change from pending to confirmed.

    See Send Transactions guide for details.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionStatus : NSObject

    Swift

    class ZKTransactionStatus : NSObject
  • Tracation type, ‘CRYPTO’, ‘EXCHANGE’, ‘FIAT’, ‘NOMINATED’ or ‘CARD’.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionType : NSObject

    Swift

    class ZKTransactionType : NSObject
  • User class provides methods for managing user wallet and accounts.

    User instance can be obtained via getUser method on ZKZumoKit instance.

    See Manage User Wallet, Create Fiat Account and View User Data guides for usage details.

    See more

    Declaration

    Objective-C

    @interface ZKUser : NSObject

    Swift

    class ZKUser : NSObject
  • Utility class providing blockchain related utility methods. Accessed from ZKZumoKit class.

    This class provides mnemonic phrase generation utility and Bitcoin & Ethereum address validation utilities.

    See more

    Declaration

    Objective-C

    @interface ZKUtils : NSObject

    Swift

    class ZKUtils : NSObject
  • User wallet provides methods for transfer and exchange of fiat and cryptocurrency funds. Sending a transaction or making an exchange is a two step process. First a transaction or exchange has to be composed via one of the compose methods, then ZKComposedTransaction or ZKComposedExchange can be submitted.

    User wallet instance can be obtained by creating, unlocking or recovering user wallet via ZKUser instance.

    See more

    Declaration

    Objective-C

    @interface ZKWallet : NSObject

    Swift

    class ZKWallet : NSObject
  • The code of error returned. Some errors that could be handled programmatically (e.g., balance too low) include an error code — a short string with a brief explanation — as a value for code. See Handling Errors for details.

    See more

    Declaration

    Objective-C

    @interface ZKZumoKitErrorCode : NSObject

    Swift

    class ZKZumoKitErrorCode : NSObject
  • The type of error returned. In case of wallet errors, these errors can be safely displayed to the end users. See Handling Errors for details.

    See more

    Declaration

    Objective-C

    @interface ZKZumoKitErrorType : NSObject

    Swift

    class ZKZumoKitErrorType : NSObject
  • Entry point to ZumoKit iOS SDK.

    See Getting Started guide for usage details.

    See more

    Declaration

    Objective-C

    @interface ZumoKit : NSObject

    Swift

    class ZumoKit : NSObject