v1 .2024-05-09

Jump to

Ctrl

General Information

Rest APIs

Vaults

Transactions

Addresses

Get Transaction Details

GET

/vaults/{vaultId}/{blockchain}/transactions/{transactionId}

Through this endpoint customers can obtain details about specific transaction.

Path Parameters

blockchain string Required

Represents the specific blockchain, e.g. Bitcoin, Ethereum, Binance Smart Chain, Tron.

transactionId string Required

Reference number for a particular transaction on the blockchain.

vaultId string Required

Represents the specific vault ID.

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.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

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

yourExampleString

data object Required

item object Required

direction string Required

The direction of a transaction, e.g incoming, outgoing, client-internal, vault-internal, internal.

incoming

internalTransfers array Items (object) Optional

Information about internal transfers within a transaction.

fromAddress string Required

The sender's address for the internal transfer.

0xdd06a8b5d79fa90cc4417a66de597eaa97eb141e

operationId string Required

The ID of the operation.

call_0_1_0

operationType string Required

The type of operation being performed within the transaction. It provides information about the nature of the action being executed.

CALL

previousTxHash string Required

The hash of the transaction that occurred immediately before the current transaction within the blockchain.

0xf2c396008015d3331f0ca54247609af92a0b2c442843a69e10965341659d21d4

timestamp integer Required

Time when the transaction was recorded on the blockchain.

1701435851

toAddress string Required

The receiver's address for the internal transfer.

0x267be1c1d684f78cb4f6a176c4911b741e4ffdc0

minedInBlockHeight string Required

Represents the hash of the block where this transaction was mined/confirmed for first time.

1234324

network string Required

The specific network, e.g mainnet, testnet, sepolia, nile.

testnet

recipients array Items (object) Required

Information about recipients.

address string Required

Recipient's address.

mku7JSyfdtKNEQb9J6aegZysX7iPWhWcp7

addressType string Optional

Represents the address type, e.g deposit, smart.

deposit

amount string Required

Amount received.

0.0000546

isVaultAddress string Required

Indicates if the address belongs to the vault (true/false).

true

label string Optional

Label of the address.

Bitcoin address

unitSymbol string Required

Symbol of the unit e.g. BTC, TRX, ETH.

BTC

senders array Items (object) Required

Information about senders.

address string Required

Sender's address.

n1osMwQ7oy8qr2BrmNZ6mfCBjpfZJQGmEU

addressType string Required

Represents the address type, e.g deposit, smart.

deposit

amount string Required

Amount sent.

0.0000546

isVaultAddress string Required

Indicates if the address belongs to the vault.

true

label string Optional

Label of the address.

Bitcoin address

unitSymbol string Required

Symbol of the unit e.g. BTC, TRX, ETH.

BTC

status string Required

Transaction status, e.g. await approval, pending, broadcasted.

confirmed

timestamp integer Required

Defines the specific UNIX time when the transaction was created.

1704881727

tokensTransfers array Items (object) Optional

Information about token transaction, in case it is about token.

amount string Required

Amount of tokens transferred.

50000

contract string Required

Contract address of the token.

TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj

decimals integer Required

The number of decimal places that a token can be divided into.

fromAddress string Required

Sender's address.

TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi

symbol string Required

Symbol of the token, e.g. JST, USDT, USDC.

USDT

toAddress string Required

Receiver's address.

TS1nMMDbKMFCNfdCBmQLiaA5VUdrG31kra

tokenName string Required

Name of the token, e.g. Tether, JUST, USD Coin.

Tether

type string Required

Type of token e.g. TRC-20, BEP-20,

TRC-20

transactionFee object Required

Transaction fee information.

amount string Required

Amount of transaction fee.

5.96124

unitSymbol string Required

Symbol of the unit e.g. BTC, TRX, ETH, BNB.

BTC

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

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

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2024-05-09

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

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

banned_ip_address

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This IP address has been banned. To check the reason for that, please contact our team via email.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Was this page helpful?

Yes

Language

URL

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "direction": "incoming",
            "internalTransfers": [
                {
                    "fromAddress": "0xdd06a8b5d79fa90cc4417a66de597eaa97eb141e",
                    "operationId": "call_0_1_0",
                    "operationType": "CALL",
                    "previousTxHash": "0xf2c396008015d3331f0ca54247609af92a0b2c442843a69e10965341659d21d4",
                    "timestamp": 1701435851,
                    "toAddress": "0x267be1c1d684f78cb4f6a176c4911b741e4ffdc0"
                }
            ],
            "minedInBlockHeight": "1234324",
            "network": "testnet",
            "recipients": [
                {
                    "address": "mku7JSyfdtKNEQb9J6aegZysX7iPWhWcp7",
                    "addressType": "deposit",
                    "amount": "0.0000546",
                    "isVaultAddress": "true",
                    "label": "Bitcoin address",
                    "unitSymbol": "BTC"
                }
            ],
            "senders": [
                {
                    "address": "n1osMwQ7oy8qr2BrmNZ6mfCBjpfZJQGmEU",
                    "addressType": "deposit",
                    "amount": "0.0000546",
                    "isVaultAddress": "true",
                    "label": "Bitcoin address",
                    "unitSymbol": "BTC"
                }
            ],
            "status": "confirmed",
            "timestamp": 1704881727,
            "tokensTransfers": [
                {
                    "amount": "50000",
                    "contract": "TXLAQ63Xg1NAzckPwKHvzw7CSEmLMEqcdj",
                    "decimals": 18,
                    "fromAddress": "TVF2Mp9QY7FEGTnr3DBpFLobA6jguHyMvi",
                    "symbol": "USDT",
                    "toAddress": "TS1nMMDbKMFCNfdCBmQLiaA5VUdrG31kra",
                    "tokenName": "Tether",
                    "type": "TRC-20"
                }
            ],
            "transactionFee": {
                "amount": "5.96124",
                "unitSymbol": "BTC"
            }
        }
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "resource_not_found",
        "message": "The specified resource has not been found.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "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.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "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.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

Get Transaction Details

Path Parameters

Query Parameters

Response Schema

Security schema

URL Schema