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.
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
Defines the unit of the amount.
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
feePriority
string
required
Defines the priority for the fee, if it is "slow", "standard" or "fast".
slow
standard
fast
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
note
string
required
Defines an optional note for additional details.
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.
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.
amount
string
required
Represents the amount received to this address.
amountUnit
string
required
Defines the unit of the amount.
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.
senders
object
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
Defines the total transaction amount.
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.
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
transactionType
string
required
Defines the transaction type, if it is for coin, token, freeze, unfreeze, withdraw-resource, delegate, undelegate, batch.
coin
token
vaultAccountId
string
required
The ID of the vault account from which funds are sent.
vaultId
string
required
Defines the unique ID of the Vault.