Uh oh!
There was an error while loading. Please reload this page.
docs(platform-fees): simplify configuration guide and remove AI-generated content warning - #67
Conversation
This was referenced Mar 2, 2026
Merged
Merged
Merged
ContributorAuthor
This was referenced Mar 2, 2026
Merged
api-features/platform-fees.mdx to document platform-fee configuration clearly and accurately for v2 API consumers. - remove AI placeholder framing and unsupported/ambiguoaimen74
marked this pull request as ready for review
March 2, 2026 14:33
Greptile SummaryThis PR rewrites
Confidence Score: 5/5Documentation-only rewrite with no code changes; safe to merge. The change touches a single MDX documentation file with no logic, schema, or API contract modifications. The content accurately reflects the three supported endpoints and their parameter types. The two gaps (unfilled path template in the GET example and absent response examples) are documentation quality issues that do not affect API behaviour or developer correctness in a blocking way. api-features/platform-fees.mdx — the GET cURL example and the absence of response samples are worth a quick pass before merging. Important Files Changed
Sequence DiagramsequenceDiagram
participant App as Developer App
participant API as Request Network API
participant SC as Smart Contract
App->>API: "GET /v2/request/{requestId}/pay?feePercentage=2.5&feeAddress=0x..."
API-->>App: Payment payload (includes feeAmount in token decimals)
App->>SC: Execute transaction (amount + feeAmount)
SC-->>App: Payee receives amount, feeAddress receives fee
App->>API: POST /v2/payouts (body: feePercentage, feeAddress)
API-->>App: Payout payload with fee calldata
App->>SC: Execute payout transaction
SC-->>App: Vendor receives amount, feeAddress receives fee
App->>API: POST /v2/payouts/batch (body: feePercentage, feeAddress, requests[])
API-->>App: Batch payout payload with fee calldata
App->>SC: Execute batch transaction
SC-->>App: All payees receive amounts, feeAddress receives aggregate fee
Reviews (2): Last reviewed commit: "docs(api-features): rewrite platform-fee..." | Re-trigger Greptile |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Mar 3, 2026
This was referenced Mar 30, 2026
This was referenced May 8, 2026
rodrigopavezi added a commit
that referenced
this pull request
May 11, 2026
Bundles two passes of Greptile feedback: (A) PR #96 follow-up — the fixes PR itself attracted two new comments: - use-cases/programmatic-payment-links.mdx: cURL language tag bash → curl - RN_API_KEY → RN_CLIENT_ID and X-Api-Key → x-client-id renamed across api-setup/integration-tutorial.mdx, api-setup/getting-started.mdx, api-features/create-requests.mdx for stack-wide consistency. Zero RN_API_KEY / X-Api-Key references remain. (B) Older PRs (51-87) — 23 still-applicable comments out of 51 total. The other 28 are stale (resolved by the revamp rewriting or removing the relevant sections/files); those will be resolved on GitHub with a note explaining staleness. PR #53 — getting-started.mdx - Added Express setup (express + app.use(express.json())) before the webhook handler example so the snippet is runnable. PR #54 — integration-tutorial.mdx - Added missing `import { eq } from 'drizzle-orm';`. - Fixed spelling "succesfully" → "successfully". PR #55 — create-requests.mdx - v2 pay endpoint takes requestId, not paymentReference (mermaid + code sample updated to `${requestId}/pay`). PR #56 + #87 — crosschain-payments.mdx - Boundary wording: "under \$1" → "of \$1 or less" to align with the "greater than 1 USD" half of the sentence. - viem snippet now imports createPublicClient + http and instantiates publicClient so `publicClient.waitForTransactionReceipt(...)` works. PR #57 — batch-payments.mdx - Code samples now use x-client-id (consistent with rest of docs), dropped legacy x-platform-id, added `if (!response.ok)` error handling on both examples. PR #59 — crypto-to-fiat-payments.mdx - "I**mportant:" → "**Important:" - mermaid: {payerId} → {clientUserId} (twice). - Endpoint paths: /payer → /v2/payer for consistency. - mermaid: declared "Payee Bank" as a participant (was used but never declared, breaking the diagram). PR #66 — query-payments.mdx - Frontmatter description: /payments → /v2/payments. PR #67 — platform-fees.mdx - Clarified query- vs body-param scope: GET /v2/request/{id}/pay uses query params; POST /v2/payouts and /payouts/batch use body params. PR #68 — protocol-fees.mdx - Grammar: "protocol fees applies" → "protocol fee applies". - Typo: "simple reduce" → "simply reduce". - Math: payee receives 999.50 USDC (not 999.95). Added intermediate invoice/fee lines for transparency. PR #77 — faq.mdx - On-ramp question now explicitly answered: "Fiat-to-crypto (on-ramp) payments are not currently supported by the API." PR #86 — payouts.mdx - "ERC-712" → "EIP-712" (correct EIP designation). PR #86 — api-reference/secure-payments.mdx - expiresAt example: 15 minutes → 7 days, matching the documented default expiry. PR #87 — payouts.mdx - Added "500" row to error-handling table. mintlify broken-links: zero.
Contributor
Merge activity
|
rodrigopavezi
changed the base branch from
03-02-docs_api-features_rebuild_reconciliation_query_pages_with_correct_v2_endpoints_refactor_query-requests_and_query-payments_docs_to_align_with_actual_api_behavior_and_fix_endpoint_linking_issues_in_openapi_references._-_removed_ai
to
graphite-base/67May 12, 2026 16:32
…uide
Refactor `api-features/platform-fees.mdx` to document platform-fee configuration clearly and accurately for v2 API consumers.
- remove AI placeholder framing and unsupported/ambiguous wording
- focus page scope on platform fee setup (`feePercentage`, `feeAddress`)
- document validation constraints and required parameter pairing
- correct endpoint usage for fee parameters:
- GET /v2/request/{requestId}/pay
- POST /v2/payouts
- POST /v2/payouts/batch
- add cURL examples with `x-api-key` auth style
- add cross-links to Protocol Fees and Fee Breakdowns
- point users to canonical OpenAPI docs for full schemasrodrigopaveziforce-pushed
the
03-02-docs_api-features_rewrite_platform-fees_as_implementation-focused_guide_refactor_api-features_platform-fees.mdx_to_document_platform-fee_configuration_clearly_and_accurately_for_v2_api_consumers._-_remove_ai_placeholder_framing_
branch
from
May 12, 2026 16:34
ab88d80 to
00caa29CompareUh oh!
There was an error while loading. Please reload this page.
rodrigopavezi
deleted the
03-02-docs_api-features_rewrite_platform-fees_as_implementation-focused_guide_refactor_api-features_platform-fees.mdx_to_document_platform-fee_configuration_clearly_and_accurately_for_v2_api_consumers._-_remove_ai_placeholder_framing_
branch
May 12, 2026 16:35
rodrigopavezi added a commit
that referenced
this pull request
May 12, 2026
Bundles two passes of Greptile feedback: (A) PR #96 follow-up — the fixes PR itself attracted two new comments: - use-cases/programmatic-payment-links.mdx: cURL language tag bash → curl - RN_API_KEY → RN_CLIENT_ID and X-Api-Key → x-client-id renamed across api-setup/integration-tutorial.mdx, api-setup/getting-started.mdx, api-features/create-requests.mdx for stack-wide consistency. Zero RN_API_KEY / X-Api-Key references remain. (B) Older PRs (51-87) — 23 still-applicable comments out of 51 total. The other 28 are stale (resolved by the revamp rewriting or removing the relevant sections/files); those will be resolved on GitHub with a note explaining staleness. PR #53 — getting-started.mdx - Added Express setup (express + app.use(express.json())) before the webhook handler example so the snippet is runnable. PR #54 — integration-tutorial.mdx - Added missing `import { eq } from 'drizzle-orm';`. - Fixed spelling "succesfully" → "successfully". PR #55 — create-requests.mdx - v2 pay endpoint takes requestId, not paymentReference (mermaid + code sample updated to `${requestId}/pay`). PR #56 + #87 — crosschain-payments.mdx - Boundary wording: "under \$1" → "of \$1 or less" to align with the "greater than 1 USD" half of the sentence. - viem snippet now imports createPublicClient + http and instantiates publicClient so `publicClient.waitForTransactionReceipt(...)` works. PR #57 — batch-payments.mdx - Code samples now use x-client-id (consistent with rest of docs), dropped legacy x-platform-id, added `if (!response.ok)` error handling on both examples. PR #59 — crypto-to-fiat-payments.mdx - "I**mportant:" → "**Important:" - mermaid: {payerId} → {clientUserId} (twice). - Endpoint paths: /payer → /v2/payer for consistency. - mermaid: declared "Payee Bank" as a participant (was used but never declared, breaking the diagram). PR #66 — query-payments.mdx - Frontmatter description: /payments → /v2/payments. PR #67 — platform-fees.mdx - Clarified query- vs body-param scope: GET /v2/request/{id}/pay uses query params; POST /v2/payouts and /payouts/batch use body params. PR #68 — protocol-fees.mdx - Grammar: "protocol fees applies" → "protocol fee applies". - Typo: "simple reduce" → "simply reduce". - Math: payee receives 999.50 USDC (not 999.95). Added intermediate invoice/fee lines for transparency. PR #77 — faq.mdx - On-ramp question now explicitly answered: "Fiat-to-crypto (on-ramp) payments are not currently supported by the API." PR #86 — payouts.mdx - "ERC-712" → "EIP-712" (correct EIP designation). PR #86 — api-reference/secure-payments.mdx - expiresAt example: 15 minutes → 7 days, matching the documented default expiry. PR #87 — payouts.mdx - Added "500" row to error-handling table. mintlify broken-links: zero.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Rewrote the Platform Fees documentation to be more concise and focused on practical implementation.
What changed?
How to test?
Why make this change?
The original documentation was verbose and contained AI-generated disclaimers that reduced credibility. The new version provides a cleaner, more actionable reference that developers can quickly scan to understand requirements and implement platform fees without unnecessary complexity.