Skip to main content

Interface: TransactionPayload

Interface representing transaction payload type

Properties​

airdropId​

• Optional airdropId: string

Build5 id of the airdrop

aliasBlockId​

• Optional aliasBlockId: string

Block id in which the alias was minted

aliasGovAddress​

• Optional aliasGovAddress: string

Governor address of the alias

aliasId​

• Optional aliasId: string

Tanagle id of the alias

aliasOutputAmount​

• Optional aliasOutputAmount: number

Base token amount used by the alias output

aliasStorageDeposit​

• Optional aliasStorageDeposit: number

Storage deposit needed to mint the alias

amount​

• Optional amount: number

Amount used or transfered

auction​

• Optional auction: string

Build5 id of the auction

award​

• Optional award: string

Build5 award id

beneficiary​

• Optional beneficiary: Entity

Beneficiary type of the transaction

beneficiaryAddress​

• Optional beneficiaryAddress: string

Beneficiary address of the transaction

beneficiaryUid​

• Optional beneficiaryUid: string

Beneficiary id of the transaction

chainReference​

• Optional chainReference: string

Tangle chain reference

collection​

• Optional collection: string

Collection id

collectionId​

• Optional collectionId: string

Tangle id of the collection

collectionOutputAmount​

• Optional collectionOutputAmount: number

Base token amount used by the collection output

collectionStorageDeposit​

• Optional collectionStorageDeposit: number

Storage deposit needed to mint the collection

count​

• Optional count: number

Token count set during token trading

creditId​

• Optional creditId: string

Build5 transaction id of a vote

customMetadata​

• Optional customMetadata: Object

Custom metadata that will be is on the output metadata

Index signature​

▪ [key: string]: string

dailyCost​

• Optional dailyCost: number

Daily cost of the stamp

days​

• Optional days: number

Days for which the stamp is stored

dependsOnBillPayment​

• Optional dependsOnBillPayment: boolean

True if credit needs to wait for a bill payment to be processed first

disableWithdraw​

• Optional disableWithdraw: boolean

If true, NFT won't be withdrawn after purchase

edition​

• Optional edition: number

Edition of the badge

expiresOn​

• Optional expiresOn: Timestamp

Order will expire on this date. Once order is expired, it can not receive any more requests.

foundryStorageDeposit​

• Optional foundryStorageDeposit: number

Storage deposit needed to mint the foundry

guardianStorageDeposit​

• Optional guardianStorageDeposit: number

Storage deposit needed for the guardian

invalidPayment​

• Optional invalidPayment: boolean

If true, payment was considered as invalid

legacyAwardFundRequestId​

• Optional legacyAwardFundRequestId: string

Legacy award fund request id

lockCollectionNft​

• Optional lockCollectionNft: boolean

If true, collection NFT witll be locked

metadata​

• Optional metadata: Object

Metadata that will be set on the output

Index signature​

▪ [key: string]: unknown

milestoneTransactionPath​

• Optional milestoneTransactionPath: string

Build5 path to the transaction

nativeTokens​

• Optional nativeTokens: NativeToken[]

Native tokens to transfer

newPrice​

• Optional newPrice: number

New price of unsold NFTs after minting

nft​

• Optional nft: string

NFT id

nftId​

• Optional nftId: string

Tangle id of the nft

nftOrders​

• Optional nftOrders: NftBulkOrder[]

List representing the NFT bulk order

nftOutputAmount​

• Optional nftOutputAmount: number

Base token amount used by the nft output

nfts​

• Optional nfts: string[]

Build5 of the minted NFTs

nftsStorageDeposit​

• Optional nftsStorageDeposit: number

Storage deposit needed to mint the NFTs

nftsToMint​

• Optional nftsToMint: number

NFTs to mint

orderId​

• Optional orderId: string

Order transaction id

outputConsumed​

• Optional outputConsumed: boolean

True if output was consumed

outputConsumedOn​

• Optional outputConsumedOn: Timestamp

Output consumption time

outputToConsume​

• Optional outputToConsume: string

Tangle if of the output that will be consumed

owner​

• Optional owner: string

Current owner

ownerEntity​

• Optional ownerEntity: Entity

Current owner type

participatedOn​

• Optional participatedOn: Timestamp

Participation time

previousOwner​

• Optional previousOwner: string

Previous owner

previousOwnerEntity​

• Optional previousOwnerEntity: Entity

Previous owner type

price​

• Optional price: number

Token price set during token trading

proposalId​

• Optional proposalId: string

Build5 id of the proposal

quantity​

• Optional quantity: number

Quantity of tokens purchased

reason​

• Optional reason: TRADE_CANCELLED

Reason for crediting a payment

reconciled​

• Optional reconciled: boolean

Boolean value specifying if the order was reconciled or not

response​

• Optional response: Object

Transaction response in case of processing failure

Index signature​

▪ [key: string]: unknown

restrictions​

• Optional restrictions: Restrictions

Restrictions applied when purchasing the NFT

royaltiesFee​

• Optional royaltiesFee: number

Royalty fee

royaltiesSpace​

• Optional royaltiesSpace: string

Royalty space

royaltiesSpaceAddress​

• Optional royaltiesSpaceAddress: string

Royalty space address

royalty​

• Optional royalty: boolean

If true, the payment is a royalty payment

sourceAddress​

• Optional sourceAddress: string

Source address of the transaction

sourceTransaction​

• Optional sourceTransaction: string | string[]

A reference to the source order or payment

stake​

• Optional stake: string

Build5 stake id

stakeReward​

• Optional stakeReward: string

Build5 ids of the stake rewards

stakeType​

• Optional stakeType: StakeType

Stake type

stakes​

• Optional stakes: string[]

Build5 ids of the stakes

stamp​

• Optional stamp: string

Build5 if of the stamp

storageDepositSourceAddress​

• Optional storageDepositSourceAddress: string

Address of the source storage deposit

storageReturn​

• Optional storageReturn: StorageReturn

Storage deposit return params

tag​

• Optional tag: string

Tag used on the transaction

tanglePuchase​

• Optional tanglePuchase: boolean

True if the transaction is an OTR

targetAddress​

• Optional targetAddress: string

Target address of the transaction

targetAddresses​

• Optional targetAddresses: SendToManyTargets[]

Target addresses of the transaction incase of multy target transaction

token​

• Optional token: string

Token id

tokenAmount​

• Optional tokenAmount: number

Amount of the token

tokenId​

• Optional tokenId: string

Tangle id of a token

tokenReward​

• Optional tokenReward: number

Build5 id of the token reward

tokenTradeOderTargetAddress​

• Optional tokenTradeOderTargetAddress: string

Target address of the token trade order

tokensInVault​

• Optional tokensInVault: number

Tokens stored in the space's vault

totalAirdropCount​

• Optional totalAirdropCount: number

Total airdrops count

transaction​

• Optional transaction: string

Transaction id

type​

• Optional type: TransactionPayloadType

Type of the payload

unclaimedAirdrops​

• Optional unclaimedAirdrops: number

Unclaimed airdrops count

unlockedBy​

• Optional unlockedBy: string

Member id who unlocked the transaction

unsoldMintingOptions​

• Optional unsoldMintingOptions: UnsoldMintingOptions

Specifies what should happen with unsold NFTs upon minting.

validationType​

• Optional validationType: TransactionValidationType

Specifies the processing type

values​

• Optional values: number[]

Vote values

vaultStorageDeposit​

• Optional vaultStorageDeposit: number

Storage deposit used by the vault

vestingAt​

• Optional vestingAt: Timestamp

Vesting time of the airdrop

void​

• Optional void: boolean

Boolean value specifying if the order was voided

voteValues​

• Optional voteValues: number[]

Vote values

votes​

• Optional votes: number[]

Votes

walletReference​

• Optional walletReference: WalletResult

Result after processing the transaction

weeks​

• Optional weeks: number

Length of the stake in weeks

weight​

• Optional weight: number

Weight of the vote

weightMultiplier​

• Optional weightMultiplier: number

Multiplier for the vote weight