Skip to content

docs: fix broken links and clarify edge cases #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodrigopavezi wants to merge 4 commits into
base: docs/add-missing-feature-docs
Choose a base branch
from
Open

docs: fix broken links and clarify edge cases #87

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22b9b2b
docs: fix remaining broken links, clarify edge cases
rodrigopavezi Mar 30, 2026
e20b8a1
docs: second review pass fixes
rodrigopavezi Mar 31, 2026
3de5d35
docs: document forceApprovalTransactions and Tron wallet optional
rodrigopavezi Mar 31, 2026
7879e82
docs: update for v0.18.0 API, secure payment v0.3.0, and auth API v0.3.1
rodrigopavezi Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-features/crosschain-payments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Crosschain payments work only with mainnet funds (real money). Test networks are

<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.
Copy link
Copy Markdown

@greptile-apps greptile-apps bot Mar 30, 2026

Choose a reason for hiding this comment

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

P1 Boundary condition inconsistency: "greater than 1" vs "under $1"

The sentence contains a subtle but meaningful contradiction for developers who test edge cases:

  • First clause: "The amount must 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.

Suggested change
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.


Create the request via [POST /v2/request](https://api.request.network/open-api/#tag/v2request/POST/v2/request).
</Step>
Expand Down
5 changes: 5 additions & 0 deletions api-features/payee-destinations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,13 @@ A destination ID combines the interop address with the token address:
This encodes:
- **Wallet:** `0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7`
- **Chain:** Base (chainId `8453`)
- **Checksum:** `ABCD1234` (auto-generated by the API for address verification)
- **Token:** USDC (`0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913`)

<Info>
The checksum portion (`#ABCD1234`) is generated automatically by the API when you create a destination. You do not need to compute it yourself.
</Info>

## How It Works

<Steps>
Expand Down
11 changes: 11 additions & 0 deletions api-features/payouts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,17 @@ See [Recurring Payments](/api-features/recurring-payments) for the full lifecycl
- `GET /v2/payouts/recurring/:id` — Check status and next payment date
- `PATCH /v2/payouts/recurring/:id` — Cancel or unpause

## Error Handling

| 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).
Comment on lines +88 to +96
Copy link
Copy Markdown

@greptile-apps greptile-apps bot Mar 30, 2026

Choose a reason for hiding this comment

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

P2 Missing 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)


## Endpoint Reference

<CardGroup cols={2}>
Expand Down
18 changes: 9 additions & 9 deletions use-cases/checkout.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,19 +123,19 @@ Not sure which approach fits your needs? [See our detailed comparison of integra

## Developer Tools

<Card
title="Payment Widget Button"
<Card
title="Payment Widget Button"
icon="credit-card"
href="#"
href="https://checkout.request.network"
>
**Pre-built React checkout component**

Drop-in component for crypto payments—works with Easy Invoice Client IDs or direct API integration.

- Wallet connection and payment processing included
- Fully customizable styling
- Compatible with all integration options above

[View demo →](https://checkout.request.network)
</Card>

Expand Down Expand Up @@ -192,9 +192,9 @@ NFT marketplace automatically splits payments between sellers, platform, and roy
Recommended for checkout - bundles request creation with payment transaction generation
</Card>

<Card
title="Payment Widget Button"
href="#"
<Card
title="Payment Widget Button"
href="https://checkout.request.network"
icon="credit-card"
>
Pre-built React component with wallet connection and payment processing
Expand Down
22 changes: 11 additions & 11 deletions use-cases/invoicing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,20 +74,20 @@ Not sure which approach fits your needs? [See our detailed comparison of integra
[Try it now →](https://easyinvoice.request.network)
</Card>

<Card
title="Fork EasyInvoice"
<Card
title="Fork EasyInvoice"
icon="code-fork"
href="#"
href="https://github.com/RequestNetwork/easy-invoice"
>
**Customize for your brand**

Clone and modify the open-source application to match your needs.

- Full source code access
- Custom branding
- Add your own features
[Forking guide →](#)

[View repository →](https://github.com/RequestNetwork/easy-invoice)
</Card>
</CardGroup>

Expand Down Expand Up @@ -171,12 +171,12 @@ Not sure which approach fits your needs? [See our detailed comparison of integra
Set up your account and get API credentials
</Card>

<Card
title="View Invoicing Examples"
href="#"
<Card
title="View Integration Guide"
href="/api-features/secure-payment-integration-guide"
icon="code"
>
See code examples for common invoicing workflows
See integration examples for payment workflows
</Card>

<Card
Expand Down