API reference
Vaultody
POST
/vaults/{vaultId}/transaction-requests/single-transfer
Create Single Transfer
Through this endpoint users can make coin and token transaction requests for EVM-based, Tron, and Solana blockchains.
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
vaultId
string
required
Sender's Vault ID.
Query parameters
context
string
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.
Body parameters application/json
context
string
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
e.g. 0.001
Destination amount.
assetId
string
required
e.g. 6523e058a06ebf1322d7dd6e
Unique internal identifier of the blockchain asset involved in the transaction.
feePriority
string
e.g. slow
Fee priority of the transaction - slow, standard, fast. Required for all blockchains except TRON and SOLANA.
slow
standard
fast
fromAddress
string
required
e.g. 0x2d7127f27a2ca399cb3e3217140adc88d1d71f...
Source address for the transaction and it must belong to vault account.
gross
boolean
Optional boolean. When true, the specified amount is gross (fee is deducted from it). Only supported for coin transactions without fee payer. Default is false (net amount).
maxFee
string
e.g. 0.006
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
required
e.g. yourAdditionalInformationhere
Represents an note to add a free text in, explaining or providing additional detail on the transaction request.
toAddress
string
required
e.g. 0xbfe14b26d2680a232499f059d251f2486f32cd...
Destination address for the transaction.
vaultAccountId
string
required
e.g. 6913471c6b2794841dc8fb81
Unique identifier of the Vault Account.
Response
Returns 201 the request has been successful.
apiVersion
string
required
Specifies the version of the API that incorporates this endpoint.
requestId
string
required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
context
string
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
amountUnit
string
required
Indicates the unit in which the transaction amount is expressed.
feePriority
string
Fee priority of the transaction - slow, standard, fast.
slow
standard
fast
gross
boolean
Whether the amount is gross (fee deducted from amount).
maxFee
string
required
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
required
Transaction note with additional details.
recipients
object[]
required
Destination of the transaction.
address
string
required
Address of the destination.
addressTag
integer
Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address.
amount
string
required
Defines the amount sent to the destination address.
amountUnit
string
required
Defines the unit of the received amount for the address, e.g. ETH, XRP, TRX, BNB.
classicAddress
string
Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the destinations address is an x-Address.
convertedAmountToUSD
string
required
Amount calculated in USD
senders
object
required
Defines details about the source, i.e. the sender.
address
string
required
Sender's address.
addressTag
integer
Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.
classicAddress
string
Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.
totalTransactionAmount
string
required
Total amount of the transaction.
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.
transactionRequestStatus
string
required
Defines the status of the transaction, e.g. "created".
created