Skip to main content
POST

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"

role
string
required

Query Parameters

network
enum<string>

Stellar network (testnet or mainnet). Defaults to mainnet.

Available options:
testnet,
mainnet

Body

application/json

Role setting parameters. The role to set is determined by the URL path parameter.

new_address
string
required

Stellar address of the new role holder. Must be a valid Stellar public key.

Example:

"GB7NTQG4EXB7NZEA5GNFHIHEQVTGQTZ6OWKWUD535FBEHNSEVCKZULIY"

caller
string
required

Stellar address of the user initiating the change. Must be a valid Stellar public key with appropriate permissions.

Example:

"GB7NTQG4EXB7NZEA5GNFHIHEQVTGQTZ6OWKWUD535FBEHNSEVCKZULIY"

Response

Unsigned transaction built for caller. Nothing moves until it is signed and submitted (POST /send).

xdr
string | null

Base64 transaction envelope ready for the caller to sign. null when the caller is a smart wallet (C address): build your own transaction around operationXDR.

simulationResponse
any

Return value of the contract call in simulation. Amounts are strings in the asset's smallest unit.

functionName
string

Contract function the transaction calls

operationXDR
string

Base64 of the single invokeHostFunction operation, for smart wallets and custom transactions

isSmartWallet
boolean

Whether caller is a contract (C) address

params
any

Arguments the contract function was called with, as the API resolved them