API reference Vaultody

POST /vaults/{vaultId}/transaction-requests/multiple-transfer

Create Multiple Transfer

Through this endpoint users can make UTXO-based transactions.

To have an operational callback subscription, you need to first verify a domain for the Callback URL. Please see more information on Callbacks here.

Vaultody will notify the user only when the event occurs. There are cases when the specific event doesn't happen at all, or takes a long time to do so. A callback notification will not be sent if the event does not or cannot occur, or will take long time to occur.

Path parameters

vaultId string required

Sender's Vault ID.

Query parameters

context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Body parameters application/json

context string

data object required

item object required

assetId string required e.g. 6523e058a06ebf1322d7dd6f

Unique internal identifier of the blockchain asset involved in the transaction.

feePriority string required e.g. slow

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

slow standard fast

gross boolean

Optional boolean. When true, the specified amount is gross (fee is deducted from it). Default is false (net amount).

maxFee string e.g. 0.003

The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.

note string required e.g. yourAdditionalInformationhere

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.

prepareStrategy string required e.g. optimize-size

Refers to a model of a UTXO spending strategy, where customers can choose how to spend their transaction outputs from multiple addresses.

minimize-dust optimize-size

recipients object[] required

Destinations for the transaction.

address string required e.g. bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu...

Destination address.

amount string required e.g. 0.001

Destination amount.

vaultAccountId string required e.g. 6913471c6b2794841dc8fb81

Unique identifier of the Vault Account.

Response

Returns 201 the resource has been successfully created.

apiVersion string required

Specifies the version of the API that incorporates this endpoint.

E.G. 2026-03-20

requestId string required

Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.

E.G. 601c1710034ed6d407996b30

context string

E.G. yourExampleString

data object required

item object required

amountUnit string required

Amount unit.

E.G. BTC

feePriority string required

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

slow standard fast

E.G. slow

gross boolean

Whether the amount is gross (fee deducted from amount).

maxFee string

The maximum allowable transaction fee set by the client. If the actual transaction fee exceeds this value, the transaction will not be processed.

E.G. 0.003

note string required

Transaction note with additional details.

E.G. yourExampleStringHere

prepareStrategy string required

UTXO prepare strategy used.

minimize-dust optimize-size

E.G. optimize-size

recipients object[] required

Destinations of the transaction

address string required

Address of the destination.

E.G. bc1qut6n59lceee7s94g5qme08yzu8evd2yfjuuu3k

amount string required

Defines the amount sent to the destination address.

E.G. 0.001

amountUnit string required

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

E.G. BTC

convertedAmountToUSD string required

Amount calculated in USD.

E.G. 95.42

totalTransactionAmount string required

Total amount of the transaction.

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

E.G. 62daacdbc8a7282e9ea01c35

transactionRequestStatus string required

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

created await-approval pending prepared signed broadcasted success failed rejected mined mined-with-errors await-approval-l2

E.G. created

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json

401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json

403 This wallet is not for the provided network. application/json

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

415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json

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

429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json

500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json