-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
base: docs/add-missing-feature-docs
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,7 +5,7 @@ | |||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| Payouts let you initiate payments without a separate request creation step. The API creates the request and returns executable transaction calldata in a single call. | ||||||
|
|
||||||
| **Three payout modes:** | ||||||
| - **Single** — Pay one recipient | ||||||
|
|
@@ -14,7 +14,7 @@ | |||||
|
|
||||||
| ## Single Payout | ||||||
|
|
||||||
| Create a payment request and get transaction calldata in one call. | ||||||
|
|
||||||
| ```bash | ||||||
| curl -X POST "https://api.request.network/v2/payouts" \ | ||||||
|
|
@@ -41,11 +41,11 @@ | |||||
| - `customerInfo` — Payer information (name, email, address) | ||||||
| - `payer` — Payer wallet address (required for recurring) | ||||||
|
|
||||||
| The response includes `requestId` and a `transactions` array with executable calldata. | ||||||
|
|
||||||
| ## Batch Payout | ||||||
|
|
||||||
| Pay multiple recipients in a single blockchain transaction. All payments must be on the same network. | ||||||
|
|
||||||
| ```bash | ||||||
| curl -X POST "https://api.request.network/v2/payouts/batch" \ | ||||||
|
|
@@ -55,13 +55,13 @@ | |||||
| "requests": [ | ||||||
| { | ||||||
| "amount": "50", | ||||||
| "invoiceCurrency": "USDC-base", | ||||||
| "invoiceCurrency": "USD", | ||||||
| "paymentCurrency": "USDC-base", | ||||||
| "payee": "0xb07d2398d2004378cad234da0ef14f1c94a530e4" | ||||||
| }, | ||||||
| { | ||||||
| "amount": "25", | ||||||
| "invoiceCurrency": "USDC-base", | ||||||
| "invoiceCurrency": "USD", | ||||||
| "paymentCurrency": "USDC-base", | ||||||
| "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7" | ||||||
| } | ||||||
|
|
@@ -82,8 +82,19 @@ | |||||
| - `POST /v2/payouts` with `recurrence` object — Create a recurring schedule | ||||||
| - `POST /v2/payouts/recurring/:id` — Submit the payer's permit signature to activate | ||||||
| - `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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The error table covers client-side errors ( Consider adding a row:
Context Used: AGENTS.md (source) |
||||||
|
|
||||||
| ## Endpoint Reference | ||||||
|
|
||||||
| <CardGroup cols={2}> | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sentence contains a subtle but meaningful contradiction for developers who test edge cases:
amountmust be greater than 1 USD equivalent" → strictly> 1.00, so exactly 1.00 USDC is rejected< 1.00, which would imply exactly 1.00 USDC is allowedA 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.