docs(crypto-to-fiat): expand comprehensive guide with sandbox access, compliance flows, and implementation details

[aimen74]

TL;DR

Completely rewrote the crypto-to-fiat payments documentation to provide comprehensive implementation guidance with detailed flows, endpoint references, and practical examples.

What changed?

• Replaced AI-generated placeholder content with detailed implementation documentation
• Added comprehensive getting started section with sandbox and production access instructions
• Introduced clientUserId concept and explanation for user management
• Added detailed compliance and payer onboarding flow with sequence diagrams
• Documented payment details setup process for payees with bank account registration
• Included complete payment flow documentation with webhook event references
• Added endpoint references for all crypto-to-fiat related API calls
• Provided design rationale and UX considerations for implementation decisions
• Added support information for USDC on Ethereum, Polygon, Arbitrum One, and Sepolia
• Included crosschain payment integration guidance for non-USDC currencies

How to test?

1. Create an account on the Request Network API Portal
2. Generate a Sandbox API key with crypto-to-fiat sandbox access
3. Test the complete flow using Sepolia testnet USDC and mock KYC documents
4. Follow the sequence diagrams for compliance, payment details, and payment flows
5. Use the EasyInvoice reference implementation to see the integration in action

Why make this change?

The previous documentation was AI-generated placeholder content that lacked practical implementation details. This rewrite provides developers with actionable guidance, complete API references, and clear flow diagrams needed to successfully integrate crypto-to-fiat payments into their applications.

[aimen74]

• docs(review): apply Tristan's two must-fix items from the final review #97
• docs(review): address Greptile review feedback across the stack #96
• docs(feedback): apply Tristan's revisions from RequestNetwork/request-api#806 #95
• docs(kyt): document KYT-screened payments as a use case + payee-destination field #94
• docs(secure-payments): document redirectUrl + redirectLabel #93
• docs(verify): fix broken cross-refs surfaced by mintlify broken-links #92
• docs(scripts): add Playwright screenshot capture scaffolding #91
• docs(content): add use-case pages, Dashboard + Secure Payment tools pages #90
• docs(content): refresh Tron coverage, batch-payment EVM scope, webhook 12-event list #89
• docs(nav): restructure navigation, remove legacy pages, retire Portal #88
• docs: fix broken links and clarify edge cases #87
• docs: add missing feature documentation for recent API changes #86
• docs: fix implementation discrepancies across API docs #85
• docs: remove beta banner and legacy SDK tab #78
• Remove AI-generated content warnings and update internal links #77
• docs(lifecycle): replace external image with local asset and remove AI-generated warning #76
• docs: remove AI-generated content warnings and simplify Request Scan page #75
• docs(resources): remove community page from navigation #74
• docs(supported-chains): add Tron network support and enhance currency documentation #73
• docs(supported-chains): streamline supported chains and currencies documentation #72
• docs(api-reference): add v2 endpoints overview and switch docs OpenAPI to v2-only spec Improve API Reference navigation by introducing a dedicated Endpoints Overview page in docs and wiring Mintlify OpenAPI rendering to a local v2-only spec. - add `api-re #71
• docs(authentication): simplify auth guide with API key vs Client ID methods and remove AI-generated content #70
• docs(fee-breakdowns): rewrite to focus on API response locations and reconciliation usage #69
• docs(protocol-fees): add protocol fees documentation and navigation #68
• docs(platform-fees): simplify configuration guide and remove AI-generated content warning #67
• docs(query-payments): rewrite with practical implementation focus and remove AI warning #66
• docs(query-requests): simplify and refactor query requests documentation for practical implementation #65
• docs(payment-detection): simplify content and remove AI warning #64
• docs(partial-payments): rewrite with step-by-step implementation guide and clarify API usage #63
• docs(standard-payments): remove AI warning, restructure content with step-by-step flow, and update API references #62
• docs(conversion-payments): rewrite with step-by-step implementation guide and remove AI-generated warning #61
• docs(payment-types): simplify overview and add payment type selection guidance #60
• docs(crypto-to-fiat): expand comprehensive guide with sandbox access, compliance flows, and implementation details #59 👈 (View in Graphite)
• docs(recurring-payments): rewrite with comprehensive workflow, security details, and practical implementation guide #58
• docs(batch-payments): add comprehensive implementation guide with examples, workflow diagrams, and demo videos #57
• docs(crosschain-payments): replace AI-generated content with comprehensive implementation guide #56
• docs(create-requests): rewrite with workflows, examples, and remove AI warning #55
• feat: add complete integration tutorial with Node.js backend and React frontend #54
• docs(getting-started): remove AI warning and refactor to focus on practical payment integration #53
• docs(api-portal): remove AI warning, add local screenshot, and update .gitignore #52
• docs: remove release notes section and streamline use cases to core features #51
• main

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

[greptile-apps]

Greptile Summary

This PR replaces AI-generated placeholder content in the crypto-to-fiat payments docs with a thorough, developer-focused guide covering sandbox/production access, clientUserId semantics, compliance and KYC flows, bank account registration, payment execution, and a webhook event reference table.

• Three sequence diagrams walk through the compliance, payment-details, and payment execution flows with participant labels and webhook event names.
• Endpoint reference sections link every flow step to the corresponding OpenAPI entry, but one diagram step (POST /request) is missing the /v2/ version prefix used everywhere else on the page.
• An H1 heading in the document body duplicates the frontmatter title, which Mintlify already renders as the page H1, breaking the heading hierarchy per AGENTS.md guidelines.

Confidence Score: 5/5

Documentation-only change with no executable code; safe to merge.

All changes are prose and Mermaid diagrams. The two findings are a missing /v2/ prefix in one diagram step and a duplicate H1 heading — neither blocks understanding of the integration or causes incorrect behavior at runtime.

api-features/crypto-to-fiat-payments.mdx — the Payment Details sequence diagram and the document's opening heading line.

Important Files Changed

Filename	Overview
api-features/crypto-to-fiat-payments.mdx	Complete rewrite replacing AI-generated placeholder content with detailed implementation docs covering sandbox access, compliance flows, payment detail registration, and webhook events. Two minor issues found: a missing /v2/ prefix on POST /request in the Payment Details sequence diagram, and a redundant H1 heading in the document body that conflicts with the frontmatter title.

Sequence Diagram

sequenceDiagram
participant Payer
participant Payee
participant Platform
participant RequestAPI
participant RequestTech
participant Blockchain
Note over Payer,RequestTech: 1. Compliance & KYC Flow
Payer->>Platform: Submit KYC data
Platform->>RequestAPI: POST /v2/payer
RequestAPI-->>Platform: webhook: compliance.updated (kycStatus)
Platform->>Payer: Show agreement iframe
Platform->>RequestAPI: "PATCH /v2/payer/{clientUserId}"
Note over Payee,RequestTech: 2. Payment Details Flow
Payee->>Platform: Submit bank account info
Platform->>RequestAPI: "POST /v2/payer/{clientUserId}/payment-details"
RequestAPI-->>Platform: webhook: payment_detail.updated (approved)
Platform->>RequestAPI: "POST /v2/request (isCryptoToFiatAllowed=true)"
Note over Payer,RequestTech: 3. Payment Execution Flow
Platform->>RequestAPI: "GET /v2/request/{requestId}/pay (calldata)"
Payer->>Blockchain: Send USDC to Request Tech
Blockchain-->>RequestTech: Payment received
RequestTech-->>RequestAPI: offramp_update
RequestAPI-->>Platform: webhook: payment.processing (subStatus)
RequestTech->>Payee: Fiat deposited to bank
RequestAPI-->>Platform: webhook: payment.confirmed

Loading

_{Reviews (2): Last reviewed commit: "docs(api-features): replace legacy domai..." | Re-trigger Greptile}

[greptile-apps]

_{1 file reviewed, 5 comments}

_{Edit Code Review Agent Settings | Greptile}

[rodrigopavezi]

Merge activity

• May 12, 4:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• May 12, 4:17 PM UTC: Graphite rebased this pull request as part of a merge.
• May 12, 4:18 PM UTC: @rodrigopavezi merged this pull request with Graphite.