ZKTransaction Class Reference


                    
                    
                    -initWithId:type:currencyCode:direction:network:status:amount:fee:nonce:senders:recipients:internalTransactions:custodyOrder:cryptoProperties:fiatProperties:cardProperties:exchange:metadata:submittedAt:confirmedAt:timestamp:

Declaration

Objective-C

- (nonnull instancetype)initWithId:(nonnull NSString *)id
                              type:(nonnull NSString *)type
                      currencyCode:(nonnull NSString *)currencyCode
                         direction:(nonnull NSString *)direction
                           network:(nonnull NSString *)network
                            status:(nonnull NSString *)status
                            amount:(nullable NSDecimalNumber *)amount
                               fee:(nullable NSDecimalNumber *)fee
                             nonce:(nullable NSString *)nonce
                           senders:(nonnull NSArray<ZKTransactionAmount *> *)senders
                        recipients:(nonnull NSArray<ZKTransactionAmount *> *)recipients
              internalTransactions:(nonnull NSArray<ZKInternalTransaction *> *)internalTransactions
                      custodyOrder:(nullable ZKCustodyOrder *)custodyOrder
                  cryptoProperties:(nullable ZKTransactionCryptoProperties *)cryptoProperties
                    fiatProperties:(nullable ZKTransactionFiatProperties *)fiatProperties
                    cardProperties:(nullable ZKTransactionCardProperties *)cardProperties
                          exchange:(nullable ZKExchange *)exchange
                          metadata:(nullable NSString *)metadata
                       submittedAt:(nullable NSNumber *)submittedAt
                       confirmedAt:(nullable NSNumber *)confirmedAt
                         timestamp:(int32_t)timestamp;

Swift

init(id: String, type: String, currencyCode: String, direction: String, network: String, status: String, amount: NSDecimalNumber?, fee: NSDecimalNumber?, nonce: String?, senders: [ZKTransactionAmount], recipients: [ZKTransactionAmount], internalTransactions: [ZKInternalTransaction], custodyOrder: ZKCustodyOrder?, cryptoProperties: ZKTransactionCryptoProperties?, fiatProperties: ZKTransactionFiatProperties?, cardProperties: ZKTransactionCardProperties?, exchange: ZKExchange?, metadata: String?, submittedAt: NSNumber?, confirmedAt: NSNumber?, timestamp: Int32)

Show on GitHub


                    
                    
                    +transactionWithId:type:currencyCode:direction:network:status:amount:fee:nonce:senders:recipients:internalTransactions:custodyOrder:cryptoProperties:fiatProperties:cardProperties:exchange:metadata:submittedAt:confirmedAt:timestamp:

Declaration

Objective-C

+ (nonnull instancetype)transactionWithId:(nonnull NSString *)id
                                     type:(nonnull NSString *)type
                             currencyCode:(nonnull NSString *)currencyCode
                                direction:(nonnull NSString *)direction
                                  network:(nonnull NSString *)network
                                   status:(nonnull NSString *)status
                                   amount:(nullable NSDecimalNumber *)amount
                                      fee:(nullable NSDecimalNumber *)fee
                                    nonce:(nullable NSString *)nonce
                                  senders:(nonnull NSArray<ZKTransactionAmount *> *)senders
                               recipients:(nonnull NSArray<ZKTransactionAmount *> *)recipients
                     internalTransactions:(nonnull NSArray<ZKInternalTransaction *> *)internalTransactions
                             custodyOrder:(nullable ZKCustodyOrder *)custodyOrder
                         cryptoProperties:(nullable ZKTransactionCryptoProperties *)cryptoProperties
                           fiatProperties:(nullable ZKTransactionFiatProperties *)fiatProperties
                           cardProperties:(nullable ZKTransactionCardProperties *)cardProperties
                                 exchange:(nullable ZKExchange *)exchange
                                 metadata:(nullable NSString *)metadata
                              submittedAt:(nullable NSNumber *)submittedAt
                              confirmedAt:(nullable NSNumber *)confirmedAt
                                timestamp:(int32_t)timestamp;

Show on GitHub

id

Identifier.

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *id;

Swift

var id: String { get }

Show on GitHub


                    
                    
                    type

Transaction type.

See

ZKTransactionType

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *type;

Swift

var type: String { get }

Show on GitHub


                    
                    
                    currencyCode

Currency code.

See

ZKCurrencyCode

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *currencyCode;

Swift

var currencyCode: String { get }

Show on GitHub


                    
                    
                    direction

Transaction direction relative to ZKAccountDataSnapshot .

See

ZKTransactionDirection

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *direction;

Swift

var direction: String { get }

Show on GitHub


                    
                    
                    network

Network type.

See

ZKNetworkType

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *network;

Swift

var network: String { get }

Show on GitHub


                    
                    
                    status

Transaction status.

See

ZKTransactionStatus

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSString *status;

Swift

var status: String { get }

Show on GitHub


                    
                    
                    amount

Amount in transaction currency or null if transaction is Ethereum contract deploy. Amount is calculated as transaction amount sent - transaction amounts received - change.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSDecimalNumber *amount;

Swift

var amount: NSDecimalNumber? { get }

Show on GitHub

fee

Transaction fee in transaction currency or null, if not yet available.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSDecimalNumber *fee;

Swift

var fee: NSDecimalNumber? { get }

Show on GitHub


                    
                    
                    nonce

Transaction nonce or null. Used to prevent double spend.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSString *nonce;

Swift

var nonce: String? { get }

Show on GitHub


                    
                    
                    senders

Transaction senders.

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSArray<ZKTransactionAmount *> *senders;

Swift

var senders: [ZKTransactionAmount] { get }

Show on GitHub


                    
                    
                    recipients

Transaction recipients.

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSArray<ZKTransactionAmount *> *recipients;

Swift

var recipients: [ZKTransactionAmount] { get }

Show on GitHub


                    
                    
                    internalTransactions

Internal transactions, e.g. ETH contract interaction side effects.

Declaration

Objective-C

@property (nonatomic, readonly, nonnull) NSArray<ZKInternalTransaction *> *internalTransactions;

Swift

var internalTransactions: [ZKInternalTransaction] { get }

Show on GitHub


                    
                    
                    custodyOrder

Custody order properties if it is a transaction associated with a custody order, null otherwise.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) ZKCustodyOrder *custodyOrder;

Swift

var custodyOrder: ZKCustodyOrder? { get }

Show on GitHub


                    
                    
                    cryptoProperties

Crypto properties if it is a crypto transaction, null otherwise.

See

ZKTransactionType

Declaration

Objective-C

@property (nonatomic, readonly, nullable) ZKTransactionCryptoProperties *cryptoProperties;

Swift

var cryptoProperties: ZKTransactionCryptoProperties? { get }

Show on GitHub


                    
                    
                    fiatProperties

Fiat properties if it is a fiat transaction, null otherwise.

See

ZKTransactionType

Declaration

Objective-C

@property (nonatomic, readonly, nullable) ZKTransactionFiatProperties *fiatProperties;

Swift

var fiatProperties: ZKTransactionFiatProperties? { get }

Show on GitHub


                    
                    
                    cardProperties

Card properties if it is a card transaction, null otherwise.

See

ZKTransactionType

Declaration

Objective-C

@property (nonatomic, readonly, nullable) ZKTransactionCardProperties *cardProperties;

Swift

var cardProperties: ZKTransactionCardProperties? { get }

Show on GitHub


                    
                    
                    exchange

Exchange properties if it is a transaction associated with an exchange, null otherwise.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) ZKExchange *exchange;

Swift

var exchange: ZKExchange? { get }

Show on GitHub


                    
                    
                    metadata

Transaction metadata if exists, null otherwise.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSString *metadata;

Swift

var metadata: String? { get }

Show on GitHub


                    
                    
                    submittedAt

Epoch timestamp when transaction was submitted or null for incoming transactions from outside of Zumo ecosystem.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSNumber *submittedAt;

Swift

var submittedAt: NSNumber? { get }

Show on GitHub


                    
                    
                    confirmedAt

Epoch timestamp when transaction was submitted or null if transaction was not confirmed yet.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSNumber *confirmedAt;

Swift

var confirmedAt: NSNumber? { get }

Show on GitHub


                    
                    
                    timestamp

Epoch timestamp, minimum non-null value between submitted at and confirmed at timestamps.

Declaration

Objective-C

@property (nonatomic, readonly) int32_t timestamp;

Swift

var timestamp: Int32 { get }

Show on GitHub