Classes

The following classes are available globally.

  • Record containing account details.

    See more

    Declaration

    Objective-C

    @interface ZKAccount : NSObject

    Swift

    class ZKAccount : NSObject
    Show on GitHub

  • Record containing account’s crypto related properties.

    See

    ZKAccount
    See more

    Declaration

    Objective-C

    @interface ZKAccountCryptoProperties : NSObject

    Swift

    class ZKAccountCryptoProperties : NSObject
    Show on GitHub

  • Record containing account data snapshot.

    See more

    Declaration

    Objective-C

    @interface ZKAccountDataSnapshot : NSObject

    Swift

    class ZKAccountDataSnapshot : NSObject
    Show on GitHub

  • Record containing account’s fiat related properties.

    See

    ZKAccount
    See more

    Declaration

    Objective-C

    @interface ZKAccountFiatProperties : NSObject

    Swift

    class ZKAccountFiatProperties : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • Record describing user address details

    See more

    Declaration

    Objective-C

    @interface ZKAddress : NSObject

    Swift

    class ZKAddress : NSObject
    Show on GitHub

  • Record containing Strong Customer Authentication (SCA) config

    See more

    Declaration

    Objective-C

    @interface ZKAuthenticationConfig : NSObject

    Swift

    class ZKAuthenticationConfig : NSObject
    Show on GitHub

  • Record containing basic card details.

    See more

    Declaration

    Objective-C

    @interface ZKCard : NSObject

    Swift

    class ZKCard : NSObject
    Show on GitHub

  • Record containing sensitive card details.

    See more

    Declaration

    Objective-C

    @interface ZKCardDetails : NSObject

    Swift

    class ZKCardDetails : NSObject
    Show on GitHub

  • Card status, for example ‘ACTIVE’.

    See more

    Declaration

    Objective-C

    @interface ZKCardStatus : NSObject

    Swift

    class ZKCardStatus : NSObject
    Show on GitHub

  • Card type, ‘VIRTUAL’ or ‘PHYSICAL’.

    See more

    Declaration

    Objective-C

    @interface ZKCardType : NSObject

    Swift

    class ZKCardType : NSObject
    Show on GitHub

  • Record containing result of the compose exchange method on ZKWallet object.

    See more

    Declaration

    Objective-C

    @interface ZKComposedExchange : NSObject

    Swift

    class ZKComposedExchange : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • Currency code, for example ‘GBP’.

    See more

    Declaration

    Objective-C

    @interface ZKCurrencyCode : NSObject

    Swift

    class ZKCurrencyCode : NSObject
    Show on GitHub

  • Curency type, ‘FIAT’ or ‘CRYPTO’.

    See more

    Declaration

    Objective-C

    @interface ZKCurrencyType : NSObject

    Swift

    class ZKCurrencyType : NSObject
    Show on GitHub

  • Record containing custody order.

    See more

    Declaration

    Objective-C

    @interface ZKCustodyOrder : NSObject

    Swift

    class ZKCustodyOrder : NSObject
    Show on GitHub

  • Custody order status, for example ‘PENDING’.

    See more

    Declaration

    Objective-C

    @interface ZKCustodyOrderStatus : NSObject

    Swift

    class ZKCustodyOrderStatus : NSObject
    Show on GitHub

  • Custody order type, ‘DEPOSIT’ or ‘WITHDRAW’.

    See more

    Declaration

    Objective-C

    @interface ZKCustodyOrderType : NSObject

    Swift

    class ZKCustodyOrderType : NSObject
    Show on GitHub

  • Account custody type, ‘CUSTODY’ or ‘NON-CUSTODY’.

    Only relevant for crypto accounts. Fiat accounts are always of type ‘CUSTODY’.

    See more

    Declaration

    Objective-C

    @interface ZKCustodyType : NSObject

    Swift

    class ZKCustodyType : NSObject
    Show on GitHub

  • Record containing exchange details.

    See more

    Declaration

    Objective-C

    @interface ZKExchange : NSObject

    Swift

    class ZKExchange : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • Exchange side, ‘BUY’ or ‘SELL’.

    See more

    Declaration

    Objective-C

    @interface ZKExchangeSide : NSObject

    Swift

    class ZKExchangeSide : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • Record containing internal transaction details.

    See more

    Declaration

    Objective-C

    @interface ZKInternalTransaction : NSObject

    Swift

    class ZKInternalTransaction : NSObject
    Show on GitHub

  • Record containing Knowledge-Based Authentication (KBA) answer.

    See more

    Declaration

    Objective-C

    @interface ZKKbaAnswer : NSObject

    Swift

    class ZKKbaAnswer : NSObject
    Show on GitHub

  • Record containing Knowledge-Based Authentication (KBA) question

    See more

    Declaration

    Objective-C

    @interface ZKKbaQuestion : NSObject

    Swift

    class ZKKbaQuestion : NSObject
    Show on GitHub

  • Network type, for example ‘MAINNET’.

    See more

    Declaration

    Objective-C

    @interface ZKNetworkType : NSObject

    Swift

    class ZKNetworkType : NSObject
    Show on GitHub

  • Record containing Zumo exchange rate quote used in making exchanges.

    See more

    Declaration

    Objective-C

    @interface ZKQuote : NSObject

    Swift

    class ZKQuote : NSObject
    Show on GitHub

  • Time intervals, for example ‘hour’.

    See more

    Declaration

    Objective-C

    @interface ZKTimeInterval : NSObject

    Swift

    class ZKTimeInterval : NSObject
    Show on GitHub

  • Record containing transaction details.

    See more

    Declaration

    Objective-C

    @interface ZKTransaction : NSObject

    Swift

    class ZKTransaction : NSObject
    Show on GitHub

  • Record containing transaction amount details.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionAmount : NSObject

    Swift

    class ZKTransactionAmount : NSObject
    Show on GitHub

  • Record containing properties associated with a card transaction.

    See

    ZKTransaction
    See more

    Declaration

    Objective-C

    @interface ZKTransactionCardProperties : NSObject

    Swift

    class ZKTransactionCardProperties : NSObject
    Show on GitHub

  • Record containing transaction’s crypto properties.

    See

    ZKTransaction
    See more

    Declaration

    Objective-C

    @interface ZKTransactionCryptoProperties : NSObject

    Swift

    class ZKTransactionCryptoProperties : NSObject
    Show on GitHub

  • Transaction direction, ‘SENT’ or ‘RECEIVED’.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionDirection : NSObject

    Swift

    class ZKTransactionDirection : NSObject
    Show on GitHub

  • Record containing crypto transaction fee rate

    See more

    Declaration

    Objective-C

    @interface ZKTransactionFeeRate : NSObject

    Swift

    class ZKTransactionFeeRate : NSObject
    Show on GitHub

  • Record containing transaction’s fiat properties.

    See

    ZKTransaction
    See more

    Declaration

    Objective-C

    @interface ZKTransactionFiatProperties : NSObject

    Swift

    class ZKTransactionFiatProperties : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • Transaction type, ‘CUSTODY’, ‘CUSTODY-DEPOSIT’, ‘CUSTODY-WITHDRAW’, ‘CRYPTO’, ‘FIAT’, ‘NOMINATED’ or ‘CARD’.

    See more

    Declaration

    Objective-C

    @interface ZKTransactionType : NSObject

    Swift

    class ZKTransactionType : NSObject
    Show on GitHub

  • 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
    Show on GitHub

  • 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
    Show on GitHub

  • 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
    Show on GitHub

  • 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
    Show on GitHub

  • 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
    Show on GitHub

  • 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
    Show on GitHub