REST API›Enterprise›Gas Tanks

PATCH

Enable or disable coin auto-funding

Toggles auto-funding for a single coin in an opted-in enterprise. enable upserts the enrollment with status pending (the FeeWorker re-provisions thresholds and transitions it to active); disable sets status disabled and the auto-funding cron skips the coin. Requires an existing opt-in — call POST /api/gas-tank/v1/enterprises/{enterpriseId} first.

Path Params

  • enterpriseId string required
    Enterprise identifier

    at least 1 characters

Body Params

object

Coin and action to enable or disable enterprise auto-funding. The action determines whether funding is enabled or disabled for the coin.
  • coin string required
    Coin to enable or disable

    at least 1 characters

  • action string enum required
    User intent. enable sets status pending (FeeWorker provisions thresholds and transitions to active). disable sets status disabled; the threshold is preserved but the funding cron skips the coin.
    enabledisable

Responses

200
OK

Response Body

object

  • enrollment object required
    Auto-funding enrollment state for one coin in an enterprise
    enrollment 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
404
Not Found

Response Body

object

  • error string required
409
Conflict

Response Body

object

  • error string required
422
Unprocessable Entity

Response Body

object

  • error string required