Repository navigation
docs(api): document fee treatment on refunded requests (INT2-941) - #544
GiselleNessi wants to merge 5 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Claude finished @GiselleNessi's task in 39s —— View job Code review: PR #544The table on the Refunds page names a fee that doesn't exist in the docs' fee model. The paragraph above it also makes an unverified claim about Execution Cost. The two anchor links resolve ( Issues1. "Relay service fee" is not a term the docs define — 2. Execution Cost on a refund is not covered, but the text rules it out — 3. "should not" on one page, "never" on the other — Nits
SummaryNo blockers on rendering or links. Please fix #1 (fee name) and check #2 (Execution Cost on refunds) with whoever owns refund accounting before merging. #3 is a quick wording fix. |
[Low impact] The PR appears safe to merge, with non-blocking documentation fixes remaining. Findings
|
|
Claude finished @GiselleNessi's task in 25s —— View job Code review: PR #544 (after
|
|
Claude finished @GiselleNessi's task in 32s —— View job Code review: PR #544 (after
|
|
Claude finished @GiselleNessi's task in 33s —— View job Code review: PR #544 (after
|
| To learn more about this API, see the [Get App Fee Balance](/references/api/get-app-fee-balances) API reference. | ||
|
|
||
| ### How to withdraw your off-chain balance? | ||
| ### Withdraw your off-chain balance |
There was a problem hiding this comment.
Withdrawal links miss their section
Renaming this heading changes its link target to #withdraw-your-off-chain-balance, but changelog.mdx:27 and references/api/changelog.mdx:18 still link to #how-to-withdraw-your-off-chain-balance. Those links no longer jump to the withdrawal instructions. Keep the old heading anchor or update both links.
| ### Withdraw your off-chain balance | |
| ### How to withdraw your off-chain balance? |
…refunded-requests
|
Claude finished @GiselleNessi's task in 31s —— View job Code review: PR #544 (after
|
| | [Platform Fees](/references/api/api_core_concepts/fees) | Not retained | | ||
| | App fees | Not collected | | ||
|
|
||
| On a refunded request, `paidAppFees` on `/requests/v2` is empty or zero. To check, see [Verifying Fee Collection](/features/app-fees#verifying-fee-collection). |
There was a problem hiding this comment.
Fee checks use retiring endpoint
The new refund guidance sends readers to /requests/v2, which already has reduced rate limits and retires on November 24, 2026. Integrators following it will soon be unable to check their fees. Point to /requests/v3 and note its API-key requirement instead.
| On a refunded request, `paidAppFees` on `/requests/v2` is empty or zero. To check, see [Verifying Fee Collection](/features/app-fees#verifying-fee-collection). | |
| On a refunded request, `paidAppFees` on `/requests/v3` is empty or zero. Requests to `/requests/v3` require an `x-api-key` header. See [Migrating to Requests v3](/references/api/api_guides/migrating-to-requests-v3) for details. |
Adds a "Fees on refunded requests" section to the Refunds concept page stating that Relay does not keep the service fee and does not collect app fees on a refunded request, with a two-row table and a link to the app-fee verification guidance. Adds one sentence to the App Fees verification paragraph so an empty
paidAppFeeson a refunded request is explained where integrators look for it.Linear: https://linear.app/relayprotocol/issue/INT2-941/document-fee-treatment-for-refunded-requests
Verified against production: 15 refunded requests with a quoted app fee all have
paidAppFeesempty on/requests/v2. The wording avoids restating fee rules fromfees.mdx; it only states what happens to fees on a refund.Also fixes two prose mentions of
/execute/permiton the App Fees page; the route is/execute/permits(solverapi/execute/post-permits/v1.ts, OpenAPI spec, and the cURL on the same page).