Skip to content

docs(headless-sdk): add a Test mode section - #100

Open
enesozturk wants to merge 3 commits into
mainfrom
docs/headless-test-mode
Open

docs(headless-sdk): add a Test mode section#100
enesozturk wants to merge 3 commits into
mainfrom
docs/headless-test-mode

Conversation

@enesozturk

Copy link
Copy Markdown
Contributor

Documents test mode for the Headless SDK — run the full flow with no real wallet and no real funds.

Adds a "Test mode" section to the Headless Implementation page covering the two required pieces:

  1. a test API key (wcp_test_…) on the server proxy (synthetic settlement, see Test mode), and
  2. the testMode flag on usePaymentSession / createPaymentController (mock wallet + signer, confirm via the test /transition endpoint).

Plus the extra /transition proxy route the test transport calls, and a note that both the client flag and the server test key are required.

Related (code)

  • WalletConnect/buyer-experience#1174 — transition on Transport + EngineClient
  • WalletConnect/buyer-experience#1177 — testMode + mock wallet/signer/transport
  • WalletConnect/buyer-experience#1178 — the example wired for ?test

(Docs merge after the SDK PRs ship, since testMode needs the released packages.)

🤖 Generated with Claude Code

How to run the full flow with no real wallet and no real funds: a `wcp_test_`
API key on the proxy + the `testMode` flag on usePaymentSession /
createPaymentController, plus the extra `/transition` proxy route the test
transport calls. Notes that both the client flag and the server test key are
required.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wc-pay-docs 🟢 Ready View Preview Aug 27, 2026, 12:33 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

The /en/api-keys route does not exist; the key lives behind the navbar
Live/Test dropdown → Developers → API Keys.
…y key

Test vs live is a property of the payment (created with a test merchant
key), not of the proxy's wallet/gateway key.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant