Prerequisites
- A Lumx account with a Sandbox API key
- Claude Code installed and authenticated
- A project (or empty directory) where the integration should land
Step 1 — Get your Lumx credentials
From the Lumx Dashboard, open Developers → API Keys and copy a Sandbox key. See Authentication. Keys are only shown once.Step 2 — Store the key locally
Drop the secrets into the project’s env file. Keep it out of git..env.local
.gitignore (append if missing)
CLAUDE.md
Step 3 — Hook up the Lumx docs MCP
The Lumx documentation ships as an MCP server so Claude Code can pull endpoint shapes and field definitions on demand — no copying schemas into the prompt. Run:Add the MCP server
Step 4 — Paste the prompt
In the Claude Code session, paste the prompt below.Lumx integration prompt
Step 5 — Verify end to end
Claude Code will write the files, run the project, and (because the prompt asks for it) call each route with curl to confirm the shape. Walk the UI flow once: create a customer, open the verification link, start an on-ramp, and watch the transaction status update.Example: a server-side Lumx helper
The prompt aims for this shape. Drop it in directly if you’d rather skip the agent for the helper itself.server/lumx.ts
FAQ
Can I connect Lumx's docs MCP to Claude Code?
Can I connect Lumx's docs MCP to Claude Code?
Yes — Lumx ships an MCP server that surfaces every page in this site as a tool. See MCP server for setup. Claude Code will pull endpoint shapes and field definitions on demand.
Claude Code wants to commit my .env.local. What now?
Claude Code wants to commit my .env.local. What now?
Reject the change and add
.env*.local to .gitignore first. If the file was already committed, rotate the key in the Dashboard and remove the file with git rm --cached .env.local.How do I switch from Sandbox to Production?
How do I switch from Sandbox to Production?
Replace
LUMX_API_KEY with a Production key and set LUMX_ENV=production. Production access requires a call with the Lumx team — see Environments.Can the same prompt work in a fresh, empty repo?
Can the same prompt work in a fresh, empty repo?
Yes. The prompt asks Claude Code to confirm a stack before scaffolding — just answer with the framework you want (Next.js, FastAPI, Rails, etc.) and it will set up an idiomatic project.
Next steps
- Create a customer — full reference for the customer payload
- Webhooks — subscribe to status changes instead of polling
- MCP server — give Claude Code structured access to the Lumx docs