Skip to main content
POST
Provision a fee wrapper over a gtoken backing vault
Provisions a revenue-sharing fee wrapper around the Ground vault backing an existing gtoken. Use the returned fee-wrapper ID to check when the contract is ready.

Authorizations

Authorization
string
header
required

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

Body

application/json

Management fees are set at creation. Ground fixes their annual cap at 100 bps; maxManagementFeeBps is not accepted as input.

requestId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"8f4c52d7-62ab-4db9-a964-92f481f6b851"

gVaultId
enum<string>
required

Source ID returned by the gtoken yield-source catalogue.

Available options:
ground-ustb-vault
Example:

"ground-ustb-vault"

feeRecipientAddress
string
required

Valid nonzero EVM EOA or contract address. Mixed-case values must use a valid EIP-55 checksum.

Required string length: 42
Pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
Example:

"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"

performanceFeeBps
integer
required
Required range: 0 <= x <= 9999
managementFeeBps
integer
default:0

Annual management fee in basis points.

Required range: 0 <= x <= 100

Response

Provisioning accepted.

id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"8f4c52d7-62ab-4db9-a964-92f481f6b851"

requestId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"8f4c52d7-62ab-4db9-a964-92f481f6b851"

gVaultId
enum<string>
required

Source ID returned by the gtoken yield-source catalogue.

Available options:
ground-ustb-vault
Example:

"ground-ustb-vault"

status
enum<string>
required
Available options:
provisioning,
ready,
failed
contractAddress
string | null
required

Deployed nonzero EVM contract address, or null while deployment is pending.

Required string length: 42
Pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
Example:

"0x7c4a1cb5a3d5c3c4e019c3f6ab29a0f98c21b814"

feeRecipientAddress
string
required

Valid EVM address. Mixed-case values must use a valid EIP-55 checksum.

Required string length: 42
Pattern: ^0x[0-9a-fA-F]{40}$
Example:

"0x92e6a1ed742f0c8502f902c61775f57728985b42"

performanceFeeBps
integer
required
Required range: 0 <= x <= 9999
maxPerformanceFeeBps
integer
required
Required range: 0 <= x <= 9999
managementFeeBps
integer
required
Required range: 0 <= x <= 9999
maxManagementFeeBps
integer
required
read-only

Immutable annual management fee cap. New wrappers use 100 bps; older wrappers retain their deployed cap.

Required range: 0 <= x <= 9999
createdAt
string<date-time>
required
updatedAt
string<date-time>
required