Skip to content

docs: test mode — concept page, authentication page, test-first quickstart#79

Open
riveign wants to merge 2 commits into
mainfrom
docs/test-mode
Open

docs: test mode — concept page, authentication page, test-first quickstart#79
riveign wants to merge 2 commits into
mainfrom
docs/test-mode

Conversation

@riveign

@riveign riveign commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

What

Public docs coverage for test mode, targeting the Jul 15 GA. Follows the Test Mode — Public Docs Alignment doc + the comments on it. Opened as a draft to iterate on — comment freely.

New pages

  • payments/merchant/test-mode — the concept page: account-level test/live, switch-by-key (no test flag/param anywhere), wcp_test_ prefix, what test payments do/don't do (no on-chain execution, synthetic test:{paymentId} tx hash, fixed 1-unit amounts), webhooks fire in test mode, go-live path. Includes an environment diagram with test mode in purple (per Rocky's diagram ask + Tomas R.'s purple-as-test-color proposal).
  • api-reference/authentication — the previously-missing auth page: Api-Key header, test vs live key semantics, 401/403, key safety.

Edits

  • Quickstart reframed test-first: step 1 creates a test key, examples use wcp_test_, synthetic txId in the status example, closing "Go live" section.
  • Overview — test-before-live line + Merchant Quickstart / Test Mode cards in Get Started.
  • Wallet AI-prompt blurbs (flutter + react-native) — the two contradictory "Test Payment Links" sections now agree (dashboard self-serve); the docs' last "sandbox" mention is gone (canonical term: test mode).
  • Nav (docs.json) — both version blocks updated.

Decisions baked in (from the alignment thread)

  • Devs use the same API as today — the environment is selected by the key alone.
  • Docs explicitly state that responses/webhooks carry no environment field (it's determined by your key).
  • The &_t=1 gateway tag is treated as an implementation detail — not documented.

Not in this PR (follow-ups)

  • OpenAPI snapshots are stale — they still advertise the dead not_sandbox_api_key enum. They should be regenerated, not hand-edited, so the JSONs are untouched here.
  • BX page — Rocky asked whether test mode needs a page on the buyer-experience side; open question, happy to add in a follow-up.
  • Dashboard screenshots of test-key provisioning (and purple test-mode UI) once the GA build is final.

mint broken-links passes.

🤖 Generated with Claude Code

…t test-first

- New payments/merchant/test-mode page: account-level test/live model,
  switch-by-key, wcp_test_ prefix, synthetic tx hashes, webhook behavior,
  go-live path; env diagram in purple (test-mode color)
- New api-reference/authentication page: Api-Key header, test vs live
  key semantics, no environment field on responses
- Quickstart reframed test-first with wcp_test_ examples + go-live section
- Overview: test-before-live messaging + merchant/test-mode cards
- Reconcile the two contradictory wallet Test Payment Links blurbs;
  remove the last "sandbox" mention (term is "test mode")

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@riveign riveign marked this pull request as ready for review July 10, 2026 07:39
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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