Add a customer to a fee-wrapper allowlist

Allow an address on a fee wrapper

curl --request PUT \
  --url https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}', 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/fee-wrappers/{id}/allowlist/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "confirmed"
}

{
  "status": "submitted",
  "transactionHash": "0xabababababababababababababababababababababababababababababababab"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Unauthenticated request",
  "message": "Missing or invalid bearer token"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Service temporarily unavailable",
  "code": "service_temporarily_unavailable",
  "retryable": true
}

PUT

fee-wrappers

{id}

allowlist

{address}

Allow an address on a fee wrapper

curl --request PUT \
  --url https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}', 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/fee-wrappers/{id}/allowlist/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.groundtech.co/v2/fee-wrappers/{id}/allowlist/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "confirmed"
}

{
  "status": "submitted",
  "transactionHash": "0xabababababababababababababababababababababababababababababababab"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Unauthenticated request",
  "message": "Missing or invalid bearer token"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "<string>",
  "code": "validation_error"
}

{
  "error": "Service temporarily unavailable",
  "code": "service_temporarily_unavailable",
  "retryable": true
}

Call this from your backend before the customer deposits into the fee wrapper. Keep the Ground API key on the server.

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Organization-owned fee-wrapper ID.

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"

address

string

required

Nonzero EVM EOA or contract address. 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"

Response

Already confirmed.

status

enum<string>

required

Available options:

confirmed,

submitted

transactionHash

string | null

EVM transaction hash, or null when no transaction was submitted.

Required string length: 66

Pattern: ^0x[0-9a-fA-F]{64}$

Example:

"0xabababababababababababababababababababababababababababababababab"

Yield Sources

Direct Access

Fee Wrappers

Webhooks

Add a customer to a fee-wrapper allowlist

Authorizations

Path Parameters

Response