ZKCustodyOrder
Objective-C
@interface ZKCustodyOrder : NSObject
Swift
class ZKCustodyOrder : NSObject
Record containing custody order.
-
-initWithId:
type: status: amount: feeInAmount: estimatedFees: fees: fromAddresses: fromAccountId: fromUserId: fromUserIntegratorId: toAddress: toAccountId: toUserId: toUserIntegratorId: createdAt: updatedAt: Declaration
Objective-C
- (nonnull instancetype)initWithId:(nonnull NSString *)id type:(nonnull NSString *)type status:(nonnull NSString *)status amount:(nullable NSDecimalNumber *)amount feeInAmount:(BOOL)feeInAmount estimatedFees:(nullable NSDecimalNumber *)estimatedFees fees:(nullable NSDecimalNumber *)fees fromAddresses:(nullable NSArray<NSString *> *)fromAddresses fromAccountId:(nullable NSString *)fromAccountId fromUserId:(nullable NSString *)fromUserId fromUserIntegratorId:(nullable NSString *)fromUserIntegratorId toAddress:(nullable NSString *)toAddress toAccountId:(nullable NSString *)toAccountId toUserId:(nullable NSString *)toUserId toUserIntegratorId:(nullable NSString *)toUserIntegratorId createdAt:(int32_t)createdAt updatedAt:(int32_t)updatedAt;
Swift
init(id: String, type: String, status: String, amount: NSDecimalNumber?, feeInAmount: Bool, estimatedFees: NSDecimalNumber?, fees: NSDecimalNumber?, fromAddresses: [String]?, fromAccountId: String?, fromUserId: String?, fromUserIntegratorId: String?, toAddress: String?, toAccountId: String?, toUserId: String?, toUserIntegratorId: String?, createdAt: Int32, updatedAt: Int32)
-
+custodyOrderWithId:
type: status: amount: feeInAmount: estimatedFees: fees: fromAddresses: fromAccountId: fromUserId: fromUserIntegratorId: toAddress: toAccountId: toUserId: toUserIntegratorId: createdAt: updatedAt: Declaration
Objective-C
+ (nonnull instancetype)custodyOrderWithId:(nonnull NSString *)id type:(nonnull NSString *)type status:(nonnull NSString *)status amount:(nullable NSDecimalNumber *)amount feeInAmount:(BOOL)feeInAmount estimatedFees:(nullable NSDecimalNumber *)estimatedFees fees:(nullable NSDecimalNumber *)fees fromAddresses:(nullable NSArray<NSString *> *)fromAddresses fromAccountId:(nullable NSString *)fromAccountId fromUserId:(nullable NSString *)fromUserId fromUserIntegratorId:(nullable NSString *)fromUserIntegratorId toAddress:(nullable NSString *)toAddress toAccountId:(nullable NSString *)toAccountId toUserId:(nullable NSString *)toUserId toUserIntegratorId:(nullable NSString *)toUserIntegratorId createdAt:(int32_t)createdAt updatedAt:(int32_t)updatedAt;
-
Identifier.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *id;
Swift
var id: String { get }
-
Custody order type.
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *type;
Swift
var type: String { get }
-
Transaction status.
See
ZKCustodyOrder
Declaration
Objective-C
@property (nonatomic, readonly, nonnull) NSString *status;
Swift
var status: String { get }
-
Custody order amount, null if not known yet.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDecimalNumber *amount;
Swift
var amount: NSDecimalNumber? { get }
-
Flag indicating if fees are included in order amount.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL feeInAmount;
Swift
var feeInAmount: Bool { get }
-
Estimated custody order fees.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDecimalNumber *estimatedFees;
Swift
var estimatedFees: NSDecimalNumber? { get }
-
Actual custody order fees, null if not known yet.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSDecimalNumber *fees;
Swift
var fees: NSDecimalNumber? { get }
-
Crypto addresses from which funds where received, if any.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSArray<NSString *> *fromAddresses;
Swift
var fromAddresses: [String]? { get }
-
Debit
ZKAccount
identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *fromAccountId;
Swift
var fromAccountId: String? { get }
-
Debit
ZKAccount's
user identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *fromUserId;
Swift
var fromUserId: String? { get }
-
Debit
ZKAccount's
user integrator identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *fromUserIntegratorId;
Swift
var fromUserIntegratorId: String? { get }
-
Destination crypto address, if applicable.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *toAddress;
Swift
var toAddress: String? { get }
-
Credit
ZKAccount
identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *toAccountId;
Swift
var toAccountId: String? { get }
-
Credit
ZKAccount's
user identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *toUserId;
Swift
var toUserId: String? { get }
-
Credit
ZKAccount's
user integrator identifier, if applicable.Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *toUserIntegratorId;
Swift
var toUserIntegratorId: String? { get }
-
Epoch timestamp when custody order was created.
Declaration
Objective-C
@property (nonatomic, readonly) int32_t createdAt;
Swift
var createdAt: Int32 { get }
-
Epoch timestamp when custody order was updated.
Declaration
Objective-C
@property (nonatomic, readonly) int32_t updatedAt;
Swift
var updatedAt: Int32 { get }