Skip to content

docs(conversion-payments): rewrite with step-by-step implementation guide and remove AI-generated warning#61

Open
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_refocus_payment-types-overview_on_type_selection_clean_up_api-features_payment-types-overview.mdx_to_avoid_overlap_with_request_workflow_documentation_and_keep_this_page_focused_on_payment_type_navigation_and_dfrom
03-02-docs_api-features_rewrite_conversion-payments_with_verified_api_behavior_refactor_api-features_conversion-payments.mdx_from_ai-generated_placeholder_content_into_endpoint-driven_documentation_aligned_with_current_api_behavior._-
Open

docs(conversion-payments): rewrite with step-by-step implementation guide and remove AI-generated warning#61
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_refocus_payment-types-overview_on_type_selection_clean_up_api-features_payment-types-overview.mdx_to_avoid_overlap_with_request_workflow_documentation_and_keep_this_page_focused_on_payment_type_navigation_and_dfrom
03-02-docs_api-features_rewrite_conversion-payments_with_verified_api_behavior_refactor_api-features_conversion-payments.mdx_from_ai-generated_placeholder_content_into_endpoint-driven_documentation_aligned_with_current_api_behavior._-

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 2, 2026

TL;DR

Updated conversion payments documentation to clarify that it supports any currency-to-currency conversion, not just fiat-to-crypto, and replaced AI-generated content with accurate implementation details.

What changed?

  • Removed AI-generated content warning and disclaimer
  • Updated description to clarify conversion payments work between any two currencies, not just fiat-to-crypto
  • Replaced conceptual mermaid diagram with step-by-step implementation guide using actual API endpoints
  • Added detailed explanation of conversion behavior for single vs multi-payment scenarios
  • Updated supported currencies section to reference the token list and supported chains documentation
  • Removed subscriptions use case and simplified card layout
  • Updated API reference section to point to the OpenAPI documentation

How to test?

Review the updated documentation to ensure:

  • The step-by-step guide accurately reflects the API workflow
  • API endpoint references are correct and functional
  • Currency conversion examples make sense for the intended use cases
  • Links to supporting documentation (token list, supported chains) are working

Why make this change?

The previous documentation was AI-generated and contained inaccuracies about conversion payments being limited to fiat-to-crypto scenarios. This update provides accurate, implementation-focused guidance that reflects the actual API capabilities and helps developers understand how to use conversion payments for any currency pair.

…avior

Refactor `api-features/conversion-payments.mdx` from AI-generated placeholder
content into endpoint-driven documentation aligned with current API behavior.
- removed AI warning banner and unsupported assumptions
- rewrote page to explain conversion as “different invoice and payment currencies”
  instead of fiat-only behavior
- updated conversion flow to a step-based implementation using:
  - POST /v2/request
  - GET /v2/request/{requestId}/pay
  - GET /v2/request/{requestId}
- documented status-level conversion fields used in practice:
  - amountInUsd
  - conversionRate
  - rateSource
  - conversionBreakdown (for partial/multi-payment cases)
- replaced invalid currency example `USDC-base-base` with valid `USDC-base`
- removed hidden/unsupported use-case references and kept only active links
- standardized API docs reference to canonical OpenAPI URL:
  https://api.request.network/open-api
Copy link
Member Author

aimensahnoun commented Mar 2, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@aimensahnoun aimensahnoun self-assigned this Mar 2, 2026
@aimensahnoun aimensahnoun changed the title docs(api-features): rewrite conversion-payments with verified API behavior Refactor api-features/conversion-payments.mdx from AI-generated placeholder content into endpoint-driven documentation aligned with current API behavior. - removed AI warning ban docs(conversion-payments): rewrite with step-by-step implementation guide and remove AI-generated warning Mar 2, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 2, 2026 12:08
@greptile-apps
Copy link

greptile-apps bot commented Mar 2, 2026

Greptile Summary

This PR successfully removes AI-generated placeholder content and replaces it with accurate, implementation-focused documentation for conversion payments. The updated page correctly clarifies that conversion payments work between any two currencies (not just fiat-to-crypto) and provides a clear step-by-step implementation guide using actual API endpoints.

Key improvements:

  • Removed AI-generated warning banner and inaccurate assumptions
  • Rewrote description to accurately reflect any currency-to-currency conversion capability
  • Replaced conceptual mermaid diagram with practical <Steps> component showing real API workflow (POST /v2/request, GET /v2/request/{requestId}/pay, GET /v2/request/{requestId})
  • Documented actual API response fields (amountInUsd, conversionRate, rateSource, conversionBreakdown)
  • Corrected invalid currency format from USDC-base-base to valid USDC-base
  • Updated links to use internal navigation paths and canonical OpenAPI documentation
  • Follows Mintlify technical writing guidelines with proper component usage

The documentation is well-structured, uses appropriate Mintlify components, and all internal links have been verified to exist.

Confidence Score: 5/5

  • This documentation update is safe to merge with no issues
  • Documentation-only change that improves accuracy and clarity. All referenced links verified to exist, follows established Mintlify patterns, uses correct currency format, and aligns with technical writing guidelines from AGENTS.md
  • No files require special attention

Important Files Changed

Filename Overview
api-features/conversion-payments.mdx Replaced AI-generated content with verified implementation guide using proper Mintlify components and accurate API endpoints

Last reviewed commit: 64bce28

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.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

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