payout

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

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

Identity


Noun	`payout`
Pillar	Commerce (facets: 2 commerce)
Capabilities	2 — 0 live · 2 sandbox · 0 declared
Entities	`Payout`
Doors	`aggregator.vin`
SDK	`Vin.payout.*` from `apis.vin`
Address	`/catalog/payout#{action}` — the anchor IS the wire name minus `payout.`

Events

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

Payout.requested@1 — emitted by request
Payout.reversed@1 — emitted by reverse

Apply & book

request

payout.request · POST /payouts/request · gate key · sandbox · answers PayoutRequest@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKS2BKT0PR436413 (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 — Payout.requested@1.

the SDK — payout.request

import { payout } from 'apis.vin'

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

POST /payouts/request

curl -X POST https://apis.vin/payouts/request \
  -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.

receipt · executed 2026-08-16T14:50:09.964Z · HTTP 200

{
  "type": "OK",
  "answers": "PayoutRequest@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "payout",
    "asOf": "2026-08-10",
    "id": "PYO-bcec0b0b",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ]
    },
    "payout": {
      "id": "PYO-bcec0b0b",
      "payeeId": "DLR-b9066ade",
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ],
      "status": "requested"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "payout",
    "asOf": "2026-08-10",
    "id": "PYO-bcec0b0b",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ]
    },
    "payout": {
      "id": "PYO-bcec0b0b",
      "payeeId": "DLR-b9066ade",
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ],
      "status": "requested"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "treasury-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

reverse

payout.reverse · POST /payouts/reverse · gate key · sandbox · answers PayoutReverse@1

No input — this capability takes no request body.

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

Emits — Payout.reversed@1.

the SDK — payout.reverse

import { payout } from 'apis.vin'

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

POST /payouts/reverse

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

receipt · executed 2026-08-16T14:50:09.964Z · HTTP 200

{
  "type": "OK",
  "answers": "PayoutReverse@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "payout",
    "asOf": "2026-08-10",
    "id": "PYO-bcec0b0b",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ]
    },
    "payout": {
      "id": "PYO-bcec0b0b",
      "status": "no-grounds"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "payout",
    "asOf": "2026-08-10",
    "id": "PYO-bcec0b0b",
    "payeeId": "DLR-b9066ade",
    "amount": {
      "amountCents": 141068,
      "currency": "USD",
      "basis": "holdback-plus-fi-reserve",
      "items": [
        {
          "kind": "holdback",
          "amountCents": 133575,
          "basis": "msrp-holdback"
        },
        {
          "kind": "fi-reserve",
          "amountCents": 7493,
          "basis": "rate-spread"
        }
      ]
    },
    "payout": {
      "id": "PYO-bcec0b0b",
      "status": "no-grounds"
    }
  },
  "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.

Schema

Property	Type
`id`	`id`
`payeeId`	`ref→Party`
`amount`	`money`

Relationships

From	To	Cardinality	As
`escrow`	`payout`	`1:0..*`	`releases`

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

payout

On this page