v2 .2026-03-20

Jump to

Ctrl

General Information

Rest APIs

Create UTXO transfer

POST

/vaults/{vaultId}/transaction-requests/utxo-transfer

Creates a UTXO transaction request on supported blockchains (Bitcoin, Litecoin, Dogecoin, Bitcoin Cash, Dash, Zcash) with explicit input selection. The user specifies which UTXOs to spend by ID, bypassing the automatic UTXO selection used by the standard transfer flow. Inputs may span multiple vault accounts within the same vault. An optional feePayer address can be designated to contribute an input and receive the change output. The server reserves the specified UTXOs, builds the transaction, and returns the transaction request in CREATED status. The request then proceeds through the standard governance and signing pipeline.

Path Parameters

vaultId string Required

Unique identifier of the vault.

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

assetId string Required

Unique internal identifier of the blockchain asset involved in the transaction (UTXO-based blockchains only).

changeData object Optional

An optional object that specifies where the transaction's change output should be sent — that is, the leftover balance after the recipient amounts and the network fee have been deducted from the spent UTXOs. Mutually exclusive with feePayer.

address string Optional

A specific destination address for the change output. When provided, the server uses this address as-is and no new address is derived.

vaultAccountId string Optional

When provided, the server selects or derives a change address inside the specified vault account. The vault account must belong to the same vault as the transaction.

feePayer string Optional

Fee payer address — must belong to the vault and be on the same chain as the senders. Mutually exclusive with changeData and gross.

feePriority string Required

Fee priority: slow, standard, or fast.

gross boolean Optional

Whether the recipient amounts are gross (fee deducted from them). Mutually exclusive with fee payer.

maxFee string Optional

Maximum fee the caller is willing to pay. The transaction fails with MAX_FEE_EXCEEDED if exceeded.

note string Required

Short human-readable description to the transaction request (max 250 characters).

recipients array Items (object) Required

Destinations for the transaction. Transfer recipients (1 to 150).

address string Required

Recipient address.

amount string Required

Recipient amount.

senders array Items (object) Required

UTXOs to spend (1 to 150). May span multiple vault accounts within the same vault.

utxoId string Required

A unique identifier referencing a specific unspent transaction output (UTXO).

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

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.

601c1710034ed6d407996b30

context string Optional

yourExampleString

data object Required

item object Required

amountUnit string Required

Amount unit.

BTC

feePriority string Required

Fee priority of the transaction - slow, standard, fast.

slow

note string Required

Transaction note with additional details.

yourAdditionalInformationhere

recipients array Items (object) Required

Destinations of the transaction.

address string Required

Address of the destination.

bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k

amount string Required

Defines the amount sent to the destination address.

0.001

amountUnit string Required

Defines the unit of the received amount for the address, e.g. BTC, LTC.

BTC

assetId string Required

The identifier of the blockchain asset to be transferred. Defines which UTXO-based chain the transaction will be executed on. Supported values correspond to the chains BTC, LTC, DOGE, BCH, DASH, and ZEC.

6523e058a06ebf1322d7dd6f

senders array Items (object) Required

Resolved senders (per-UTXO breakdown); each carries its own vault account id to disambiguate multi-vault-account transfers.

address string Required

UTXO owning address.

tb1q84p9dwvfgy4q2tj2fz27n6c6g7xd2x2p69hpck

addressLabel string Optional

Label of the UTXO address, if one has been assigned.

Bitcoin

amount string Required

UTXO amount in native unit.

0.001

amountUnit string Required

Amount unit.

BTC

assetId string Required

The identifier of the blockchain asset to be transferred.

69946158b588731a395513f7

utxoId string Required

A unique identifier referencing a specific unspent transaction output (UTXO).

6a1e8633451fe82cc50db5cc

vaultAccountId string Required

Owning vault account id for this UTXO.

69e2229d96c8640007743e6c

totalTransactionAmount string Required

Total amount sent to recipients (excluding change and fee).

0.001

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.

62daacdbc8a7282e9ea01c35

transactionRequestStatus string Required

Defines the status of the transaction, e.g. "created".

created

transactionType string Required

Defines the transaction type. For UTXO transfers this is always "coin".

coin

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

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.

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.

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.

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.

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.

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

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

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

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.

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.

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.

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.

gross_amount_not_supported_with_fee_payer

message string Required

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

Gross amount is not supported when a fee payer is provided. The fee payer covers the transaction fee separately.

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.

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.

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.

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.

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.

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.

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.

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.

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

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

unit string Required

The specific asset unit.

BTC

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

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

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.

INCOMING_MINED_TX

item object Required

Contains detailed metadata about the outgoing mined transaction.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

address string Required

Destination address receiving the funds.

tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9

minedInBlock object Required

Information about the block that mined this transaction.

height integer Required

Block height where transaction was mined.

4547001

hash string Required

The hash of the block containing the transaction.

0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e

timestamp integer Required

UNIX timestamp indicating when the block was mined.

1750837928

direction string Required

Direction of the transaction (eg. incoming, outgoing, client-internal, vault-internal)

incoming

currentConfirmations integer Required

Number of confirmations the transaction currently has.

targetConfirmations integer Required

The number of confirmations required for the transaction to be considered final (typically 6 for Bitcoin).

amount string Required

The amount of the asset received in the transaction.

0.00000546

unit string Required

The currency unit of the amount .

BTC

transactionId string Required

Blockchain-specific transaction hash identifying the mined transaction.

cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2

status string Required

Status of transaction if it is success or failed.

success

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 — INCOMING_CONFIRMED_COIN_TX indicates an incoming coin transaction has reached the required confirmations and is now considered final.

INCOMING_CONFIRMED_COIN_TX

item object Required

Contains detailed metadata about the outgoing mined transaction.

vaultAccountId string Required

The specific vault account id.

69ba58c529eb49000746b311

assetId string Required

The specific asset id.

6913471c6b2794841dc8fb6f

address string Required

The receiving address.

tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9

minedInBlock object Required

Metadata about the block in which the transaction was mined.

height integer Required

Block height at which the transaction was mined.

4547001

hash string Required

The hash of the block containing the transaction.

0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e

timestamp integer Required

UNIX timestamp indicating when the block was mined.

1750837928

currentConfirmations integer Required

Number of confirmations the transaction currently has.

targetConfirmations integer Required

The number of confirmations required for the transaction to be considered final (typically 6 for Bitcoin).

amount string Required

The amount of the asset received in the transaction.

0.00000546

unit string Required

The currency unit of the amount .

BTC

transactionId string Required

Blockchain-specific transaction hash identifying the mined transaction.

cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2

status string Required

Status of transaction if it is success or failed.

success

Was this page helpful?

Yes

Language

URL

               {
    "context": "yourExampleString",
    "data": {
        "item": {
            "assetId": "6523e058a06ebf1322d7dd6f",
            "changeData": {
                "address": "tb1q5awmgf957klhfpr3f9ksc7lvmzdjnm3ucn3tz2",
                "vaultAccountId": "69e5d838859b6c00073fa8b7"
            },
            "feePayer": "tb1qjhmfv6pxcaz8943ytnvpd9hat083ennar56has",
            "feePriority": "slow",
            "gross": false,
            "maxFee": "0.00005",
            "note": "yourAdditionalInformationhere",
            "recipients": [
                {
                    "address": "bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k",
                    "amount": "0.001"
                }
            ],
            "senders": [
                {
                    "utxoId": "6a1e8633451fe82cc50db5cc"
                }
            ]
        }
    }
}

{
    "apiVersion": "2026-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "amountUnit": "BTC",
            "feePriority": "slow",
            "note": "yourAdditionalInformationhere",
            "recipients": [
                {
                    "address": "bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k",
                    "amount": "0.001",
                    "amountUnit": "BTC",
                    "assetId": "6523e058a06ebf1322d7dd6f"
                }
            ],
            "senders": [
                {
                    "address": "tb1q84p9dwvfgy4q2tj2fz27n6c6g7xd2x2p69hpck",
                    "addressLabel": "Bitcoin",
                    "amount": "0.001",
                    "amountUnit": "BTC",
                    "assetId": "69946158b588731a395513f7",
                    "utxoId": "6a1e8633451fe82cc50db5cc",
                    "vaultAccountId": "69e2229d96c8640007743e6c"
                }
            ],
            "totalTransactionAmount": "0.001",
            "transactionRequestId": "62daacdbc8a7282e9ea01c35",
            "transactionRequestStatus": "created",
            "transactionType": "coin"
        }
    }
}

{
    "apiVersion": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "gross_amount_not_supported_with_fee_payer",
        "message": "Gross amount is not supported when a fee payer is provided. The fee payer covers the transaction fee separately.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "TRANSACTION_APPROVED",
        "item": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "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": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "unit": "BTC",
            "requestId": "686cd2860ca2f4fd25f77099",
            "transactionType": "COIN",
            "requiredApprovals": 1,
            "requiredRejections": 1,
            "currentApprovals": 1,
            "currentRejections": 0,
            "failedReason": "INSUFFICIENT_FUNDS"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "INCOMING_MINED_TX",
        "item": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "address": "tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9",
            "minedInBlock": {
                "height": 4547001,
                "hash": "0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e",
                "timestamp": 1750837928
            },
            "direction": "incoming",
            "currentConfirmations": 1,
            "targetConfirmations": 6,
            "amount": "0.00000546",
            "unit": "BTC",
            "transactionId": "cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2",
            "status": "success"
        }
    }
}

{
    "walletId": "685121237d7d1e0007ac1a1d",
    "webhookId": "68516e9c6620b0a4790ed541",
    "idempotencyKey": "928fe1786859b5e33a2f63c569a0351e0c90cbe35bc5a7bb0bb1523cd371dda9",
    "apiVersion": "2025-09-23",
    "data": {
        "event": "INCOMING_CONFIRMED_COIN_TX",
        "item": {
            "vaultAccountId": "69ba58c529eb49000746b311",
            "assetId": "6913471c6b2794841dc8fb6f",
            "address": "tb1q3ft8aq4daesecw8yfz0gt4hgursm0l6nhj06m9",
            "minedInBlock": {
                "height": 4547001,
                "hash": "0000000000000004a25a24749cbca4ac6b2d62b9932f0fefbb9cb8a7a9e5619e",
                "timestamp": 1750837928
            },
            "currentConfirmations": 6,
            "targetConfirmations": 6,
            "amount": "0.00000546",
            "unit": "BTC",
            "transactionId": "cf0d9a82045c13dba627788d9508b3dfd761e46b49deba48d004c82e2f2f83f2",
            "status": "success"
        }
    }
}

Create UTXO transfer

Path Parameters

Query Parameters

Request Body Schema application/json

Response Schema

Callback parameters

Security schema

URL Schema

Request