surplus

surplus is one of the estate's 317 automotive nouns — a job a car needs done. It carries 1 capability: 0 live, 1 sandbox, 0 declared · doors aggregator.vin.

Identity

Events

The vocabulary this noun can append to the record — 1 past-tense, versioned event type, each linked to the capability that emits it:

• Surplus.refunded@1 — emitted by refund

Pay & settle

refund

surplus.refund · POST /surpluses/refund · gate key · sandbox · answers SurplusRefund@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GT12UEY3JF221109 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Surplus.refunded@1.

import { surplus } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await surplus.refund()

curl -X POST https://apis.vin/surpluses/refund \
  -H 'content-type: application/json' \
  -d '{}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

{
  "type": "OK",
  "answers": "SurplusRefund@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "surplus",
    "asOf": "2026-08-10",
    "repo": {
      "status": "no-repo-on-file"
    },
    "surplus": {
      "status": "no-repo-on-file"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "surplus",
    "asOf": "2026-08-10",
    "repo": {
      "status": "no-repo-on-file"
    },
    "surplus": {
      "status": "no-repo-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "repo-yard-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Data model

The record shape behind this noun — one entity, each property an evidence field. See the whole estate model on the data model page.

Repossession

Modeled

The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. 4 diagrams, rendered from the estate model.

Surplus · Class model

Surplus · State machine

Surplus · State machine

Surplus · Class model

Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.