docs(payments): replace merchant onboarding with API Quick Start (WCPM-385)#50
Merged
Conversation
… (WCPM-385) Replaces the dashboard-flow oriented "Merchant Onboarding" page with an integration-focused "Quick Start" that takes a partner from zero to a live payment in four steps: 1. Create an API key in the Merchant Dashboard 2. Authenticate requests with the Api-Key header 3. Create a merchant via POST /v1/merchants 4. Create a payment via POST /v1/payments Adds a redirect /payments/merchant/onboarding -> /payments/merchant/quickstart so existing dashboard CTAs (EXTERNAL_LINK.INTEGRATION_GUIDE) keep working. Drops the previous KYB/account-provisioning content — that flow is already surfaced inline in the merchant dashboard UI; duplicating it in docs added no value and made the page miss its real audience (developers integrating the API). Nav update applies to both stable (2026-02-18) and preview (2026-02-19.preview) versions.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Rename "Quick Start" to "Quickstart" (one word, matches industry convention) - Rename sidebar group "Merchant Dashboard" to "WalletConnect Pay for Merchants" — page is integration-oriented, not dashboard-oriented - Drop "Merchant Dashboard" branding from body copy in favour of plain "the dashboard" (no need to repeat the product name inside the docs) - Add a contact-sales callout for readers without dashboard access yet - Remove the "What's next" footer — webhooks/settlements/API-reference links belong in dedicated docs, not in a teaser list at the bottom of the quickstart
…y-regenerate note (WCPM-385)
- Promote the trailing one-liner about GET /v1/payments/{id}/status into a
full Step 5 with a curl example, the response shape, and an explanation
of the isFinal / pollInMs polling contract
- Add a Tip recommending webhooks over polling for production use
- Drop the "regenerate it from the same page, the previous value stops
working immediately" sentence — the immediate-invalidation behaviour
described doesn't match what the dashboard actually does
rtomas
approved these changes
May 18, 2026
| <Step title="Create an API key" stepNumber="1"> | ||
|
|
||
| 1. Open the [dashboard](https://merchant.pay.walletconnect.com) and sign in. | ||
| 2. Navigate to **API Keys** in the sidebar. |
Member
There was a problem hiding this comment.
Suggested change
| 2. Navigate to **API Keys** in the sidebar. | |
| 2. Navigate to **API Keys** inside the Settings option. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the dashboard-flow oriented Merchant Onboarding page with an integration-focused Quick Start page that takes a partner from zero to a live payment in four steps:
Api-Keyheader (with aWCP-Versiontip)POST /v1/merchants(withIdempotency-Key)POST /v1/payments(using theMerchant-Idheader)Each step links into the corresponding
/api-reference/latest/...page for the full schema.Why
The previous page documented an internal dashboard onboarding flow (signup → email verify → KYB) that:
EXTERNAL_LINK.INTEGRATION_GUIDE) sends a developer here looking for how to integrate, not screenshots of the signup flow they just went through.The new Quick Start gives that developer audience the actual code path they need.
URL stability
Added a redirect so existing callers don't break:
{ "source": "/payments/merchant/onboarding", "destination": "/payments/merchant/quickstart" }Validated locally via
mint dev: the static path-to-path redirect resolves with a 307 in dev. (Path-to-regexp/glob redirects only resolve in prod — that's a known Mintlify dev-server limitation, see PR #46 — but static paths like this one DO work in dev.)Scope
payments/merchant/onboarding.mdx→ deletedpayments/merchant/quickstart.mdx→ createddocs.json→ nav updated in both the stable (2026-02-18) and preview (2026-02-19.preview) version blocks; one new redirect entryDropped the previous KYB/account-provisioning content. That flow lives in the dashboard UI; a duplicate doc page added no value and obscured the integration story.
Test plan
mint dev—/payments/merchant/quickstartrenders 200, all four steps rendermint dev—/payments/merchant/onboarding→ 307 →/quickstartmint dev—/api-reference/latest/post-v1-merchantsstill resolves (unchanged redirect)/api-keys→ lands on Quick Start/merchantsempty state → still lands onPOST /v1/merchants(unchanged)Related
INTEGRATION_GUIDE+API_CREATE_MERCHANT)/api-reference/latest/...redirect this PR's quickstart depends on)