API Reference
Transactions
A transaction moves an asset on a blockchain. You create outgoing transactions; incoming ones are detected automatically and appear in the same list.
Lifecycle (status): PENDING (created, possibly waiting for approvers) → BROADCASTING (signed and sent to the network) → COMPLETED (confirmed on-chain). It can end instead as REJECTED (an approver refused it), CANCELLED, BLOCKCHAINREJECTED (the network refused it), INSUFFICIENTGASFEES (the gas station could not pay the fee), ERROR, or COMPLIANCE_RULE (held by a compliance rule).
Types (type): Incoming, Outgoing, Internal (between two wallets of your vault), Swap, Allowance, TOKEN_DEPLOYMENT, MINT_TOKEN, BURN_TOKEN, NFT_TRANSFER, CONTRACT_CALL and TOKEN_OPERATION.
Creating a transaction only queues it: the response comes back with status PENDING. Follow it with the transaction webhooks (create_transaction, broadcasted_transaction, completed_transaction, …) or by polling Get Transaction Details. Use idempotencyKey so that a retried request never sends the money twice.
Amounts are strings in the asset's normal unit (for example "0.1" ETH). dollarAmount and fiatAmount are the value at creation time.
The data field. Some types carry details in data. For a TOKEN_OPERATION (an operation run through Token Operations), data says exactly what the operation does, so you can rely on it instead of decoding the blockchain transaction:
• data.operation and data.securityToken.id: which operation, on which token.
• data.movements: every token it creates (MINT: to), destroys (BURN: from) or moves (TRANSFER: from and to), with amount in the token's whole units, or nftTokenId for an NFT. Empty when no token moves.
• data.stateChanges: only on freeze operations: FREEZE_ADDRESS, UNFREEZE_ADDRESS, FREEZE_TOKENS or UNFREEZE_TOKENS, with the address (and amount for tokens).
The same data is in the operation's response, in Get Transaction Details, in Get Transactions and in every transaction webhook, and never changes after creation. Treat it as done only when status is COMPLETED; if the transaction ends BLOCKCHAINREJECTED or ERROR, none of it happened. For a TOKEN_OPERATION, amount is null (use movements), asset is the token, senderAddress is the wallet that signed, receiverAddress is the token contract, and fees are in the network's coin (coinSymbol).
Endpoints
POSTCreate TransactionSends an asset from one of your clients' wallets. Choose the source in one of two ways: walletId, or clientId plus assetId. Choose the destination in one of three ways: receiverAddress (any address), receiverClientId plus assetId (another client of the vault), or toMasterWallet: true plus assetId (the vault's master wallet). The transaction is created with status PENDING and may need approvals before it is sent.GETGet Transaction DetailsReturns one transaction of this vault, including its status, fees, addresses, blockchain hash and approvals. For a TOKEN_OPERATION, data says exactly which tokens the operation created, destroyed or moved (see the Token Operation Transaction response).GETGet All TransactionsLists this vault's transactions (incoming and outgoing), newest first by default. Token deployments (TOKEN_DEPLOYMENT) and NFT transfers (NFT_TRANSFER) are not included in this list.
Was this page helpful?