docs: fix broken links and clarify edge cases#87
docs: fix broken links and clarify edge cases#87rodrigopavezi wants to merge 3 commits intodocs/add-missing-feature-docsfrom
Conversation
- Fix 2 broken href="#" links in invoicing.mdx (Fork EasyInvoice -> GitHub repo, View Invoicing Examples -> integration guide) - Fix 2 broken href="#" links in checkout.mdx (Payment Widget Button -> checkout demo URL, both instances) - Clarify crosschain minimum amount: "greater than 1 USD equivalent" with example, not just "greater than 1" - Add ERC-7828 checksum clarification in payee-destinations.mdx (auto- generated by API, no manual computation needed) - Add error handling table to payouts.mdx (400, 401, 404, 429)
Greptile SummaryThis PR is a documentation cleanup pass that fixes five broken Key changes:
Confidence Score: 4/5Safe to merge after resolving the boundary-condition wording in crosschain-payments.mdx — all other changes are straightforward link fixes or additive clarity improvements. One P1 finding: the "amounts under $1" clause in crosschain-payments.mdx is directly contradicted by the "greater than 1" condition in the same sentence, which could cause developers to send exactly $1.00 and receive an unexpected rejection. All other findings are P2. Score is 4 rather than 5 due to this current factual inconsistency in docs that will go public. api-features/crosschain-payments.mdx — boundary condition wording on line 49 needs a one-word fix ("under $1" → "of $1 or less") Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant API as Request Network API
participant Bridge as LiFi Bridge
Dev->>API: POST /v2/request (amount greater than 1 USD)
API-->>Dev: requestId
Dev->>API: GET /v2/request/requestId/routes
API-->>Dev: routes array (crosschain + samechain options)
Dev->>API: GET /v2/request/requestId/pay (chain + token selected)
API-->>Dev: transactions array + metadata
alt needsApproval is true
Dev->>Bridge: send approval transaction
Bridge-->>Dev: approval confirmed
end
Dev->>Bridge: send payment or bridge transaction
Bridge-->>API: bridge execution confirmed
API-->>Dev: webhook payment confirmed on destination chain
Reviews (1): Last reviewed commit: "docs: fix remaining broken links, clarif..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| <Steps> | ||
| <Step title="Create the request"> | ||
| Create a request with a `paymentCurrency` in the supported stablecoins and networks, and `amount` greater than 1 (crosschain execution under 1 stablecoin is not allowed). | ||
| Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts under $1 due to bridge minimums. |
There was a problem hiding this comment.
The sentence contains a subtle but meaningful contradiction for developers who test edge cases:
- First clause: "The
amountmust be greater than 1 USD equivalent" → strictly> 1.00, so exactly 1.00 USDC is rejected - Second clause: "crosschain routes are not available for amounts under $1" → strictly
< 1.00, which would imply exactly 1.00 USDC is allowed
A developer who reads both halves could reasonably conclude that 1.00 USDC is a valid amount, only to get a rejection at runtime. The first half is correct; the second half should be aligned with it.
| Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts under $1 due to bridge minimums. | |
| Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts of $1 or less due to bridge minimums. |
|
|
||
| | Status | Meaning | | ||
| |--------|---------| | ||
| | `400` | Invalid request body — check required fields and currency IDs | | ||
| | `401` | Authentication failed — verify your `x-api-key` header | | ||
| | `404` | Request or recurring payment not found | | ||
| | `429` | Rate limited — back off and retry | | ||
|
|
||
| For batch payouts, a `400` may indicate that payments span multiple networks (all must be on the same chain). |
There was a problem hiding this comment.
500 status code in error table
The error table covers client-side errors (400, 401, 404, 429) but omits 500 Internal Server Error. Per the AGENTS.md style guide, API documentation should "Explain all HTTP status codes and error handling." Users hitting a 500 (e.g., during a transient upstream failure) may be confused about whether to retry, and omitting it can lead to silent failures in production integrations.
Consider adding a row:
| Status | Meaning |
|---|---|
500 |
Server error — safe to retry with exponential backoff |
Context Used: AGENTS.md (source)
- Fix stale "9 EVM chains, 150+ currencies" in payment-detection.mdx - Fix checkout link to /use-cases/subscriptions (AI-warned page) -> /api-features/recurring-payments - Add Info callout in secure-payments.mdx clarifying path :token vs query token param naming collision - Add PUT response note in payee-destinations.mdx - Fix batch payout example: invoiceCurrency should be "USD" not "USDC-base" - Add null check for approvalTransactionIndex in crosschain code example
Align docs with request-api PRs #627 and #628. - Add sourceAmount metadata field to crosschain response example and docs - Add Info callout explaining approval transactions are always included in crosschain calldata (forceApprovalTransactions behavior for USDT zero-reset compatibility) - Document that wallet param is optional for Tron payments across secure-payments GET /:token, GET /:token/pay, and supported chains page (API now uses dead address fallback instead of 400 error)
1 participant
Summary
Fixes all remaining issues found during the preview review before public release.
Broken links fixed
href="#"→ GitHub repo URLhref="#"→ integration guidehref="#"→ checkout demo URL (2 instances)Clarity improvements
<Info>callout explaining that the ERC-7828 checksum is auto-generated by the APITest plan