v1.0
API reference Vaultody
GET /transaction-requests/{transactionRequestId}

Get Transaction Request Details

Through this endpoint customers can obtain details on transaction request.

This regards transaction requests, which is not to be confused with transactions. Transaction requests may not be approved due to any reason, hence a transaction may not occur.

Path parameters

transactionRequestId string required
Represents the unique ID of the transaction request.

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.

Response

Returns 200 the request has been successful.

apiVersion string required
Specifies the version of the API that incorporates this endpoint.
E.G. 2026-03-20
requestId string required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
E.G. 601c1710034ed6d407996b30
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.
E.G. yourExampleString
data object required
item object required
amountUnit string required
Defines the unit of the amount.
E.G. XRP
blockchain string required
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
bitcoin bitcoin-cash litecoin dogecoin dash ethereum ethereum-classic xrp zcash binance-smart-chain tron polygon +5
E.G. xrp
feePriority string required
Defines the priority for the fee, if it is "slow", "standard" or "fast".
slow standard fast
E.G. standard
network string required
Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "sepolia" are test networks.
mainnet testnet mordor nile sepolia amoy fuji devnet
E.G. testnet
note string required
Defines an optional note for additional details.
E.G. yourNoteHere
recipients object[] required
Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.
address string required
The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.
E.G. X7bdiEzggt3mxRsWjBDQzSAECWtbDupj52vyutnSKygG...
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 Classic Address.
E.G. 12325
amount string required
Represents the amount received to this address.
E.G. 0.001
amountUnit string required
Defines the unit of the amount.
E.G. XRP
classicAddress string
Represents the public address, which is a compressed and shortened form of a public key. A classic address is shown when the destination address is an x-Address.
E.G. rs7AT2SUBbikJe9VHcAwnCYgBEgMQhsKj1
senders object
Defines details about the source, i.e. the sender.
address string required
Sender's address.
E.G. XVNPsfTQ215p431tYGzrpzNpkXPq1JaYbNHuNRFf2A7a...
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.
E.G. 123
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.
E.G. rNkyDE3npdL2A3P5hYDqYaLAmtjSd3mKdo
totalTransactionAmount string required
Defines the total transaction amount.
E.G. 0.001
transactionId string required
Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.
E.G. 3VsoZeG1n5G7CnNz5GPXnMPuYcWCdi4VPMsDdNuoZcuD...
transactionRequestStatus string required
Defines the status of the transaction request, e.g. await-approval, pending-signing, broadcasted, failed, rejected, mined.
created await-approval pending prepared signed broadcasted success failed rejected mined mined-with-errors await-approval-l2 +1
E.G. created
transactionType string required
Defines the transaction type, if it is for coin, token, freeze, unfreeze, withdraw-resource, delegate, undelegate, batch.
coin token
E.G. coin
vaultAccountId string required
The ID of the vault account from which funds are sent.
E.G. 6936c7e88097040007891abe
vaultId string required
Defines the unique ID of the Vault.
E.G. 60c9d9921c38030006675ff6

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json
401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json
403 Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. application/json
409 The data provided seems to be invalid. application/json
415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json
422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json
429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json
500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json

No matches.