ZKAccount
Objective-C
@interface ZKAccount : NSObject
Swift
class ZKAccount : NSObject
Record containing account details.
-
-initWithId:
currencyType: currencyCode: network: type: custodyType: balance: ledgerBalance: availableBalance: overdraftLimit: hasNominatedAccount: cryptoProperties: fiatProperties: cards: Declaration
Objective-C
- (nonnull instancetype)initWithId:(nonnull NSString *)id currencyType:(nonnull NSString *)currencyType currencyCode:(nonnull NSString *)currencyCode network:(nonnull NSString *)network type:(nonnull NSString *)type custodyType:(nonnull NSString *)custodyType balance:(nonnull NSDecimalNumber *)balance ledgerBalance:(nonnull NSDecimalNumber *)ledgerBalance availableBalance:(nonnull NSDecimalNumber *)availableBalance overdraftLimit:(nonnull NSDecimalNumber *)overdraftLimit hasNominatedAccount:(BOOL)hasNominatedAccount cryptoProperties:(nullable ZKAccountCryptoProperties *)cryptoProperties fiatProperties:(nullable ZKAccountFiatProperties *)fiatProperties cards:(nonnull NSArray<ZKCard *> *)cards;
Swift
init(id: String, currencyType: String, currencyCode: String, network: String, type: String, custodyType: String, balance: NSDecimalNumber, ledgerBalance: NSDecimalNumber, availableBalance: NSDecimalNumber, overdraftLimit: NSDecimalNumber, hasNominatedAccount: Bool, cryptoProperties: ZKAccountCryptoProperties?, fiatProperties: ZKAccountFiatProperties?, cards: [ZKCard])
-
+accountWithId:
currencyType: currencyCode: network: type: custodyType: balance: ledgerBalance: availableBalance: overdraftLimit: hasNominatedAccount: cryptoProperties: fiatProperties: cards: Declaration
Objective-C
+ (nonnull instancetype)accountWithId:(nonnull NSString *)id currencyType:(nonnull NSString *)currencyType currencyCode:(nonnull NSString *)currencyCode network:(nonnull NSString *)network type:(nonnull NSString *)type custodyType:(nonnull NSString *)custodyType balance:(nonnull NSDecimalNumber *)balance ledgerBalance:(nonnull NSDecimalNumber *)ledgerBalance availableBalance:(nonnull NSDecimalNumber *)availableBalance overdraftLimit:(nonnull NSDecimalNumber *)overdraftLimit hasNominatedAccount:(BOOL)hasNominatedAccount cryptoProperties:(nullable ZKAccountCryptoProperties *)cryptoProperties fiatProperties:(nullable ZKAccountFiatProperties *)fiatProperties cards:(nonnull NSArray<ZKCard *> *)cards;
-
Unique account identifier.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *id;
Swift
var id: String { get }
-
Account currency type.
See
ZKCurrencyType
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *currencyType;
Swift
var currencyType: String { get }
-
Account currency code.
See
ZKCurrencyCode
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *currencyCode;
Swift
var currencyCode: String { get }
-
Account network type.
See
ZKNetworkType
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *network;
Swift
var network: String { get }
-
Account type.
See
ZKAccountType
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *type;
Swift
var type: String { get }
-
Custody type.
See
ZKCustodyType
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *custodyType;
Swift
var custodyType: String { get }
-
Account balance.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSDecimalNumber *balance;
Swift
var balance: NSDecimalNumber { get }
-
Account ledger balance.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSDecimalNumber *ledgerBalance;
Swift
var ledgerBalance: NSDecimalNumber { get }
-
Account available balance, i.e. ledger balance minus pending transactions.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSDecimalNumber *availableBalance;
Swift
var availableBalance: NSDecimalNumber { get }
-
Overdraft limit.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSDecimalNumber *overdraftLimit;
Swift
var overdraftLimit: NSDecimalNumber { get }
-
Account has associated nominated account.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL hasNominatedAccount;
Swift
var hasNominatedAccount: Bool { get }
-
Account crypto properties if account is a crypto account, otherwise null.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) ZKAccountCryptoProperties *cryptoProperties;
Swift
var cryptoProperties: ZKAccountCryptoProperties? { get }
-
Account fiat properties if account is a fiat account, otherwise null.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) ZKAccountFiatProperties *fiatProperties;
Swift
var fiatProperties: ZKAccountFiatProperties? { get }