TerminalReader

Source: src/Stripe/TerminalReader.ts

A Stripe Terminal Reader — a physical or simulated card reader that accepts in-person payments. registrationCode and location are create-only; changing location replaces the reader. label and metadata update in place. Destroy deletes the reader.

In test mode, register a simulated WisePOS E with registrationCode: "simulated-wpe" (or "simulated-s700" / "simulated-s710"). Simulated readers typically need a Terminal Location.

Creating a Reader

Simulated WisePOS E

const reader = yield* Stripe.TerminalReader("front-counter", {
  registrationCode: "simulated-wpe",
  label: "Front counter",
  location: locationId,
});

Physical reader with metadata

const reader = yield* Stripe.TerminalReader("pos-1", {
  registrationCode: pairingCode,
  label: "POS 1",
  location: location.id,
  metadata: { station: "1" },
});

Updating a Reader

const reader = yield* Stripe.TerminalReader("front-counter", {
  registrationCode: "simulated-wpe",
  label: "Front counter (updated)",
  location: locationId,
  metadata: { station: "1", floor: "lobby" },
});

Deleting a Reader

const reader = yield* Stripe.TerminalReader("front-counter", {
  registrationCode: "simulated-wpe",
  location: locationId,
});
// stack.destroy() deletes the reader