Uh oh!
There was an error while loading. Please reload this page.
docs(query-payments): rewrite with practical implementation focus and remove AI warning - #66
Conversation
This was referenced Mar 2, 2026
Merged
Merged
ContributorAuthor
This was referenced Mar 2, 2026
query-requests and query-payments docs to align with actual API behavior and fix endpoint linking issues in OpenAPI references. - removed AI-generated warning baaimen74
marked this pull request as ready for review
March 2, 2026 12:12
Greptile SummaryThis PR rewrites the Query Payments documentation page, removing the AI-generated content disclaimer and replacing the mermaid diagram with a
Confidence Score: 5/5Documentation-only change with no runtime impact; safe to merge. The change is a documentation rewrite with no code, schema, or configuration changes. Internal links all resolve to existing files, the API endpoint references are consistent throughout the body, and the filter/response fields described match the API contract confirmed in prior review threads. No files require special attention. Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant API as GET /v2/payments
Dev->>API: Request with at least one required filter (txHash, walletAddress, requestId, etc.)
API-->>Dev: Validation error if no filter provided
Dev->>API: Add optional filters (fromDate, toDate, limit, offset)
API-->>API: "Validate date range (toDate >= fromDate)"
API-->>Dev: payments[] + pagination total/limit/offset/hasMore
alt hasMore is true
Dev->>API: Repeat with incremented offset
API-->>Dev: Next page of payments
end
Reviews (2): Last reviewed commit: "docs(api-features): rebuild reconciliati..." | 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.
This was referenced Mar 2, 2026
Merged
Merged
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_fix_query-requests_openapi_endpoint_links_and_reconciliation_mapping_update_api-features_query-requests.mdx_to_use_the_correct_openapi_deep_links_for_request_status_and_wallet-level_reconciliation._-_replaced_n
to
graphite-base/66May 12, 2026 16:30
…2 endpoints
Refactor `query-requests` and `query-payments` docs to align with actual API behavior and fix endpoint linking issues in OpenAPI references.
- removed AI-generated warning banners from both pages
- replaced outdated/broken API reference paths with canonical OpenAPI links
- corrected endpoint linking strategy for request status and payment search routes
- aligned `query-requests` to request-level reconciliation flow using:
- GET /v2/request/{requestId}
- GET /v2/payments (wallet-level reconciliation context)
- replaced related-page bullet links with CardGroup components for consistency
- rebuilt `query-payments` as endpoint-driven documentation for:
- GET /v2/payments
- required search parameter behavior
- filter groups (identity/tx, type/currency, date/pagination)
- response pagination fields (`total`, `limit`, `offset`, `hasMore`)
- practical reconciliation notes (AND semantics, batch tx behavior, idempotency)
- removed legacy-domain dependencies and invalid internal endpoint links
- kept structure consistent with other migrated API Features pagesrodrigopaveziforce-pushed
the
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
branch
from
May 12, 2026 16:32
821e504 to
68137aeCompareUh oh!
There was an error while loading. Please reload this page.
rodrigopavezi
deleted the
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
branch
May 12, 2026 16:33
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 Query Payments documentation page to provide clearer, more actionable guidance with step-by-step instructions and practical implementation details.
What changed?
How to test?
Why make this change?
The original documentation was AI-generated with a disclaimer about potential inaccuracies. This rewrite provides developers with more reliable, structured guidance that focuses on practical implementation patterns and real-world usage scenarios for payment querying and reconciliation workflows.