v1 .2025-09-23

Jump to

Ctrl

General Information

Rest APIs

Vaults

Transactions Fee

Estimate Approximate Transaction Fee

POST

Transactions

Addresses

Tron Resource Management

POST

/vaults/{vaultId}/{blockchain}/{network}/addresses/{fromAddress}/manage-resource

Through this endpoint, users can manage TRX staking: freezing, unfreezing, and withdrawing TRX. Stake an amount of TRX to obtain bandwidth or energy and optimize blockchain resource usage. Additionally, users can delegate bandwidth or energy resources to other accounts for efficient transaction processing.

There are several types of transactions available through this endpoint. Users must choose the appropriate transaction type when performing an operation.

Path Parameters

blockchain string Required

Specifies the blockchain network involved in the transaction (eg. tron).

fromAddress string Required

Represents the originating address from which the transaction is initiated.

network string Required

Specifies the network used (eg. mainnet , nile).

vaultId string Required

Represents the sender's specific and unique Vault ID of the sender.

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

data object Required

item object Required

amount string Optional

The amount field specifies the amount of TRX to freeze, unfreeze, delegate, or undelegate. For these four request types, the amount field is required. When the request type is withdraw-resource, the amount field is not required, as the entire withdrawable amount will be withdrawn.

lock string Optional

Boolean if we want to lock the delegated amount. Whether to lock the resource delegation, true means locked the delegation, the delegating cannot be canceled within the period specified by lockPeriod, false means non-locked, the resource delegating can be canceled at any time.

lockPeriod string Optional

Only when lock is true, this field is valid. If the delegate lock period is 1 day, the lock_period is: 28800. The minimum value of lockPeriod is the remaining lock period of this type of resource that was delegated last time, and the maximum value is 864000 (30 days). If lock is true and lock_period is not set or set to 0, lockPeriod will be set to the default value 86400 (3 days) automatically.

note string Optional

Transaction note with additional details.

resource string Required

Resource staking for (e.g. Bandwidth, Energy).

toAddress string Optional

Address receiving the delegated amount or from which we undelegate. It is used when type of the request is delegate/undelagate.

type string Required

Type of the transaction: freeze - lock a specified amount of TRX to obtain either bandwidth or energy; unfreeze - release previously frozen TRX and to be withdrawn; withdraw-resource - claim TRX and return it to the user’s available balance; delegate - assign obtained bandwidth or energy resources to another Tron account; undelegate - revoke previously delegated bandwidth or energy from another account, restoring control of those resources to the original owner.

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

yourExampleString

data object Required

item object Required

blockchain string Required

Specifies the blockchain network involved in the transaction (eg. tron).

tron

destination array Items (object) Required

Destination of the transaction

address string Required

Address of the destination that will receive the resources.

TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4

amount string Required

The amount of TRX involved in the staking action.

amountUnit string Required

The unit of currency used in the transaction.

TRX

id string Required

A unique identifier for the transaction.

67a336950ca2f4fd25fb0deb

network string Required

Specifies the network used (eg. mainnet, nile).

mainnet

resource string Required

Specifies the type of the resource being managed(eg. bandwidth, energy).

energy

source object Required

Details about the sender

address string Required

The address of the sender.

TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4

status string Required

Defines the status of the transaction request, (e.g. created).

created

type string Required

The type of staking operation being performed (eg. freeze, unfreeze, withdraw-resource)

freeze

vaultId string Required

Identifies the vault id linked to the transaction.

66d9b73a9f455b085ed9de39

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

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

code string Required

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

limit_greater_than_allowed

message string Required

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

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 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

code string Required

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

invalid_pagination

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 pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.

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.

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

yourExampleString

error object Required

code string Required

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

missing_api_key

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 specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.

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

code string Required

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

invalid_api_key

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 provided API key is invalid. Please, generate a new one from your Dashboard.

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.

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

yourExampleString

error object Required

insufficient_credits

code string Required

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

insufficient_credits

message string Required

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

You have insufficient credits. Please upgrade your plan from your Dashboard or 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

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

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

code string Required

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

endpoint_not_allowed_for_plan

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 endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.

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

code string Required

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

endpoint_not_allowed_for_api_key

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 endpoint is not available for your API key.

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

code string Required

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

feature_mainnets_not_allowed_for_plan

message string Required

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

Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.

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

code string Required

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

insufficient_frozen_amount

message string Required

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

Address: {address} has insufficient frozen balance ({frozenBalance}TRX) for resource ({resource}) to unfreeze.

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

code string Required

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

maximum_unfreeze_operations_reached

message string Required

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

Address: {address} has reached its maximum unfreeze operations.

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

code string Required

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

no_withdrawable_balance

message string Required

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

Address: {address} doesn't have any balance to withdraw.

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

code string Required

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

delegated_resources_locked

message string Required

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

Delegation lock period has not expired yet for resources of type: {resource} for address: {toAddress}. Expiry times for the resources: {expireTimes}

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.

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

yourExampleString

error object Required

resource_not_found

code string Required

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

resource_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 resource has not been found.

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.

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

yourExampleString

error object Required

code string Required

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

invalid_data

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 data provided seems to be invalid.

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

code string Required

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

wallet_as_a_service_wallet_balance_not_enough

message string Required

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

Your wallet balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.

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

code string Required

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

wallet_as_a_service_address_balance_not_enough

message string Required

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

Your address balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.

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

code string Required

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

callback_url_not_verified

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 Callback URL has not been verified. Please, verify the URL from within your Dashboard 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.

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

yourExampleString

error object Required

unsupported_media_type

code string Required

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

unsupported_media_type

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 selected Media Type is unavailable. The Content-Type header should be 'application/json'.

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.

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

yourExampleString

error object Required

invalid_request_body_structure

code string Required

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

invalid_request_body_structure

message string Required

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

Your request body for POST requests must have a structure of { data: { item: [...properties] } }

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.

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

yourExampleString

error object Required

request_limit_reached

code string Required

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

request_limit_reached

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 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 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.

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

yourExampleString

error object Required

unexpected_server_error

code string Required

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

unexpected_server_error

message string Required

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

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 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

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

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

The type of event: TRANSACTION_APPROVED means the transaction has met the required number of approvals and is now eligible to be broadcast to the blockchain.

TRANSACTION_APPROVED

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

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

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

The event type - TRANSACTION_REJECTED indicates that the transaction was rejected.

TRANSACTION_REJECTED

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

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

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

The name of the event that triggered the webhook. TRANSACTION_BROADCASTED indicates the transaction has been broadcast to the blockchain network, but not yet mined

TRANSACTION_BROADCASTED

item object Required

Contains detailed information about the transaction that was broadcast.

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

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

transactionId string Required

Blockchain-specific transaction hash identifying the mined transaction.

37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623

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 event that triggered the webhook. OUTGOING_MINED means an outgoing transaction from the wallet has been mined.

OUTGOING_MINED

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

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

transactionId string Required

Blockchain-specific transaction hash identifying the mined transaction.

37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623

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

Name of the webhook event - OUTGOING_MINED_WITH_ERRORS, meaning the transaction was mined but did not succeed.

OUTGOING_MINED_WITH_ERRORS

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 or TOKEN.

COIN

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

failedReason string Required

A short explanation of why the transaction failed despite being mined.

Failure

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

Event type: OUTGOING_FAILED indicates that an attempted outgoing transaction has failed.

OUTGOING_FAILED

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

requiredApprovals integer Required

Number of required approvals for this transaction to proceed.

requiredRejections integer Required

Number of rejections needed to cancel the transaction.

currentApprovals integer Required

Current number of approvals received for the transaction.

currentRejections integer Required

Current number of rejections received for the transaction.

failedReason string Required

Reason code indicating why the transaction failed.

INSUFFICIENT_FUNDS

Was this page helpful?

Yes

Language

URL

               {
    "context": "yourExampleString",
    "data": {
        "item": {
            "amount": "3",
            "lock": "true",
            "lockPeriod": "28800",
            "note": "Your note",
            "resource": "bandwidth",
            "toAddress": "TJgba7p9nFz6vMgVBJUxTaRR8WbpaG6ifi",
            "type": "freeze"
        }
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "blockchain": "tron",
            "destination": [
                {
                    "address": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4",
                    "amount": "3",
                    "amountUnit": "TRX"
                }
            ],
            "id": "67a336950ca2f4fd25fb0deb",
            "network": "mainnet",
            "resource": "energy",
            "source": {
                "address": "TMLmaAS4GfshG6PfToD5YYRm5G8giauYc4"
            },
            "status": "created",
            "type": "freeze",
            "vaultId": "66d9b73a9f455b085ed9de39"
        }
    }
}

{
    "apiVersion": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_frozen_amount",
        "message": "Address: {address} has insufficient frozen balance ({frozenBalance}TRX) for resource ({resource}) to unfreeze.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "maximum_unfreeze_operations_reached",
        "message": "Address: {address} has reached its maximum unfreeze operations.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "no_withdrawable_balance",
        "message": "Address: {address} doesn't have any balance to withdraw.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "delegated_resources_locked",
        "message": "Delegation lock period has not expired yet for resources of type: {resource} for address: {toAddress}. Expiry times for the resources: {expireTimes}",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_wallet_balance_not_enough",
        "message": "Your wallet balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_address_balance_not_enough",
        "message": "Your address balance is insufficient to complete this action. Please check for any pending transaction requests or add more funds.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "callback_url_not_verified",
        "message": "The Callback URL has not been verified. Please, verify the URL from within your Dashboard and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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": "2025-09-23",
    "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"
            }
        ]
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_REQUEST",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_APPROVED",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_REJECTED",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 0,
            "currentRejections": 1
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_BROADCASTED",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0,
            "transactionId": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "OUTGOING_MINED",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0,
            "transactionId": "37c2e0696bd86df5010bafa1a4c22ce1b070a8c32126b421ededa0e4efb50623"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "OUTGOING_MINED_WITH_ERRORS",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0,
            "failedReason": "Failure"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "OUTGOING_FAILED",
        "item": {
            "blockchain": "ethereum",
            "network": "mainnet",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0,
            "failedReason": "INSUFFICIENT_FUNDS"
        }
    }
}

Tron Resource Management

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Callback parameters

Security schema

URL Schema

Request