InitiateTransaction

post

https://api.utila.io/v2/vaults/{vault_id}/transactions:initiate

Initiate a new transaction.

Path Params

vault_id

string

required

Body Params

details

object

required

Input to create the transaction.

Choose one of the available messages.

priority

string

enum

Generic priority enum for transactions. Translates to network specific priority values.

LOW: Low priority.
NORMAL: Normal priority. The default value.
HIGH: High priority.

Allowed:

note

string

A note to attach to the transaction.

This note will be visible to all vault members.

designatedSigners

array of strings

If the transaction is designated to be signed by a specific signer, this field should be set.

Format: users/{email} or users/{id}

Example: ["users/[email protected]"] or ["users/a3e4f5"]

designatedSigners

validateOnly

boolean

If set to true, the transaction will be validated but not created.

requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

externalId

string

A client-provided identifier for the transaction.

Must be unique per vault. Can be used to correlate the transaction with an entity in an external system.

runSimulation

boolean

Run a simulation against a blockchain node to get the estimated execution results of the transaction like balance changes.

expireTime

date-time

The expiration time of the transaction.

Example: 2025-06-10T12:30:05Z

includeReferencedResources

boolean

Include referenced resources in the response.

Response

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.