Skip to main content
POST
Withdraw by burning specific amount of vault shares

Authorizations

Authorization
string
header
required

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

Path Parameters

address
string
required

Stellar address of the vault contract

Example:

"CBNKCU3HGFKHFOF7JTGXQCNKE3G3DXS5RDBQUKQMIIECYKXPIOUGB2S3"

Query Parameters

network
enum<string>
required

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

Available options:
testnet,
mainnet

Body

application/json

Share withdrawal parameters. Optional: slippageBps (defaults to 0)

shares
number
required

Amount of vault shares to withdraw. Must be a positive number.

Required range: x >= 0
Example:

1000000

caller
string
required

Stellar address of the user withdrawing shares. Must be a valid Stellar public key.

Example:

"GB7NTQG4EXB7NZEA5GNFHIHEQVTGQTZ6OWKWUD535FBEHNSEVCKZULIY"

slippageBps
number
default:0

Slippage tolerance in basis points (bps). 10000 = 100%, 100 = 1%, 50 = 0.5%. Default is 0 bps (0%)

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

100

Response

Bad request - invalid parameters