@volter/twin-stripe 0.1.2 → 2.0.1

package/src/semantics/after-payment.ts

@@ -0,0 +1,118 @@
+// What Stripe does itself once a payment succeeds, which no API call asks for:
+// - a test card that is disputed opens a dispute on its charge (docs.stripe.com/testing#disputes: 4000000000000259
+//   "charge succeeds, then disputed as fraudulent", 4000000000002685 disputed as product not received,
+//   4000000000001976 an inquiry), and Stripe debits the disputed
+//   amount and its dispute fee from the balance (docs.stripe.com/disputes/how-disputes-work);
+// - a test card Radar scores as elevated risk opens a review of its charge (docs.stripe.com/testing#fraud-prevention:
+//   4000000000009235, "elevated risk", which Radar places in review; docs.stripe.com/radar/reviews);
+// - a charge a platform makes with `application_fee_amount` earns the platform an application fee, from the connected
+//   account it pays (a destination charge's `transfer_data.destination`, or the account a direct charge is made on;
+//   docs.stripe.com/connect/destination-charges, docs.stripe.com/connect/direct-charges);
+// - a bank account verified by micro-deposits for a payment or a setup carries a mandate, the customer's acceptance
+//   of debits (docs.stripe.com/payments/ach-direct-debit/accept-a-payment, docs.stripe.com/api/mandates).
+//
+// Where the documentation stops and the twin decides: evidence is due seven days after a dispute opens (Stripe's
+// deadline depends on the card network); the dispute fee is 1500 cents in any currency (Stripe's US fee is $15); an
+// elevated-risk review's risk score is 67 (Radar's elevated band); the application is `ca_twin`.
+import type { SemanticsContext } from '@volter/world-core';
+import { disputeEvidence } from '../stripe-twin.ts';
+import { actingAccount, settleApplicationFee, settleDispute, settleTransfer } from './ledger.ts';
+import { BYPASS_PENDING_CARDS } from './test-cards.ts';
+import { created, type Row } from './shared.ts';
+
+type Outcome = 'dispute' | 'dispute_not_received' | 'inquiry' | 'review' | 'available';
+const DAY = 86_400;
+
+/** The test cards whose success Stripe follows with its own act, by number and by their documented test names. */
+export const AFTER_SUCCESS_CARDS: Record<string, { brand: string; number: string; outcome: Outcome }> = {
+  pm_card_createDispute: { brand: 'visa', number: '4000000000000259', outcome: 'dispute' },
+  pm_card_createDisputeProductNotReceived: { brand: 'visa', number: '4000000000002685', outcome: 'dispute_not_received' },
+  pm_card_createDisputeInquiry: { brand: 'visa', number: '4000000000001976', outcome: 'inquiry' },
+  pm_card_riskLevelElevated: { brand: 'visa', number: '4000000000009235', outcome: 'review' },
+  // its funds go straight to the available balance (ledger.ts reads it; no act follows here)
+  ...Object.fromEntries(Object.entries(BYPASS_PENDING_CARDS).map(([name, c]) => [name, { ...c, outcome: 'available' as const }])),
+};
+const BY_NUMBER: Record<string, Outcome> = Object.fromEntries(Object.values(AFTER_SUCCESS_CARDS).map((c) => [c.number, c.outcome]));
+
+/** What Stripe does after a card succeeds: from a raw number, a test name (pm_card_* or tok_*), or a stored
+ *  PaymentMethod that recorded it when it was made. */
+export function afterSuccessOf(ctx: SemanticsContext, ref: unknown): Outcome | undefined {
+  // a card given as a token (card[token], payment_method_data[card][token]) is the card the token names
+  if (ref && typeof ref === 'object' && typeof (ref as Row).token === 'string') return afterSuccessOf(ctx, (ref as Row).token);
+  if (ref && typeof ref === 'object') return BY_NUMBER[String((ref as Row).number ?? '').replace(/\D/g, '')];
+  if (typeof ref !== 'string' || !ref) return undefined;
+  const stored = ctx.row('payment_method', ref);
+  if (stored) return (stored._afterSuccess as Outcome | undefined) ?? undefined;
+  return AFTER_SUCCESS_CARDS[ref.replace(/^tok_/, 'pm_card_')]?.outcome ?? BY_NUMBER[ref.replace(/\D/g, '')];
+}
+
+/** Stripe's acts on a charge that just succeeded: a dispute or a review its card brings, and the platform's fee. */
+export async function afterCharge(ctx: SemanticsContext, chargeId: string, charge: { amount: number; currency: string; payment_intent?: string | undefined; application_fee_amount?: unknown; destination?: unknown }, ref: unknown): Promise<void> {
+  const outcome = afterSuccessOf(ctx, ref);
+  const pi = charge.payment_intent ? { payment_intent: charge.payment_intent } : { payment_intent: null };
+  const now = Number(ctx.now());
+  if (outcome === 'dispute' || outcome === 'dispute_not_received' || outcome === 'inquiry') {
+    const dispute = await created(ctx, 'dispute', { charge: chargeId, ...pi, amount: charge.amount, currency: charge.currency }, {
+      reason: outcome === 'dispute_not_received' ? 'product_not_received' : 'fraudulent', status: outcome === 'inquiry' ? 'warning_needs_response' : 'needs_response', is_charge_refundable: false,
+      evidence: disputeEvidence(), evidence_details: { due_by: now + 7 * DAY, has_evidence: false, past_due: false, submission_count: 0, enhanced_eligibility: {} },
+      balance_transactions: [], livemode: false, metadata: {}, enhanced_eligibility_types: [],
+    });
+    // an inquiry moves no money; a dispute takes the amount and its fee until it is decided
+    if (outcome !== 'inquiry') {
+      const bt = await settleDispute(ctx, String(dispute.id), charge.amount, charge.currency);
+      await ctx.write('dispute', String(dispute.id), { balance_transactions: [ctx.get('balance_transaction', bt) ?? bt] }, 'dispute.funds_withdrawn');
+    }
+    await ctx.write('charge', chargeId, { disputed: true }, 'charge.dispute.created');
+  }
+  if (outcome === 'review') await openReview(ctx, chargeId, pi);
+  const feeAmount = Math.trunc(Number(charge.application_fee_amount) || 0);
+  const destination = typeof charge.destination === 'string' && charge.destination ? charge.destination : undefined;
+  const direct = actingAccount(ctx);
+  const account = destination ?? direct;
+  // a destination charge transfers what it collected, less the platform's fee, available when the charge's funds are
+  if (destination) {
+    const amount = charge.amount - feeAmount;
+    const chargeBt = ctx.get('charge', chargeId)?.balance_transaction;
+    const availableOn = Number(ctx.get('balance_transaction', String(chargeBt))?.available_on ?? ctx.now());
+    const tr = await created(ctx, 'transfer', { amount, currency: charge.currency, destination }, {
+      amount_reversed: 0, balance_transaction: null, livemode: false, metadata: {}, reversed: false, source_type: 'card', source_transaction: chargeId,
+      reversals: { object: 'list', data: [], has_more: false, total_count: 0, url: '' },
+    });
+    const bt = await settleTransfer(ctx, String(tr.id), amount, charge.currency, destination, availableOn);
+    await ctx.write('transfer', String(tr.id), { balance_transaction: bt, destination_payment: `py_${String(tr.id).replace(/^tr_/, '')}`, reversals: { object: 'list', data: [], has_more: false, total_count: 0, url: `/v1/transfers/${String(tr.id)}/reversals` } }, 'transfer.created');
+    await ctx.write('charge', chargeId, { transfer: tr.id }, 'charge.updated');
+  }
+  if (feeAmount > 0 && account) {
+    const fee = await created(ctx, 'application_fee', { account, amount: feeAmount, charge: chargeId, currency: charge.currency }, {
+      amount_refunded: 0, application: 'ca_twin', balance_transaction: null, originating_transaction: null, refunded: false, livemode: false,
+    });
+    // a direct charge's fee moves from the connected account to the platform (a destination charge kept it back)
+    const bt = !destination && direct ? await settleApplicationFee(ctx, String(fee.id), feeAmount, charge.currency, direct) : null;
+    await ctx.write('application_fee', String(fee.id), { balance_transaction: bt, refunds: { object: 'list', data: [], has_more: false, total_count: 0, url: `/v1/application_fees/${String(fee.id)}/refunds` } }, 'application_fee.created');
+    await ctx.write('charge', chargeId, { application_fee: fee.id, application_fee_amount: feeAmount }, 'charge.updated');
+  }
+}
+
+/** Radar places an elevated-risk card's charge in review (docs.stripe.com/radar/reviews). */
+async function openReview(ctx: SemanticsContext, chargeId: string, pi: { payment_intent: string | null }): Promise<void> {
+  const review = await created(ctx, 'review', { charge: chargeId, ...pi }, {
+    open: true, opened_reason: 'rule', reason: 'rule', closed_reason: null, billing_zip: null, ip_address: null, ip_address_location: null, session: null, livemode: false,
+  });
+  const existing = (ctx.get('charge', chargeId)?.outcome as Row | undefined) ?? {};
+  await ctx.write('charge', chargeId, {
+    review: review.id,
+    outcome: { ...existing, type: 'manual_review', risk_level: 'elevated', risk_score: 67, seller_message: 'Stripe evaluated this payment as having elevated risk, and placed it in review.' },
+  }, 'review.opened');
+}
+
+/** The mandate a verified bank account carries for a payment (single use) or a setup (multi use). */
+export async function mintMandate(ctx: SemanticsContext, paymentMethod: unknown, use: 'single_use' | 'multi_use', amount?: number, currency?: string): Promise<string> {
+  const now = Number(ctx.now());
+  const mandate = await created(ctx, 'mandate', { payment_method: typeof paymentMethod === 'string' ? paymentMethod : null }, {
+    status: 'active', type: use, livemode: false,
+    customer_acceptance: { type: 'online', accepted_at: now, online: { ip_address: '127.0.0.1', user_agent: 'twin' } },
+    payment_method_details: { type: 'us_bank_account', us_bank_account: { collection_method: 'paper' } },
+    ...(use === 'single_use' ? { single_use: { amount: amount ?? 0, currency: currency ?? 'usd' } } : { multi_use: {} }),
+  }, { timeField: '_created' });
+  return String(mandate.id);
+}

package/src/semantics/apps-secrets.ts

@@ -0,0 +1,58 @@
+// Apps secret-store semantics: a secret is named within a scope (the account, or one user); setting
+// the same name in the same scope overwrites it. The scope is kept as a bookkeeping key.
+import type { Semantics, SemanticsContext } from '@volter/world-core';
+import { created, fail, list, newest, type Row, kept } from './shared.ts';
+
+const SECRET = 'apps.secret';
+
+function scopeKeyOf(ctx: SemanticsContext): string {
+  const scope = ctx.params.scope && typeof ctx.params.scope === 'object' ? (ctx.params.scope as Row) : undefined;
+  const scopeType = scope && typeof scope.type === 'string' ? scope.type : 'account';
+  return scopeType === 'user' ? `user:${String(scope!.user)}` : 'account';
+}
+const named = (ctx: SemanticsContext, name: string): Row | undefined => ctx.rows(SECRET).find((s) => s.name === name && kept(ctx, SECRET, s, '_scope_key') === scopeKeyOf(ctx));
+
+const set: Semantics = async (ctx) => {
+  const params = ctx.params;
+  const name = typeof params.name === 'string' ? params.name : '';
+  if (!name) return fail(ctx, 'Missing required param: name.', 400, 'parameter_missing');
+  const scope = params.scope && typeof params.scope === 'object' ? (params.scope as Row) : undefined;
+  const scopeType = scope && typeof scope.type === 'string' ? scope.type : '';
+  if (scopeType !== 'account' && scopeType !== 'user') return fail(ctx, 'Invalid scope[type]: must be account or user.', 400, 'parameter_invalid_string_enum');
+  if (scopeType === 'user' && typeof scope!.user !== 'string') return fail(ctx, 'Missing required param: scope[user].', 400, 'parameter_missing');
+  if (params.payload === undefined) return fail(ctx, 'Missing required param: payload.', 400, 'parameter_missing');
+  const expiresAt = params.expires_at !== undefined ? Math.trunc(Number(params.expires_at)) : null;
+  const existing = named(ctx, name);
+  if (existing) return ctx.reply(await ctx.write(SECRET, String(existing.id), { payload: params.payload, expires_at: expiresAt, _updated: ctx.now() }, 'apps_secret.update'));
+  return ctx.reply(
+    await created(ctx, SECRET, { name }, {
+      livemode: false, deleted: false, expires_at: expiresAt, payload: params.payload,
+      scope: scopeType === 'user' ? { type: 'user', user: scope!.user } : { type: 'account' },
+      _scope_key: scopeKeyOf(ctx),
+    }),
+  );
+};
+
+const find: Semantics = async (ctx) => {
+  const name = typeof ctx.params.name === 'string' ? ctx.params.name : '';
+  if (!name) return fail(ctx, 'Missing required param: name.', 400, 'parameter_missing');
+  const s = named(ctx, name);
+  return s ? ctx.reply(s) : fail(ctx, `No such secret: '${name}'`, 404, 'resource_missing');
+};
+
+const remove: Semantics = async (ctx) => {
+  const name = typeof ctx.params.name === 'string' ? ctx.params.name : '';
+  if (!name) return fail(ctx, 'Missing required param: name.', 400, 'parameter_missing');
+  const s = named(ctx, name);
+  if (!s) return fail(ctx, `No such secret: '${name}'`, 404, 'resource_missing');
+  return ctx.reply(await ctx.write(SECRET, String(s.id), { deleted: true }, 'apps_secret.delete'));
+};
+
+const listSecrets: Semantics = async (ctx) => list(ctx, SECRET, newest(ctx, SECRET).filter((s) => kept(ctx, SECRET, s, '_scope_key') === scopeKeyOf(ctx)));
+
+export const appsSecrets: Record<string, Semantics> = {
+  PostAppsSecrets: set,
+  GetAppsSecretsFind: find,
+  PostAppsSecretsDelete: remove,
+  GetAppsSecrets: listSecrets,
+};

package/src/semantics/balance.ts

@@ -0,0 +1,209 @@
+// Balance and payout semantics. The balance is computed from the balance-transaction ledger (./ledger.ts), never
+// stored: funds past their available_on are available, the rest pending, and Issuing funds their own section. The
+// balance, the payouts and the ledger are the acting account's: the platform's, or a connected account's under the
+// Stripe-Account header. A payout comes out of what that account has available and goes to its bank account, which a
+// connected account must have (docs.stripe.com/connect/payouts-connected-accounts). A pending payout can be canceled,
+// which returns its money; a connected account's paid payout can be reversed, which debits its bank account back
+// into its balance (docs.stripe.com/api/payouts/reverse). The machine in ../manifest.ts says how a payout's status
+// moves.
+//
+// Stripe also pays each account out on its own schedule (settings.payouts.schedule: daily by default, weekly or monthly
+// on an anchor, or manual): an automatic payout takes what has become available since the last one, and the ledger
+// lists the entries it paid (docs.stripe.com/payouts#payout-schedule, docs.stripe.com/connect/manage-payout-schedule).
+// A connected account is paid out once it can be (payouts_enabled, with a bank account).
+//
+// Where the documentation stops and the twin decides: a payout arrives two days after it is made (Stripe's standard
+// US schedule counts business days) and reads paid from then on; an automatic payout is made at midnight UTC on the
+// first scheduled day on or after its funds become available, only when what it would pay is positive.
+import type { Semantics, SemanticsContext } from '@volter/world-core';
+import { validateMoney } from '../stripe-twin.ts';
+import { accountSettings, PLATFORM_ACCOUNT_ID } from '../stripe-twin.ts';
+import { actingAccount, balanceOf, refusePayout, settleAutomaticPayout, settlePayout, unpaidEntries } from './ledger.ts';
+import { at, at_, created, fail, inRange, list, newest, send, where, type Row, kept } from './shared.ts';
+
+const account = actingAccount;
+const DAY = 86_400;
+const payoutMissing = (ctx: SemanticsContext, id: string): Response => fail(ctx, `No such payout: '${id}'`, 404, 'resource_missing');
+
+/** The acting account's Balance object (docs.stripe.com/api/balance/balance_object). */
+export function balanceBody(ctx: SemanticsContext): Row {
+  const { available, pending, issuing } = balanceOf(ctx);
+  const toArr = (m: Map<string, number>) => {
+    const out = [...m.entries()].map(([currency, amount]) => ({ amount, currency, source_types: { card: amount } }));
+    return out.length ? out : [{ amount: 0, currency: 'usd', source_types: { card: 0 } }];
+  };
+  // a platform's balance holds its connected accounts' reserve, "Funds held due to negative balances on connected accounts
+  // where account.controller.requirement_collection is `application`" (docs.stripe.com/api/balance/balance_object, whose
+  // example answers `[{"amount": 0, "currency": "usd"}]`); the twin models no such reserve, so it is zero in each currency
+  const reserved = account(ctx) ? {} : { connect_reserved: toArr(available).map((b) => ({ amount: 0, currency: b.currency })) };
+  return {
+    object: 'balance', available: toArr(available), pending: toArr(pending), ...reserved, livemode: false,
+    ...(issuing.size ? { issuing: { available: [...issuing.entries()].map(([currency, amount]) => ({ amount, currency, source_types: { card: amount } })) } } : {}),
+  };
+}
+
+const balance: Semantics = async (ctx) => ctx.reply(balanceBody(ctx));
+
+/** Time's arrivals, written: each of the acting account's payouts whose arrival date has come moves pending → paid
+ *  (the clock's move, as asOf reads it), written as `payout.paid`, the event Stripe sends for it. Answers their ids. */
+export async function payDuePayouts(ctx: SemanticsContext): Promise<string[]> {
+  const acct = account(ctx);
+  const now = Number(ctx.now());
+  const paid: string[] = [];
+  for (const p of newest(ctx, 'payout')) {
+    if ((acct ? kept(ctx, 'payout', p, '_account') !== acct : !!kept(ctx, 'payout', p, '_account')) || p.status !== 'pending' || Number(p.arrival_date) > now) continue;
+    if (ctx.legal('payout', 'status', ctx.call.operation.id, 'pending', 'paid', String(p.id), 'time')) continue;
+    await ctx.write('payout', String(p.id), { status: 'paid' }, 'payout.paid');
+    paid.push(String(p.id));
+  }
+  return paid;
+}
+
+/** Where a connected account's payout goes: "ID of the bank account or card the payout is sent to" (served spec,
+ *  payout.destination), its default external account for the currency, "When multiple accounts are available for a given
+ *  currency, Stripe uses the one set as `default_for_currency`" (docs.stripe.com/connect/payouts-bank-accounts), the
+ *  newest such. Where the documentation stops and the twin decides: the platform's own bank account is not modelled, so
+ *  its payouts name none. */
+function payoutBank(ctx: SemanticsContext, account: string, currency: string): string | null {
+  const banks = newest(ctx, 'external_account').filter((e) => e.account === account && String(e.currency ?? currency) === currency);
+  return String((banks.find((e) => e.default_for_currency === true) ?? banks[0])?.id ?? '') || null;
+}
+
+const payoutDefaults = (ctx: SemanticsContext): Row => ({
+  method: 'standard', type: 'bank_account', source_type: 'card', automatic: false,
+  reconciliation_status: 'not_applicable', arrival_date: Number(ctx.now()) + 2 * DAY, livemode: false, metadata: {},
+});
+
+/** A payout as the clock reads it: paid once its arrival date has come, the clock's move, asked of the
+ *  machine as a write asks it. */
+function asOf(ctx: SemanticsContext, p: Row): Row {
+  if (p.status !== 'pending' || Number(p.arrival_date) > Number(ctx.now())) return p;
+  ctx.legal('payout', 'status', ctx.call.operation.id, 'pending', 'paid', String(p.id), 'time');
+  return { ...p, status: 'paid' };
+}
+
+/** A connected account's payout in a currency none of its bank accounts takes. */
+function noExternalAccount(ctx: SemanticsContext, currency: string): Response {
+  return fail(ctx, `Sorry, you don't have any external accounts in that currency (${currency}).`, 400);
+}
+
+const createPayout: Semantics = async (ctx) => {
+  const bad = validateMoney(ctx.params);
+  if (bad) return send(ctx, bad);
+  const acct = account(ctx);
+  if (acct && !ctx.get('account', acct)) return fail(ctx, `No such account: '${acct}'`, 400, 'account_invalid');
+  const amount = Math.trunc(Number(ctx.params.amount) || 0);
+  const currency = String(ctx.params.currency ?? 'usd');
+  // a connected account is paid out to its own bank account
+  if (acct && !ctx.rows('external_account').some((e) => e.account === acct && (e.currency ?? currency) === currency)) return noExternalAccount(ctx, currency);
+  const refused = refusePayout(ctx, amount, currency);
+  if (refused) return refused;
+  const id = ctx.mint('payout');
+  const bt = await settlePayout(ctx, id, -amount, currency);
+  return ctx.reply(await created(ctx, 'payout', { ...ctx.params, id }, { status: 'pending', ...payoutDefaults(ctx), balance_transaction: bt, destination: acct ? payoutBank(ctx, acct, currency) : null, ...(acct ? { _account: acct } : {}) }));
+};
+
+const listPayouts: Semantics = async (ctx) => {
+  const acct = account(ctx);
+  const scoped = newest(ctx, 'payout').filter((p) => (acct ? kept(ctx, 'payout', p, '_account') === acct : !kept(ctx, 'payout', p, '_account'))).map((p) => asOf(ctx, p));
+  return list(ctx, 'payout', where(ctx, scoped, { status: (p, v) => p.status === v, created: (p, v) => inRange(p.created, v), arrival_date: (p, v) => inRange(p.arrival_date, v) }));
+};
+
+const DAYS = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'];
+/** The first scheduled payout time on or after `from`: midnight UTC of a day the schedule pays out on. */
+function payoutDay(from: number, schedule: Row): number {
+  const first = Math.ceil(from / DAY) * DAY;
+  const pays = (day: number): boolean => {
+    const d = new Date(day * 1000);
+    if (schedule.interval === 'weekly') return DAYS[d.getUTCDay()] === String(schedule.weekly_anchor ?? 'monday');
+    if (schedule.interval === 'monthly') return d.getUTCDate() === Math.min(Number(schedule.monthly_anchor ?? 1), new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth() + 1, 0)).getUTCDate());
+    return true;
+  };
+  return Array.from({ length: 62 }, (_, i) => first + i * DAY).find(pays) ?? first;
+}
+
+/** Time's payouts, caught up to the World's clock: each account on an automatic schedule is paid out, on each of its
+ *  scheduled days that has come, what became available by then. */
+export async function advancePayouts(ctx: SemanticsContext): Promise<void> {
+  const now = Number(ctx.now());
+  const platform = ctx.get('account', PLATFORM_ACCOUNT_ID);
+  const accounts: Array<{ id: string | undefined; settings: unknown }> = [{ id: undefined, settings: platform?.settings }];
+  for (const a of ctx.rows('account')) {
+    if (a.id === PLATFORM_ACCOUNT_ID || a.payouts_enabled !== true) continue;
+    if (!ctx.rows('external_account').some((e) => e.account === a.id)) continue;
+    accounts.push({ id: String(a.id), settings: a.settings });
+  }
+  for (const acct of accounts) {
+    const schedule = ((accountSettings(acct.settings, (acct.settings as Row | undefined) ?? undefined).payouts as Row).schedule ?? {}) as Row;
+    if (schedule.interval === 'manual') continue;
+    const unpaid = unpaidEntries(ctx, acct.id);
+    const days = [...new Set(unpaid.map((t) => payoutDay(Number(t.available_on) || 0, schedule)))].filter((d) => d <= now).sort((x, y) => x - y);
+    const paid = new Set<unknown>();
+    for (const day of days) {
+      const due = unpaid.filter((t) => !paid.has(t.id) && (Number(t.available_on) || 0) <= day);
+      const byCurrency = new Map<string, Row[]>();
+      for (const t of due) byCurrency.set(String(t.currency ?? 'usd'), [...(byCurrency.get(String(t.currency ?? 'usd')) ?? []), t]);
+      for (const [currency, entries] of byCurrency) {
+        const amount = entries.reduce((n, t) => n + (Number(t.net) || 0), 0);
+        // nothing to pay yet: what came due is carried to the next payout
+        if (amount <= 0) continue;
+        // made on its day, as Stripe makes it, whenever the request that catches it up comes
+        const c = await at_(ctx)(day);
+        const id = c.mint('payout');
+        const bt = await settleAutomaticPayout(c, id, amount, currency, acct.id, day, entries);
+        await created(c, 'payout', { id, amount, currency }, {
+          status: 'pending', ...payoutDefaults(c), arrival_date: day + 2 * DAY, automatic: true, balance_transaction: bt, destination: acct.id ? payoutBank(c, String(acct.id), currency) : null,
+          description: 'STRIPE PAYOUT', ...(acct.id ? { _account: acct.id } : {}),
+        });
+        for (const t of entries) paid.add(t.id);
+      }
+    }
+  }
+}
+
+const retrievePayout: Semantics = async (ctx) => {
+  const p = ctx.get('payout', at(ctx, 'payout'));
+  return p ? ctx.reply(asOf(ctx, p)) : payoutMissing(ctx, at(ctx, 'payout'));
+};
+
+const cancelPayout: Semantics = async (ctx) => {
+  const id = at(ctx, 'payout');
+  const po = ctx.get('payout', id);
+  if (!po) return payoutMissing(ctx, id);
+  const refused = ctx.legal('payout', 'status', 'PostPayoutsPayoutCancel', asOf(ctx, po).status, undefined, id);
+  if (refused) return ctx.refuse(refused);
+  // the money comes back to the balance it left
+  const owner = kept(ctx, 'payout', po, '_account');
+  await settlePayout(ctx, id, Number(po.amount) || 0, String(po.currency ?? 'usd'), typeof owner === 'string' ? owner : null);
+  return ctx.reply(await ctx.write('payout', id, { status: 'canceled' }, 'payout.cancel'));
+};
+
+// a reversal is itself a payout in the other direction, back into the connected account's balance, as the reverse page's
+// example answers it: a negative amount, pending until it arrives, carrying the request's metadata
+// (docs.stripe.com/api/payouts/reverse); the original stays paid and names it
+const reversePayout: Semantics = async (ctx) => {
+  const id = at(ctx, 'payout');
+  const po = ctx.get('payout', id);
+  if (!po) return payoutMissing(ctx, id);
+  const owner = kept(ctx, 'payout', po, '_account');
+  if (typeof owner !== 'string') return fail(ctx, "Payout reversals are only supported for payouts to connected accounts' bank accounts.", 400);
+  const status = String(asOf(ctx, po).status);
+  if (po.reversed_by || status !== 'paid') return ctx.refuse({ status: 400, code: 'payout_reversal_not_allowed', message: po.reversed_by ? 'This payout has already been reversed.' : `This payout cannot be reversed because it has a status of ${status}. A pending payout can be canceled instead.` });
+  const reversalId = ctx.mint('payout');
+  const bt = await settlePayout(ctx, reversalId, Number(po.amount) || 0, String(po.currency ?? 'usd'), owner);
+  const metadata = ctx.params.metadata && typeof ctx.params.metadata === 'object' ? { metadata: ctx.params.metadata } : {};
+  const reversal = await created(ctx, 'payout', { id: reversalId, amount: -(Number(po.amount) || 0), currency: po.currency, ...metadata }, {
+    status: 'pending', ...payoutDefaults(ctx), balance_transaction: bt, original_payout: id, destination: po.destination ?? null, _account: owner,
+  });
+  await ctx.write('payout', id, { reversed_by: reversal.id }, 'payout.reversed');
+  return ctx.reply(reversal);
+};
+
+export const balances: Record<string, Semantics> = {
+  GetBalance: balance,
+  PostPayouts: createPayout,
+  GetPayouts: listPayouts,
+  GetPayoutsPayout: retrievePayout,
+  PostPayoutsPayoutCancel: cancelPayout,
+  PostPayoutsPayoutReverse: reversePayout,
+};

package/src/semantics/billing.ts

@@ -0,0 +1,216 @@
+// Billing semantics: meters (how usage events aggregate), the meter events that report usage and
+// the summaries that aggregate them, prepaid credit grants and the balance they leave, and usage
+// alerts. The machines in ../manifest.ts say how a meter and an alert move. Lists and retrieves
+// with no scoping of their own are the derived core's.
+import type { Semantics, SemanticsContext } from '@volter/world-core';
+import { at, created, fail, list, newest, path, where, type Row } from './shared.ts';
+
+const METER = 'billing.meter';
+const meterMissing = (ctx: SemanticsContext, id: string): Response => fail(ctx, `No such meter: '${id}'`, 404, 'resource_missing');
+const objectOf = (v: unknown): Row => (v && typeof v === 'object' ? (v as Row) : {});
+
+// a meter needs a display name, the event name it counts, and how it aggregates (sum or count)
+const createMeter: Semantics = async (ctx) => {
+  const params = ctx.params;
+  const displayName = typeof params.display_name === 'string' ? params.display_name : '';
+  if (!displayName) return fail(ctx, 'Missing required param: display_name.', 400, 'parameter_missing');
+  if (!((params.event_name as string) ?? '')) return fail(ctx, 'Missing required param: event_name.', 400, 'parameter_missing');
+  const formula = objectOf(params.default_aggregation).formula;
+  if (typeof formula !== 'string' || !formula) return fail(ctx, 'Missing required param: default_aggregation[formula] (sum or count).', 400, 'parameter_missing');
+  return ctx.reply(
+    await created(ctx, METER, params, {
+      status: 'active', livemode: false,
+      customer_mapping: (params.customer_mapping as object) ?? { event_payload_key: 'stripe_customer_id', type: 'by_id' },
+      event_time_window: (params.event_time_window as string) ?? null,
+      value_settings: (params.value_settings as object) ?? { event_payload_key: 'value' },
+      status_transitions: { deactivated_at: null }, updated: ctx.now(),
+    }),
+  );
+};
+
+function activation(kind: 'deactivate' | 'reactivate'): Semantics {
+  return async (ctx) => {
+    const id = at(ctx, 'id');
+    const m = ctx.get(METER, id);
+    if (!m) return meterMissing(ctx, id);
+    const refused = ctx.legal(METER, 'status', kind === 'deactivate' ? 'PostBillingMetersIdDeactivate' : 'PostBillingMetersIdReactivate', m.status, undefined, id);
+    if (refused) return ctx.refuse(refused);
+    const fields = { ...(kind === 'deactivate' ? { status: 'inactive', status_transitions: { deactivated_at: ctx.now() } } : { status: 'active', status_transitions: { deactivated_at: null } }), updated: ctx.now() };
+    return ctx.reply(await ctx.write(METER, id, fields, `billing_meter.${kind}`));
+  };
+}
+
+// a meter event has no id of its own on Stripe (it carries an `identifier`); its object is billing.meter_event
+const reportUsage: Semantics = async (ctx) => {
+  const params = ctx.params;
+  if (typeof params.event_name !== 'string' || !params.event_name) return fail(ctx, 'Missing required param: event_name.', 400, 'parameter_missing');
+  const payload = objectOf(params.payload);
+  const body = await created(ctx, 'billing.meter_event', { ...params }, {
+    livemode: false, timestamp: params.timestamp !== undefined ? Math.trunc(Number(params.timestamp)) : ctx.now(),
+    identifier: payload.identifier ?? null, payload,
+  });
+  return ctx.reply({ ...body, object: 'billing.meter_event' });
+};
+
+// the meter's events for one customer in [start_time, end_time), aggregated by its formula
+const eventSummaries: Semantics = async (ctx) => {
+  const id = at(ctx, 'id');
+  const m = ctx.get(METER, id);
+  if (!m) return meterMissing(ctx, id);
+  const params = ctx.params;
+  const customer = typeof params.customer === 'string' ? params.customer : '';
+  if (!customer) return fail(ctx, 'Missing required param: customer.', 400, 'parameter_missing');
+  if (params.start_time === undefined) return fail(ctx, 'Missing required param: start_time.', 400, 'parameter_missing');
+  if (params.end_time === undefined) return fail(ctx, 'Missing required param: end_time.', 400, 'parameter_missing');
+  const startTime = Math.trunc(Number(params.start_time) || 0);
+  const endTime = Math.trunc(Number(params.end_time) || 0);
+  // "Must be aligned with minute boundaries" (start_time, end_time); "For hourly granularity, start and end times must
+  // align with hour boundaries … For daily granularity, … with UTC day boundaries (00:00 UTC)" (value_grouping_window;
+  // the served spec). Where the documentation stops and the twin decides: Stripe documents no error for it, so the
+  // twin answers a 400 naming the parameter and the boundary.
+  const window = params.value_grouping_window === 'hour' ? 3600 : params.value_grouping_window === 'day' ? 86_400 : 60;
+  const unit = window === 3600 ? 'hour' : window === 86_400 ? 'UTC day' : 'minute';
+  for (const [name, t] of [['start_time', startTime], ['end_time', endTime]] as const) {
+    if (t % window !== 0) return fail(ctx, `Invalid ${name}: ${t} is not aligned with ${unit} boundaries.`, 400);
+  }
+  const mapKey = typeof objectOf(m.customer_mapping).event_payload_key === 'string' ? String(objectOf(m.customer_mapping).event_payload_key) : 'stripe_customer_id';
+  const valueKey = typeof objectOf(m.value_settings).event_payload_key === 'string' ? String(objectOf(m.value_settings).event_payload_key) : 'value';
+  const formula = (objectOf(m.default_aggregation).formula as string) ?? 'sum';
+  let aggregate = 0;
+  for (const ev of ctx.rowsRaw('billing.meter_event', { withDeleted: true })) {
+    if (ev.event_name !== String(m.event_name ?? '')) continue;
+    const ts = Number(ev.timestamp) || 0;
+    if (ts < startTime || ts >= endTime) continue;
+    const payload = objectOf(ev.payload);
+    if (String(payload[mapKey] ?? '') !== customer) continue;
+    aggregate += formula === 'count' ? 1 : Number(payload[valueKey]) || 0;
+  }
+  return ctx.reply({
+    object: 'list', url: path(ctx), has_more: false,
+    data: [{ id: `mtrusg_twin_${id}_${customer}`, object: 'billing.meter_event_summary', meter: id, aggregated_value: aggregate, start_time: startTime, end_time: endTime, livemode: false }],
+  });
+};
+
+// ── credit grants: a customer's prepaid credit, paid or promotional, in a monetary amount ──
+
+const GRANT = 'billing.credit_grant';
+const grantMissing = (ctx: SemanticsContext, id: string): Response => fail(ctx, `No such credit grant: '${id}'`, 404, 'resource_missing');
+
+const createGrant: Semantics = async (ctx) => {
+  const params = ctx.params;
+  const customer = typeof params.customer === 'string' ? params.customer : '';
+  if (!customer) return fail(ctx, 'Missing required param: customer.', 400, 'parameter_missing');
+  if (!ctx.row('customer', customer, { withDeleted: true })) return fail(ctx, `No such customer: '${customer}'`, 404, 'resource_missing');
+  const category = typeof params.category === 'string' ? params.category : '';
+  if (category !== 'paid' && category !== 'promotional') return fail(ctx, 'Invalid category: must be paid or promotional.', 400, 'parameter_invalid_string_enum');
+  const monetary = params.amount && typeof params.amount === 'object' ? objectOf((params.amount as Row).monetary) : undefined;
+  if (!monetary || monetary.value === undefined || monetary.currency === undefined) return fail(ctx, 'Missing required param: amount[monetary][value] and amount[monetary][currency].', 400, 'parameter_missing');
+  return ctx.reply(
+    await created(ctx, GRANT, { customer }, {
+      category, livemode: false, name: params.name ?? null,
+      amount: { type: 'monetary', monetary: { currency: String(monetary.currency), value: Math.trunc(Number(monetary.value) || 0) } },
+      applicability_config: params.applicability_config && typeof params.applicability_config === 'object' ? params.applicability_config : { scope: { price_type: 'metered' } },
+      effective_at: params.effective_at !== undefined ? Math.trunc(Number(params.effective_at)) : ctx.now(),
+      expires_at: params.expires_at !== undefined ? Math.trunc(Number(params.expires_at)) : null,
+      priority: params.priority !== undefined ? Math.trunc(Number(params.priority)) : 50,
+      voided_at: null, metadata: params.metadata && typeof params.metadata === 'object' ? params.metadata : {}, updated: ctx.now(),
+    }),
+  );
+};
+
+// expiring or voiding a grant stamps the instant; it no longer counts toward the balance
+function endGrant(kind: 'expire' | 'void'): Semantics {
+  return async (ctx) => {
+    const id = at(ctx, 'id');
+    if (!ctx.get(GRANT, id)) return grantMissing(ctx, id);
+    return ctx.reply(await ctx.write(GRANT, id, { ...(kind === 'void' ? { voided_at: ctx.now() } : { expires_at: ctx.now() }), updated: ctx.now() }, `credit_grant.${kind}`));
+  };
+}
+
+// only the expiry and metadata change
+const updateGrant: Semantics = async (ctx) => {
+  const id = at(ctx, 'id');
+  if (!ctx.get(GRANT, id)) return grantMissing(ctx, id);
+  const patch: Row = { updated: ctx.now() };
+  if (ctx.params.expires_at !== undefined) patch.expires_at = Math.trunc(Number(ctx.params.expires_at));
+  if (ctx.params.metadata !== undefined) patch.metadata = ctx.params.metadata;
+  return ctx.reply(await ctx.write(GRANT, id, patch, 'credit_grant.update'));
+};
+
+// the customer's live (unvoided, unexpired) monetary grants, summed per currency
+const creditBalance: Semantics = async (ctx) => {
+  const customer = typeof ctx.params.customer === 'string' ? ctx.params.customer : '';
+  if (!customer) return fail(ctx, 'Missing required param: customer.', 400, 'parameter_missing');
+  if (!ctx.row('customer', customer, { withDeleted: true })) return fail(ctx, `No such customer: '${customer}'`, 404, 'resource_missing');
+  const now = Number(ctx.now());
+  const byCurrency: Record<string, number> = {};
+  for (const g of ctx.rows(GRANT)) {
+    if (g.customer !== customer || g.voided_at != null) continue;
+    if (typeof g.expires_at === 'number' && g.expires_at <= now) continue;
+    const monetary = objectOf(objectOf(g.amount).monetary);
+    const cur = String(monetary.currency ?? 'usd');
+    byCurrency[cur] = (byCurrency[cur] ?? 0) + (Number(monetary.value) || 0);
+  }
+  const balances = Object.entries(byCurrency).map(([currency, value]) => ({
+    available_balance: { type: 'monetary', monetary: { currency, value } },
+    ledger_balance: { type: 'monetary', monetary: { currency, value } },
+  }));
+  return ctx.reply({ object: 'billing.credit_balance_summary', customer, balances, livemode: false });
+};
+
+// ── alerts: a usage threshold on a meter ──
+
+const ALERT = 'billing.alert';
+
+const createAlert: Semantics = async (ctx) => {
+  const params = ctx.params;
+  if (params.alert_type !== 'usage_threshold') return fail(ctx, 'Invalid alert_type: must be usage_threshold.', 400, 'parameter_invalid_string_enum');
+  if (typeof params.title !== 'string' || !params.title) return fail(ctx, 'Missing required param: title.', 400, 'parameter_missing');
+  const ut = params.usage_threshold && typeof params.usage_threshold === 'object' ? (params.usage_threshold as Row) : undefined;
+  if (!ut || ut.gte === undefined || typeof ut.meter !== 'string') return fail(ctx, 'Missing required param: usage_threshold[gte] and usage_threshold[meter].', 400, 'parameter_missing');
+  // the spec requires recurrence too (one_time: the alert fires once)
+  if (ut.recurrence === undefined || ut.recurrence === '') return fail(ctx, 'Missing required param: usage_threshold[recurrence].', 400, 'parameter_missing');
+  if (!ctx.get(METER, ut.meter)) return fail(ctx, `No such meter: '${ut.meter}'`, 400, 'resource_missing');
+  return ctx.reply(
+    await created(ctx, ALERT, {}, {
+      alert_type: 'usage_threshold', livemode: false, status: 'active', title: params.title,
+      usage_threshold: { gte: Math.trunc(Number(ut.gte) || 0), meter: ut.meter, recurrence: String(ut.recurrence), filters: null },
+    }),
+  );
+};
+
+const listAlerts: Semantics = async (ctx) =>
+  list(ctx, ALERT, where(ctx, newest(ctx, ALERT), {
+    alert_type: (a, v) => a.alert_type === v,
+    meter: (a, v) => objectOf(a.usage_threshold).meter === v,
+  }));
+
+function alertMove(kind: 'activate' | 'deactivate' | 'archive', operationId: string): Semantics {
+  return async (ctx) => {
+    const id = at(ctx, 'id');
+    const a = ctx.get(ALERT, id);
+    if (!a) return fail(ctx, `No such alert: '${id}'`, 404, 'resource_missing');
+    const refused = ctx.legal(ALERT, 'status', operationId, a.status, undefined, id);
+    if (refused) return ctx.refuse(refused);
+    const status = kind === 'activate' ? 'active' : kind === 'deactivate' ? 'inactive' : 'archived';
+    return ctx.reply(await ctx.write(ALERT, id, { status }, `billing_alert.${kind}`));
+  };
+}
+
+export const billing: Record<string, Semantics> = {
+  PostBillingMeters: createMeter,
+  PostBillingMetersIdDeactivate: activation('deactivate'),
+  PostBillingMetersIdReactivate: activation('reactivate'),
+  PostBillingMeterEvents: reportUsage,
+  GetBillingMetersIdEventSummaries: eventSummaries,
+  PostBillingCreditGrants: createGrant,
+  PostBillingCreditGrantsIdExpire: endGrant('expire'),
+  PostBillingCreditGrantsIdVoid: endGrant('void'),
+  PostBillingCreditGrantsId: updateGrant,
+  GetBillingCreditBalanceSummary: creditBalance,
+  PostBillingAlerts: createAlert,
+  GetBillingAlerts: listAlerts,
+  PostBillingAlertsIdActivate: alertMove('activate', 'PostBillingAlertsIdActivate'),
+  PostBillingAlertsIdDeactivate: alertMove('deactivate', 'PostBillingAlertsIdDeactivate'),
+  PostBillingAlertsIdArchive: alertMove('archive', 'PostBillingAlertsIdArchive'),
+};