docs.vin

capital

The capital noun — identity, lifecycle, events, and every capability as an anchored section: 4 capabilities, 0 live, 4 sandbox, 0 declared.

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

Identity

Nouncapital
PillarData (facets: 2 data · 2 commerce)
Capabilities4 — 0 live · 4 sandbox · 0 declared
EntitiesPayout
Doorsaggregator.vin
SDKVin.capital.* from apis.vin
Address/catalog/capital#{action} — the anchor IS the wire name minus capital.

Events

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

Pay & settle

chargeback

capital.chargeback · POST /capitals/chargeback · gate offer · sandbox · answers CapitalChargeback@1

FieldTypeRequiredNotes
vinstringno

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /KM8HB3AB4SU222045 (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.

EmitsCapital.chargedBack@1 · Capital.failed@1.

the SDK — capital.chargeback
import { capital } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await capital.chargeback({"vin":"KM8HB3AB4SU222045"})
POST /capitals/chargeback
curl -X POST https://apis.vin/capitals/chargeback \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8HB3AB4SU222045"}'

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.

receipt · executed 2026-08-17T12:42:08.725Z · HTTP 200
{
  "type": "OK",
  "answers": "CapitalChargeback@1",
  "value": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "chargeback": {
      "status": "no-grounds"
    }
  },
  "evidence": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "chargeback": {
      "status": "no-grounds"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "treasury-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

commissionAdvance

capital.commissionAdvance · POST /capitals/commission-advance · gate offer · sandbox · answers CapitalCommissionAdvance@1

FieldTypeRequiredNotes
vinstringno

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /KM8HB3AB4SU222045 (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.

EmitsCapital.commissionAdvanced@1 · Capital.failed@1.

the SDK — capital.commissionAdvance
import { capital } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await capital.commissionAdvance({"vin":"KM8HB3AB4SU222045"})
POST /capitals/commission-advance
curl -X POST https://apis.vin/capitals/commission-advance \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8HB3AB4SU222045"}'

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.

receipt · executed 2026-08-17T12:42:08.726Z · HTTP 200
{
  "type": "OK",
  "answers": "CapitalCommissionAdvance@1",
  "value": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "advance": {
      "status": "not-posted",
      "basis": "no-commission-schedule-anchor"
    }
  },
  "evidence": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "advance": {
      "status": "not-posted",
      "basis": "no-commission-schedule-anchor"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "treasury-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

contractsInTransit

capital.contractsInTransit · GET /capitals/contracts-in-transit · gate key · sandbox · answers CapitalContractsInTransit@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /KM8HB3AB4SU222045 (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.

the SDK — capital.contractsInTransit
import { capital } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await capital.contractsInTransit({"vin":"KM8HB3AB4SU222045"})
GET /capitals/contracts-in-transit
curl 'https://apis.vin/capitals/contracts-in-transit?vin=KM8HB3AB4SU222045'

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.

receipt · executed 2026-08-17T12:42:08.726Z · HTTP 200
{
  "type": "OK",
  "answers": "CapitalContractsInTransit@1",
  "value": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "contractsInTransit": {
      "status": "no-contract-on-file"
    }
  },
  "evidence": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "contractsInTransit": {
      "status": "no-contract-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "treasury-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

receivables

capital.receivables · GET /capitals/receivables · gate key · sandbox · answers CapitalReceivables@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /KM8HB3AB4SU222045 (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.

the SDK — capital.receivables
import { capital } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await capital.receivables({"vin":"KM8HB3AB4SU222045"})
GET /capitals/receivables
curl 'https://apis.vin/capitals/receivables?vin=KM8HB3AB4SU222045'

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.

receipt · executed 2026-08-17T12:42:08.730Z · HTTP 200
{
  "type": "OK",
  "answers": "CapitalReceivables@1",
  "value": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "receivables": {
      "items": [],
      "totalCents": 0,
      "currency": "USD",
      "basis": "funding-pipeline"
    }
  },
  "evidence": {
    "vin": "KM8HB3AB4SU222045",
    "noun": "capital",
    "asOf": "2026-08-10",
    "id": "PYO-d922cad7",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 246222,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 211722,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 34500,
          "basis": "rate-spread"
        }
      ]
    },
    "receivables": {
      "items": [],
      "totalCents": 0,
      "currency": "USD",
      "basis": "funding-pipeline"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "treasury-desk-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.

Payout


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