Uh oh!
There was an error while loading. Please reload this page.
docs(payment-detection): simplify content and remove AI warning - #64
Conversation
api-features/payment-detection.mdx to remove AI-generated placeholder framing and align the page with legacy-supported detection concepts while keeping Mintlify sGreptile SummaryThis PR simplifies the Payment Detection documentation by removing an AI-generated content warning, condensing prose descriptions, replacing the inline network list with a link to the supported chains page, and deleting the Payment States section.
Confidence Score: 4/5Safe to merge after deciding whether to restore the Payment States enum — all other changes are straightforward prose simplifications. The only changed file is documentation. The prose simplifications and link update are clean. The one real concern is that the Payment States section — which listed the exact state strings the API returns — was deleted without a replacement. Developers building integrations from this page won't find api-features/payment-detection.mdx — specifically around the removed Payment States content near the end of the file. Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant API as Request Network API
participant Chain as Blockchain
participant Subgraph as Subgraph Indexer
participant WH as Webhook Endpoint
Dev->>API: POST /v2/request (create request)
API-->>Dev: requestId + paymentReference (16-char)
Dev->>Chain: Payer sends tx with paymentReference
Chain-->>Subgraph: New transaction event
Subgraph->>API: Payment reference matched
API->>API: Validate amount, currency, recipient
API->>API: Update request status (created → paid)
API-->>WH: POST webhook (payment event)
Dev->>API: "GET /v2/request/{requestId}"
API-->>Dev: Updated payment status
Reviews (2): Last reviewed commit: "docs(api-features): refine payment-detec..." | Re-trigger Greptile |
Merge activity
|
…urate guidance
Update `api-features/payment-detection.mdx` to remove AI-generated placeholder framing and align the page with legacy-supported detection concepts while keeping Mintlify structure.
- removed AI warning banner and legacy “stable docs” dependency messaging
- tightened overview and flow language around reference-based payment detection
- kept core detection lifecycle intact:
- payment reference generation
- blockchain monitoring
- automatic validation + status updates
- webhook triggering
- clarified API access point for status checks with `GET /v2/request/{requestId}`
- replaced hardcoded supported-network lists with canonical internal reference:
`/resources/supported-chains-and-currencies`
- kept crosschain detection explanation and webhook sections, but removed over-specific/unverified claims
- removed rigid payment-state matrix to avoid inaccurate state assumptions across flows
- verified internal links and removed legacy-domain references from the pageb89f3dd to
db11d4bCompareUh oh!
There was an error while loading. Please reload this page.
| - **`overpaid`** - Payment exceeds expected amount | ||
| - **`refunded`** - Payment was refunded | ||
| ## What's Next? |
There was a problem hiding this comment.
The deleted "Payment States" section documented the exact state values returned by the API (created, pending, partially_paid, paid, overpaid, refunded). These are string enum values that developers must match in their code to handle webhook payloads and polling responses correctly. The replacement in section 3 — "for example partially paid or fully paid" — is informal and omits created, pending, overpaid, and refunded, meaning any developer building state-based UI or business logic from this page alone will be missing states their integration must handle.
TL;DR
Simplified and streamlined the Payment Detection documentation by removing AI-generated content warnings and reducing verbose explanations.
What changed?
How to test?
Review the updated documentation page to ensure:
Why make this change?
The documentation was overly verbose and contained redundant information. This change makes the content more accessible and easier to digest while maintaining all essential technical details. Removing the AI-generated warning also presents the content with more confidence.