Skip to content

docs(content): refresh Tron coverage, batch-payment EVM scope, webhook 12-event list#89

Merged
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-refresh-content
May 12, 2026
Merged

docs(content): refresh Tron coverage, batch-payment EVM scope, webhook 12-event list#89
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-refresh-content

Conversation

@rodrigopavezi
Copy link
Copy Markdown
Member

Bring existing API and resource pages in line with the current product:

  • Tron is co-equal with EVM for single payments/payouts; called out explicitly
    on payee-destinations, payouts, secure-payments, wallet-auth, supported
    chains, token-list, and lifecycle pages.
  • Batch (incoming and outgoing) is EVM-only; admonition added to
    batch-payments, payouts, secure-payments, and the supported-chains feature
    matrix, with the exact API error string for searchability.
  • Webhook event list synced with the auth API's OutgoingWebhookEvent enum
    (12 events) — added .client_id and .checkout variants alongside the core
    4 payment events.
  • Secure Payments reference: documented POST /v2/secure-payments/payouts,
    expanded crosschain chain enum (BASE/OPTIMISM/ARBITRUM/ETHEREUM/POLYGON/BNB),
    noted Tron-specific calldata path.
  • Client ID schema: added operatorWalletAddress, defaultPreApprovalExpiry,
    defaultAuthorizationExpiry; called out Dashboard as the recommended path.
  • Release notes rewritten to reflect actual recent shipments (Tron support,
    secure payouts, gas transparency, calldata endpoint); dropped v1 fiction.
  • Stripped remaining EasyInvoice references from batch-payments and
    crypto-to-fiat-payments.

This was referenced May 8, 2026
Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 8, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 8, 2026

Greptile Summary

This PR refreshes 15 documentation pages to reflect the current state of the Request Network v2 API: Tron is elevated to a first-class network alongside EVM for single payments and payouts, batch operations are clearly marked EVM-only with the exact API error string, the webhook event list is expanded to 12 events (adding .client_id and .checkout variants), and the AI-generated release notes are replaced with accurate 2026 Q1/Q2 shipment descriptions.

  • Tron parity: Payee destinations, payouts, secure payments, wallet auth, supported chains, token list, and lifecycle pages now all call out EVM and Tron symmetry for single-recipient flows, with EVM-only warnings for batch operations.
  • Webhook expansion: api-reference/webhooks.mdx and api-features/webhooks-events.mdx add four new scoped event types (payment.confirmed/partial.client_id and .checkout); the table count of 12 is accurate.
  • Secure payments reference: Documents the new POST /v2/secure-payments/payouts endpoint fully with request fields, cURL examples, and response schema; expands the crosschain chain enum to six EVM chains (+ POLYGON, BNB).
  • Release notes rewrite: Removes placeholder AI-generated content; adds real 2026 Q1/Q2 entries for Tron support, secure payouts, accounting fields, and a calldata endpoint.

Confidence Score: 4/5

Safe to merge after resolving two documentation inconsistencies that would cause developer integration failures.

Two concrete mismatches exist in the changed files. First, expanding the /pay crosschain chain enum to include POLYGON and BNB while leaving the /intent endpoint's chain list at four values means a developer who follows the updated /pay docs for a Polygon crosschain payment would then hit undocumented (and potentially rejected) input on /intent. Second, the release notes describe POST /v2/secure-payments/{token}/calldata as a new endpoint that replaces the payment-intent flow, but no such endpoint appears in the API reference, which still shows /intent as active. Both issues are in changed files and point developers toward the wrong API surface.

api-reference/secure-payments.mdx (intent chain enum) and release-notes/request-api.mdx (calldata endpoint name) need attention before merge.

Important Files Changed

Filename Overview
api-reference/secure-payments.mdx Documents new POST /v2/secure-payments/payouts endpoint and expands crosschain chain enum (+ POLYGON, BNB), but the /intent endpoint's chain enum was not updated to match, leaving it inconsistent with /pay.
release-notes/request-api.mdx Replaces AI-generated placeholder content with real 2026 shipments; references POST /v2/secure-payments/{token}/calldata as a new endpoint that replaces the /intent flow, but this endpoint name does not appear in the API reference.
api-reference/webhooks.mdx Adds four new event type sections (payment.confirmed/partial .client_id and .checkout variants) with accurate descriptions; payload examples section lacks samples for the new event types.
api-features/webhooks-events.mdx Replaces card group with a clean 12-event table; event count is accurate (4 core + 2 client_id + 2 checkout + 1 processing + 1 request + 2 compliance = 12).
resources/supported-chains-and-currencies.mdx Comprehensive restructure with network table, feature matrix, and Tron specifics card; the feature matrix row marking Tron for cross-chain swap-to-pay (Li.Fi) contradicts the EVM-source-only note in the API reference (flagged in a prior review round).
api-features/payouts.mdx Adds Tron payout tab with correct USDT-tron currency ID and T-prefix address; EVM-only batch payout Warning added with exact error string.
api-features/client-id-management.mdx Adds operatorWalletAddress, defaultPreApprovalExpiry, defaultAuthorizationExpiry fields and a Dashboard vs Auth API comparison table; changes look accurate and complete.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph SinglePayment["Single Payment / Payout (EVM + Tron)"]
        SP1["POST /v2/payouts (single)"] --> SP2["Returns calldata + requestId"]
        SP3["POST /v2/secure-payments (single)"] --> SP4["Returns securePaymentUrl + token"]
        SP5["POST /v2/secure-payments/payouts (new)"] --> SP4
    end
    subgraph BatchPayment["Batch Payment / Payout (EVM only)"]
        BP1["POST /v2/payouts/batch"] --> BP2["Returns batch calldata"]
        BP3["POST /v2/secure-payments (requests[] > 1)"] --> BP4["Returns batch URL"]
    end
    subgraph CrossChain["Crosschain Flow (EVM source only)"]
        CC1["GET /v2/secure-payments/:token/pay\n?chain=BASE|OPTIMISM|ARBITRUM|ETHEREUM|POLYGON|BNB"] --> CC2["Returns LiFi calldata"]
        CC2 --> CC3["POST /v2/secure-payments/:token/intent\n?chain=BASE|OPTIMISM|ARBITRUM|ETHEREUM only\n(POLYGON/BNB missing from enum)"]
    end
    subgraph Webhooks["Webhooks (12 events)"]
        W1["payment.confirmed/partial/failed/refunded (core - 4)"]
        W2["payment.confirmed/partial.client_id (new - 2)"]
        W3["payment.confirmed/partial.checkout (new - 2)"]
        W4["payment.processing / compliance.updated / payment_detail.updated / request.recurring (other - 4)"]
    end
Loading

Comments Outside Diff (1)

  1. api-reference/secure-payments.mdx, line 457-459 (link)

    P1 /intent chain enum not updated alongside /pay

    The GET /v2/secure-payments/:token/pay endpoint was expanded in this PR to accept POLYGON and BNB as crosschain source chains, but the POST /v2/secure-payments/:token/intent endpoint's chain field still lists only four values: BASE, OPTIMISM, ARBITRUM, ETHEREUM. Because /intent is called after /pay to record the on-chain LiFi broadcast, a developer who uses POLYGON or BNB as their source chain would follow the now-documented /pay path, then call /intent with "chain": "POLYGON" — at which point the documented enum (and likely API validation) would reject it with a 400. Either the /intent chain enum should be expanded to match /pay (BASE, OPTIMISM, ARBITRUM, ETHEREUM, POLYGON, BNB), or a note should clarify that /intent only covers a subset.

Reviews (2): Last reviewed commit: "docs(content): refresh Tron coverage, ba..." | Re-trigger Greptile

Comment thread api-features/secure-payment-supported-networks-and-currencies.mdx
Comment thread release-notes/request-api.mdx
Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 12, 2026

Merge activity

  • May 12, 4:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 12, 5:08 PM UTC: Graphite rebased this pull request as part of a merge.
  • May 12, 5:08 PM UTC: @rodrigopavezi merged this pull request with Graphite.

@rodrigopavezi rodrigopavezi changed the base branch from docs/revamp-restructure-nav to graphite-base/89 May 12, 2026 17:05
@rodrigopavezi rodrigopavezi changed the base branch from graphite-base/89 to main May 12, 2026 17:06
…k 12-event list

Bring existing API and resource pages in line with the current product:
- Tron is co-equal with EVM for single payments/payouts; called out explicitly
  on payee-destinations, payouts, secure-payments, wallet-auth, supported
  chains, token-list, and lifecycle pages.
- Batch (incoming and outgoing) is EVM-only; admonition added to
  batch-payments, payouts, secure-payments, and the supported-chains feature
  matrix, with the exact API error string for searchability.
- Webhook event list synced with the auth API's OutgoingWebhookEvent enum
  (12 events) — added .client_id and .checkout variants alongside the core
  4 payment events.
- Secure Payments reference: documented POST /v2/secure-payments/payouts,
  expanded crosschain chain enum (BASE/OPTIMISM/ARBITRUM/ETHEREUM/POLYGON/BNB),
  noted Tron-specific calldata path.
- Client ID schema: added operatorWalletAddress, defaultPreApprovalExpiry,
  defaultAuthorizationExpiry; called out Dashboard as the recommended path.
- Release notes rewritten to reflect actual recent shipments (Tron support,
  secure payouts, gas transparency, calldata endpoint); dropped v1 fiction.
- Stripped remaining EasyInvoice references from batch-payments and
  crypto-to-fiat-payments.
@rodrigopavezi rodrigopavezi force-pushed the docs/revamp-refresh-content branch from 750bc29 to d744767 Compare May 12, 2026 17:07
@rodrigopavezi rodrigopavezi merged commit ce1b5ae into main May 12, 2026
3 checks passed
@rodrigopavezi rodrigopavezi deleted the docs/revamp-refresh-content branch May 12, 2026 17:08
Comment on lines +60 to +64
The v2 API exposes endpoints across these resource groups (see [Endpoints (V2)](/api-reference/endpoints-overview) for the OpenAPI-driven reference):

<Tip>
Follow our [GitHub repository](https://github.com/RequestNetwork/request-api) to track development progress and provide feedback on upcoming features.
</Tip>
- **Requests** (`/v2/request`) — create, query, update, get calldata
- **Payments** (`/v2/payments`) — search and reconcile
- **Payouts** (`/v2/payouts`, `/v2/payouts/batch`, `/v2/payouts/recurring`) — single, batch (EVM-only), recurring
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 POST /calldata referenced in release notes but absent from the API reference

The "Calldata endpoint" entry describes POST /v2/secure-payments/{token}/calldata and states it "Replaces previous payment-intent flow for the calldata path." However, api-reference/secure-payments.mdx (also changed in this PR) lists GET /v2/secure-payments/:token/pay as the calldata endpoint and still shows POST /v2/secure-payments/:token/intent as an active, documented endpoint — neither of which matches the name given here. A developer reading the release notes who tries to call POST /v2/secure-payments/{token}/calldata will find no documentation for it. Please reconcile the endpoint name in the release notes with what is actually documented in the reference (or add POST …/calldata to the reference if it is a distinct endpoint).

rodrigopavezi added a commit that referenced this pull request May 12, 2026
Applies 16 of 18 Greptile review comments from PRs #88-95. Skipped:
- PR #88 forward-links comment (resolved by Phase B in #90 — pages now
  exist)
- PR #91 lockfile exclusion (P2 opinion; team has chosen to gitignore)

PR #88
- getting-started.mdx: replaced the "API Key Generation" steps with the
  Client ID flow on the Dashboard.

PR #89
- secure-payment-supported-networks-and-currencies.mdx: qualified the
  cross-chain note — Tron payments are same-chain; Li.Fi swap-to-pay
  is EVM-source only.
- release-notes/request-api.mdx: distinguished the four "2026-Q1"
  Update blocks with topical sub-labels (Payouts, Tron, Accounting,
  Calldata).

PR #90
- docs.json: removed the duplicate tools/dashboard entry from the API
  Setup group. The Tools group in Resources is the canonical home.
- programmatic-payment-links.mdx: TS/Python/cURL switched from <Tabs>
  to <CodeGroup> per AGENTS.md style. Other Tabs blocks (EVM-vs-Tron
  variants) stay as Tabs since they are alternative content.
- programmatic-payment-links.mdx: fixed the timingSafeEqual signature
  check to compare decoded buffer lengths instead of raw hex string
  lengths.

PR #91
- package.json: dropped @playwright/test (only `playwright` is used).
- scripts/capture-screenshots.ts: switched waitUntil from "networkidle"
  to "load". Vite HMR keeps a persistent WebSocket open so networkidle
  always timed out against dev servers.

PR #92
- integration-tutorial.mdx: changed the webhook-section .env placeholder
  from <YOUR_API_KEY> to <YOUR_CLIENT_ID> for consistency.

PR #93
- secure-payments.mdx: rewrote the redirectUrl description to remove
  the self-contradiction ("redirected" vs "no auto-redirect").
- programmatic-payment-links.mdx: the "send back to your site" code
  example now captures the response and uses securePaymentUrl.

PR #94
- payee-destinations.mdx: accessPolicy sub-fields restructured from a
  Markdown table to <Expandable> with nested <ParamField> entries.
- compliance-gated-payments.mdx: "How it works" numbered list switched
  to <Steps> with <Step> components.

PR #95
- multi-chain-checkout.mdx: "you decide of the destination" →
  "you decide on the destination" (grammar).
- batch-payouts.mdx: removed the duplicate "hosted" in the Mode 1
  description.
- welcome.mdx: dropped the SDK framing — the Dashboard and Secure
  Payment Page are no-code hosted tools, not SDK consumers.
rodrigopavezi added a commit that referenced this pull request May 12, 2026
Applies 16 of 18 Greptile review comments from PRs #88-95. Skipped:
- PR #88 forward-links comment (resolved by Phase B in #90 — pages now
  exist)
- PR #91 lockfile exclusion (P2 opinion; team has chosen to gitignore)

PR #88
- getting-started.mdx: replaced the "API Key Generation" steps with the
  Client ID flow on the Dashboard.

PR #89
- secure-payment-supported-networks-and-currencies.mdx: qualified the
  cross-chain note — Tron payments are same-chain; Li.Fi swap-to-pay
  is EVM-source only.
- release-notes/request-api.mdx: distinguished the four "2026-Q1"
  Update blocks with topical sub-labels (Payouts, Tron, Accounting,
  Calldata).

PR #90
- docs.json: removed the duplicate tools/dashboard entry from the API
  Setup group. The Tools group in Resources is the canonical home.
- programmatic-payment-links.mdx: TS/Python/cURL switched from <Tabs>
  to <CodeGroup> per AGENTS.md style. Other Tabs blocks (EVM-vs-Tron
  variants) stay as Tabs since they are alternative content.
- programmatic-payment-links.mdx: fixed the timingSafeEqual signature
  check to compare decoded buffer lengths instead of raw hex string
  lengths.

PR #91
- package.json: dropped @playwright/test (only `playwright` is used).
- scripts/capture-screenshots.ts: switched waitUntil from "networkidle"
  to "load". Vite HMR keeps a persistent WebSocket open so networkidle
  always timed out against dev servers.

PR #92
- integration-tutorial.mdx: changed the webhook-section .env placeholder
  from <YOUR_API_KEY> to <YOUR_CLIENT_ID> for consistency.

PR #93
- secure-payments.mdx: rewrote the redirectUrl description to remove
  the self-contradiction ("redirected" vs "no auto-redirect").
- programmatic-payment-links.mdx: the "send back to your site" code
  example now captures the response and uses securePaymentUrl.

PR #94
- payee-destinations.mdx: accessPolicy sub-fields restructured from a
  Markdown table to <Expandable> with nested <ParamField> entries.
- compliance-gated-payments.mdx: "How it works" numbered list switched
  to <Steps> with <Step> components.

PR #95
- multi-chain-checkout.mdx: "you decide of the destination" →
  "you decide on the destination" (grammar).
- batch-payouts.mdx: removed the duplicate "hosted" in the Mode 1
  description.
- welcome.mdx: dropped the SDK framing — the Dashboard and Secure
  Payment Page are no-code hosted tools, not SDK consumers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant