Skip to main content
POST
Create a new vault

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

network
enum<string>
required

Stellar network to execute the transaction on (testnet or mainnet)

Available options:
testnet,
mainnet

Body

application/json

Vault creation parameters. All parameters are required for vault deployment.

roles
object
required

Vault roles configuration

vaultFeeBps
number
required

Fee amount in basis points (0-10000, where 10000 = 100%)

Required range: 0 <= x <= 10000
Example:

25

assets
object[]
required

Assets and their strategies

Example:
name
string
required

Vault name

Required string length: 1 - 32
Example:

"MyVault"

symbol
string
required

Vault symbol

Required string length: 1 - 10
Example:

"MVLT"

upgradable
boolean
required

Indicates if the vault is upgradable

caller
string
required

Caller address, the address that will call the vault creation and sign the transaction

Example:

"GQWE..."

Response

Vault creation transaction prepared successfully

xdr
string | null

Base64 encoded transaction XDR ready for signing by Vault Manager

simulationResponse
string

Simulation result of the transaction

error
string

Error message if any