docs(secure-payments): add standalone Secure Payment Pages docs and API reference, clarify support model, and simplify integration guidance#48
Conversation
WalkthroughAdded comprehensive documentation for a new Secure Payment Pages feature, including a hosted payment URL flow, supported networks and currencies reference, and API reference documentation for two endpoints. Configuration file updated to include new documentation pages. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Greptile OverviewGreptile SummaryThis PR adds comprehensive documentation for the Secure Payment Pages feature across three new documentation files and updates the navigation structure. The documentation follows Mintlify best practices with proper component usage, clear structure, and complete code examples. Key additions:
Documentation quality:
The documentation is well-structured, user-focused, and follows the technical writing guidelines from Confidence Score: 5/5
Important Files Changed
|
Re-add openapi source under API > API Reference > Endpoints in docs.json Keep manual Secure Payments feature/reference pages unchanged Align navigation config with expected API reference setup and PR review feedback`
638e370 to
e3b2264
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@api-features/secure-payment-pages.mdx`:
- Around line 87-92: The status code list is ambiguous because it's placed after
the POST create example but actually applies to GET /v2/secure-payments/:token;
update the doc in secure-payment-pages.mdx by either (a) prefixing the list with
a clear heading like "GET /v2/secure-payments/:token — token status outcomes" so
it’s unambiguously tied to the GET endpoint, or (b) split into two subsections
labelled "POST /v2/secure-payments — create outcomes" (include 201 Created and
any POST-specific codes) and "GET /v2/secure-payments/:token — token status
outcomes" (keep 200, 403, 404, 409), ensuring the POST create example remains
with the POST outcomes and the GET list is clearly attributed to the GET
endpoint.
| ## Status outcomes | ||
|
|
||
| - `200`: token is valid and payable | ||
| - `403`: token expired or status is not payable | ||
| - `404`: token not found | ||
| - `409`: payment already completed |
There was a problem hiding this comment.
Ambiguous status codes — clarify which endpoint these apply to.
These status codes (200, 403, 404, 409) correspond to GET /v2/secure-payments/:token based on the API reference page, but they're placed directly after the POST create example with no endpoint label. The POST response example above shows 201 Created, which isn't listed here. An integrator reading sequentially will likely assume these are POST outcomes.
Either prefix with the endpoint (e.g., "GET token status outcomes") or split into two subsections covering both POST and GET status codes.
🤖 Prompt for AI Agents
In `@api-features/secure-payment-pages.mdx` around lines 87 - 92, The status code
list is ambiguous because it's placed after the POST create example but actually
applies to GET /v2/secure-payments/:token; update the doc in
secure-payment-pages.mdx by either (a) prefixing the list with a clear heading
like "GET /v2/secure-payments/:token — token status outcomes" so it’s
unambiguously tied to the GET endpoint, or (b) split into two subsections
labelled "POST /v2/secure-payments — create outcomes" (include 201 Created and
any POST-specific codes) and "GET /v2/secure-payments/:token — token status
outcomes" (keep 200, 403, 404, 409), ensuring the POST create example remains
with the POST outcomes and the GET list is clearly attributed to the GET
endpoint.

Create a dedicated Secure Payment Pages feature section with integration-focused flow
Preview Link
https://requestnetwork-02-12-docs-secure-payments-add-standalone-se.mintlify.app/api-setup/getting-started
This PR adds comprehensive documentation for the Secure Payment Pages feature, including:
The documentation focuses on the merchant integration experience with:
The navigation structure has been updated to place Secure Payment Pages as its own feature area within the API Features section.
Summary by CodeRabbit