POST

Opt in to auto-funding

First-time-only enrollment into auto-funding. Creates one enrollment row per coin with status pending; the background FeeWorker then provisions thresholds and transitions each coin to active. Once any enrollment exists for the enterprise this endpoint is closed — subsequent per-coin changes must use PATCH /api/gas-tank/v1/enterprises/:enterpriseId/coin.

Path Params

enterpriseId string required

Enterprise identifier

at least 1 characters

Body Params

object

Coins to enroll in auto-funding for the enterprise. Each coin must be supported and have a configured enterprise fee address.

coins array of strings required

Responses

200

Response Body

object

enrollments array of objects required
enrollments object
- coin string required
  
  Coin identifier
- status string enum required
  
  Enrollment lifecycle state: pending = opted in, FeeWorker is provisioning thresholds. active = monitored and funded by the auto-funding cron. disabled = funding paused for this coin. error = provisioning failed; see lastError.
  
  pendingactiveerrordisabled
- version number required
  
  Monotonic write counter for optimistic concurrency
- lastError string nullable required
  
  Populated only when status is error; null otherwise
- updatedAt string required
  
  ISO 8601 timestamp of the last state change

403

Forbidden

Response Body

object

error string required

409

Conflict

Response Body

object

error string required

422

Unprocessable Entity

Response Body

object

error string required

curl -X POST \ --url 'https://app.bitgo-test.com/api/gas-tank/v1/enterprises/enterpriseId' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"coins":["eth","polygon"]}'

const url = 'https://app.bitgo-test.com/api/gas-tank/v1/enterprises/enterpriseId'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"coins":["eth","polygon"]}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/gas-tank/v1/enterprises/enterpriseId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"coins":["eth","polygon"]}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/gas-tank/v1/enterprises/enterpriseId', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"coins":["eth","polygon"]}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/gas-tank/v1/enterprises/enterpriseId" payload = {,"coins":["eth","polygon"]} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)