Preview a shareholder redemption
curl --request POST \
--url https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"receiver": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"shares": "1000000000000000000",
"minAssetsOut": "990000"
}
'import requests
url = "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview"
payload = {
"owner": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"receiver": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"shares": "1000000000000000000",
"minAssetsOut": "990000"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
owner: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
receiver: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
shares: '1000000000000000000',
minAssetsOut: '990000'
})
};
fetch('https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'owner' => '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
'receiver' => '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
'shares' => '1000000000000000000',
'minAssetsOut' => '990000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview"
payload := strings.NewReader("{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"mode": "requested",
"action": "request_redeem",
"parameters": {
"owner": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"receiver": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"shares": "5000000000000000000"
},
"reason": "insufficient_synchronous_liquidity",
"asyncLegs": [
{
"sourceId": "0x1111111111111111111111111111111111111111111111111111111111111111",
"sourceName": "Invesco USTB",
"expectedAssets": "4998100",
"expectedProcessingSeconds": 86400,
"maxProcessingSeconds": 259200
}
],
"timing": {
"expectedSeconds": 86400,
"maximumSeconds": 259200
},
"directTransaction": {
"executionMode": "end_user_direct_transaction",
"relayable": false,
"from": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"to": "0x848837d997f0ce3f753d4644ee51b837ab8b386e",
"data": "0xabcdef01",
"value": "0",
"chainId": 11155111
}
}
}{
"error": "invalid_request",
"message": "allocation targets and idleTargetBps must total 10000"
}{
"error": "Unauthenticated request",
"message": "Missing or invalid bearer token"
}Redemptions
Preview a MicroVault redemption
Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.
POST
/
v2
/
microvaults
/
vaults
/
{vaultId}
/
redemptions
/
preview
Preview a shareholder redemption
curl --request POST \
--url https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"receiver": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"shares": "1000000000000000000",
"minAssetsOut": "990000"
}
'import requests
url = "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview"
payload = {
"owner": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"receiver": "0x76f8fc6667e239f83a547d4e16225d6a34f6fa22",
"shares": "1000000000000000000",
"minAssetsOut": "990000"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
owner: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
receiver: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
shares: '1000000000000000000',
minAssetsOut: '990000'
})
};
fetch('https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'owner' => '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
'receiver' => '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22',
'shares' => '1000000000000000000',
'minAssetsOut' => '990000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview"
payload := strings.NewReader("{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.groundtech.co/v2/microvaults/vaults/{vaultId}/redemptions/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"receiver\": \"0x76f8fc6667e239f83a547d4e16225d6a34f6fa22\",\n \"shares\": \"1000000000000000000\",\n \"minAssetsOut\": \"990000\"\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"mode": "requested",
"action": "request_redeem",
"parameters": {
"owner": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"receiver": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"shares": "5000000000000000000"
},
"reason": "insufficient_synchronous_liquidity",
"asyncLegs": [
{
"sourceId": "0x1111111111111111111111111111111111111111111111111111111111111111",
"sourceName": "Invesco USTB",
"expectedAssets": "4998100",
"expectedProcessingSeconds": 86400,
"maxProcessingSeconds": 259200
}
],
"timing": {
"expectedSeconds": 86400,
"maximumSeconds": 259200
},
"directTransaction": {
"executionMode": "end_user_direct_transaction",
"relayable": false,
"from": "0x76f8fc6667E239f83a547d4e16225d6a34f6FA22",
"to": "0x848837d997f0ce3f753d4644ee51b837ab8b386e",
"data": "0xabcdef01",
"value": "0",
"chainId": 11155111
}
}
}{
"error": "invalid_request",
"message": "allocation targets and idleTargetBps must total 10000"
}{
"error": "Unauthenticated request",
"message": "Missing or invalid bearer token"
}Determine whether a redemption can execute immediately or requires underlying source liquidation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Ground identifier of the MicroVault. This is distinct from its onchain contract address.
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"
Body
application/json
Wallet that owns the MicroVault shares being redeemed and submits the transaction returned by this endpoint.
Required string length:
42Pattern:
^0x(?!0{40}$)[0-9a-fA-F]{40}$Example:
"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"
Wallet that receives the redeemed base asset. This is usually the owner, but it may be a different address.
Required string length:
42Pattern:
^0x(?!0{40}$)[0-9a-fA-F]{40}$Example:
"0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81"
Number of MicroVault shares to redeem in the share token's 18-decimal base units.
Pattern:
^(0|[1-9][0-9]*)$Example:
"1000000"
Minimum base-asset amount accepted for an instant redemption, expressed in the base asset's smallest units. Requested redemptions instead settle at actual attributable proceeds.
Pattern:
^(0|[1-9][0-9]*)$Example:
"1000000"
Response
Redemption route and transaction data.
Executable redemption route based on the vault's current liquidity and source positions.
Show child attributes
Show child attributes