v1 .2025-09-23
Jump to
Ctrl
+
/

Create Token Transaction Request

POST
/vaults/{vaultId}/{blockchain}/{network}/token-transaction-requests

Through this endpoint users can make a single token transaction.

To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.
Vaultody will notify the user only when the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification will not be sent if the event does not or cannot occur, or will take long time to occur.

Path Parameters

blockchain string Required

Represents the specific blockchain protocol name.

network string Required

Represents the name of the blockchain network used, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "sepolia" "nile" , "devnet" are test networks.

vaultId string Required

Defines the unique ID of the Vault.

Query Parameters

context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Request Body Schema application/json

context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

data object Required
item object Required
amount string Required

Represents the specific amount of the transaction.

contractAddress string Required

Contract address - for Bitcoin-based should be property id e.g 31 for EVM-based shoud be contract e.g 0xdac17f958d2ee523a2206206994597c13d831ec7.

feePriority string Optional

This is required for all EVM-based blockchains, e.g Ethereum, Binance-Smart-Chain, Optimism, Polygon, Avalanche. This does not apply to Tron and Solana.

fromAddress string Required

Defines the specific source address for the transaction.

maxFee string Optional

The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.

note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

recipientAddress string Required

Defines the specific recipient address for the transaction.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2025-09-23
requestId string Required

Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.

601c1710034ed6d407996b30
context string Optional

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

yourExampleString
data object Required
item object Required
feePriority string Optional

Represents the fee priority of the transaction, whether it is "slow", "standard" or "fast".

slow
note string Optional

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

yourAdditionalInformationhere
recipients array Items (object) Required

Defines the destination for the transaction.

address string Required

Defines the destination address.

0xc6d46aba0c6e2eb6358c4e24804158cc4d847922
amount string Required

Defines the amount sent to the destination address.

0.001
amountUnit string Required

Represents the unit of the tokens amount recieved, e.g. USDT, USDC, JST.

USDC
senders object Required

Defines details about the source, i.e. the sender.

address string Required

Defines the sender's public address.

0x0902a667d6a3f287835e0a4593cae4167384abc6
tokenTypeSpecificData object Required

Represents the specific token data.

contractAddress string Required

Defines the contract address in the blockchain.

0xdac17f958d2ee523a2206206994597c13d831ec7
transactionRequestId string Required

Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which referenceId concern that specific transaction request.

62daacdbc8a7282e9ea01c35
transactionRequestStatus string Required

Defines the status of the transaction, e.g. "created".

created

Callback parameters

walletId string Required

Unique identifier of the wallet associated with the transaction.

685121237d7d1e0007ac1a1d
webhookId string Required

Unique identifier of the webhook that triggered this callback.

68516e9c6620b0a4790ed541
idempotencyKey string Required

A unique key used to prevent duplicate processing of this callback if it's sent more than once.

928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9
apiVersion string Required

The version of the API that this webhook callback conforms.

2025-09-23
data object Required

Contains the event type and all related transaction information.

event string Required

Type of webhook event: TRANSACTION_REQUEST indicates a new transaction request has been created and is pending approval or rejection.

TRANSACTION_REQUEST
item object Required

Contains detailed metadata about the outgoing mined transaction

blockchain string Required

The name of the blockchain where the transaction was executed (e.g., ethereum, solana, tron).

ethereum
network string Required

The specific network of the blockchain, such as mainnet, testnet, sepolia, nile or devnet.

mainnet
requestId string Required

A unique identifier for the original transaction request that initiated this outgoing transaction.

686cd2860ca2f4fd25f77099
transactionType string Required

The type of asset being transferred: COIN, TOKEN, LINKING, SMART_COIN, SMART_TOKEN, FREEZE, UNFREEZE, DELEGATE, UNDELEGATE, WITHDRAW_RESOURCE.

COIN
Was this page helpful?
Yes
No
Powered by
Language
URL

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "feePriority": "slow",
            "note": "yourAdditionalInformationhere",
            "recipients": [
                {
                    "address": "0xc6d46aba0c6e2eb6358c4e24804158cc4d847922",
                    "amount": "0.001",
                    "amountUnit": "USDC"
                }
            ],
            "senders": {
                "address": "0x0902a667d6a3f287835e0a4593cae4167384abc6"
            },
            "tokenTypeSpecificData": {
                "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7"
            },
            "transactionRequestId": "62daacdbc8a7282e9ea01c35",
            "transactionRequestStatus": "created"
        }
    }
}
{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_REQUEST",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN"
        }
    }
}