docs.vin

deposit

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

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

Identity

Noundeposit
PillarCommerce (facets: 1 data · 4 commerce)
Capabilities5 — 0 live · 5 sandbox · 0 declared
EntitiesPayment
Doorsdeposit.vin
SDKVin.deposit.* from apis.vin
Address/catalog/deposit#{action} — the anchor IS the wire name minus deposit.

Events

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

Quote & price

terms

deposit.terms · GET /deposits/terms · gate none · sandbox · answers DepositTerms@1

FieldTypeRequiredNotes
vinstringno—

Door — deposit.vin serves this noun on its two routes: / (the landing) · /KM8R7DHE9MU252818 (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 — deposit.terms
import { deposit } from 'apis.vin'

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

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:10.253Z · HTTP 200
{
  "type": "OK",
  "answers": "DepositTerms@1",
  "value": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "cashier-window-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

apply

deposit.apply · POST /deposits/apply · gate offer · sandbox · answers DepositApply@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.

Door — deposit.vin serves this noun on its two routes: / (the landing) · /KM8R7DHE9MU252818 (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 — Deposit.applied@1 · Deposit.failed@1.

the SDK — deposit.apply
import { deposit } from 'apis.vin'

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

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:10.156Z · HTTP 200
{
  "type": "OK",
  "answers": "DepositApply@1",
  "value": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "cashier-window-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

refund

deposit.refund · POST /deposits/refund · gate offer · sandbox · answers DepositRefund@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.

Door — deposit.vin serves this noun on its two routes: / (the landing) · /KM8R7DHE9MU252818 (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 — Deposit.failed@1 · Deposit.refunded@1.

the SDK — deposit.refund
import { deposit } from 'apis.vin'

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

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:10.252Z · HTTP 200
{
  "type": "OK",
  "answers": "DepositRefund@1",
  "value": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "cashier-window-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

forfeit

deposit.forfeit · POST /deposits/forfeit · gate offer · sandbox · answers DepositForfeit@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.

Door — deposit.vin serves this noun on its two routes: / (the landing) · /KM8R7DHE9MU252818 (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 — Deposit.failed@1 · Deposit.forfeited@1.

the SDK — deposit.forfeit
import { deposit } from 'apis.vin'

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

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:10.159Z · HTTP 200
{
  "type": "OK",
  "answers": "DepositForfeit@1",
  "value": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "cashier-window-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

take

deposit.take · POST /deposits/take · gate offer · sandbox · answers DepositTake@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.

Door — deposit.vin serves this noun on its two routes: / (the landing) · /KM8R7DHE9MU252818 (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 — Deposit.failed@1 · Deposit.taken@1.

the SDK — deposit.take
import { deposit } from 'apis.vin'

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

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:10.252Z · HTTP 200
{
  "type": "OK",
  "answers": "DepositTake@1",
  "value": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R7DHE9MU252818",
    "noun": "deposit",
    "asOf": "2026-08-10",
    "payment": {
      "status": "no-payment-story-on-file"
    },
    "deposit": {
      "status": "no-payment-story-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "cashier-window-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.

Payment

Modeled

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

Deposit · Class model

Deposit · State machine

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

credit

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

disbursement

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

On this page

Identity
Events
Quote & price
terms
Apply & book
apply
Pay & settle
refund
More actions
forfeit
take
Data model
Payment
Modeled