Skip to content

docs(secure-payments): add standalone Secure Payment Pages docs and API reference, clarify support model, and simplify integration guidance#48

Open
aimensahnoun wants to merge 1 commit intomainfrom
02-12-docs_secure-payments_add_standalone_secure_payment_pages_docs_and_api_reference_clarify_support_model_and_simplify_integration_guidance
Open

docs(secure-payments): add standalone Secure Payment Pages docs and API reference, clarify support model, and simplify integration guidance#48
aimensahnoun wants to merge 1 commit intomainfrom
02-12-docs_secure-payments_add_standalone_secure_payment_pages_docs_and_api_reference_clarify_support_model_and_simplify_integration_guidance

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Feb 12, 2026

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:

  • New feature overview page explaining the secure payment flow
  • API reference page with detailed endpoint documentation
  • Support coverage page for networks and currencies
  • Step-by-step integration guide with code examples

The documentation focuses on the merchant integration experience with:

  • Clear explanation of the contract safety validation feature
  • Proper URL format with token query parameter
  • Complete request/response examples for all endpoints
  • Authentication options for both server and client implementations

The navigation structure has been updated to place Secure Payment Pages as its own feature area within the API Features section.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Secure Payment Pages documentation covering hosted payment URL flow, payer interface redirection, and transaction verification
    • Added Secure Payments API reference with POST and GET endpoint specifications, authentication options, and error responses
    • Added supported networks and currencies reference guide with validation steps and preflight checklist
    • Updated documentation navigation menu

@aimensahnoun aimensahnoun self-assigned this Feb 12, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

Added 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

Cohort / File(s) Summary
Secure Payment Pages Documentation
api-features/secure-payment-pages.mdx, api-features/secure-payment-supported-networks-and-currencies.mdx
Added feature documentation covering the hosted payment flow (creation, redirect, review, signing), supported networks/currencies query mechanism, and verification checklist for currency/network validation.
Secure Payments API Reference
api-reference/secure-payments.mdx
Added API reference documenting POST /v2/secure-payments and GET /v2/secure-payments/:token endpoints, including authentication methods, request/response examples for single and batch payments, and HTTP status outcomes.
Documentation Configuration
docs.json
Updated navigation structure to include new Secure Payment Pages group (two pages) under API Features and new Secure Payments page under API Reference; minor formatting adjustments to navbar and footer links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: adding Secure Payment Pages documentation, API reference, and clarifying the support model for integration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 02-12-docs_secure-payments_add_standalone_secure_payment_pages_docs_and_api_reference_clarify_support_model_and_simplify_integration_guidance

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Member Author

aimensahnoun commented Feb 12, 2026

@greptile-apps
Copy link

greptile-apps bot commented Feb 12, 2026

Greptile Overview

Greptile Summary

This 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:

  • Feature overview page (api-features/secure-payment-pages.mdx) explaining the secure payment flow with contract safety validation
  • Support coverage page (api-features/secure-payment-supported-networks-and-currencies.mdx) linking to existing currency endpoints
  • API reference page (api-reference/secure-payments.mdx) with detailed endpoint documentation using ParamField components
  • Navigation updates adding a new "Secure Payment Pages" group under API Features

Documentation quality:

  • All pages include required YAML frontmatter with descriptive titles and descriptions
  • Proper use of Mintlify components: Steps, RequestExample, ResponseExample, ParamField, Card, CardGroup, Info
  • Complete request/response examples with realistic data
  • Clear cross-references between related documentation pages
  • Consistent terminology and structure throughout

The documentation is well-structured, user-focused, and follows the technical writing guidelines from AGENTS.md.

Confidence Score: 5/5

  • This PR is safe to merge with no issues found
  • All documentation follows established patterns, uses proper Mintlify components, includes complete examples, and maintains consistency with existing documentation structure
  • No files require special attention

Important Files Changed

Filename Overview
api-features/secure-payment-pages.mdx New feature overview page with clear documentation flow, proper Mintlify components, and complete examples
api-features/secure-payment-supported-networks-and-currencies.mdx Support coverage documentation with API examples and proper cross-references to existing resources
api-reference/secure-payments.mdx API reference with detailed endpoint documentation, proper ParamField usage, and complete request/response examples
docs.json Navigation structure updates add Secure Payment Pages section and API reference link with proper formatting fixes

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

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`
@aimensahnoun aimensahnoun force-pushed the 02-12-docs_secure-payments_add_standalone_secure_payment_pages_docs_and_api_reference_clarify_support_model_and_simplify_integration_guidance branch from 638e370 to e3b2264 Compare February 13, 2026 14:32
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +87 to +92
## Status outcomes

- `200`: token is valid and payable
- `403`: token expired or status is not payable
- `404`: token not found
- `409`: payment already completed
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

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.

2 participants