docs: align sandbox-testing curl examples with current OpenAPI schema#484
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Greptile SummaryThis PR aligns curl examples across seven documentation files with the current OpenAPI schema, fixing authentication syntax, endpoint paths, and request body fields that had drifted from the live API.
Confidence Score: 5/5Documentation-only changes that bring curl examples in sync with the live API schema; no runtime code is affected. Every stale field, wrong path, and broken auth header identified in prior reviews has been corrected consistently across all seven files. No new inconsistencies were introduced. No files require special attention.
|
| Filename | Overview |
|---|---|
| mintlify/global-p2p/platform-tools/sandbox-testing.mdx | Fixes all auth headers, receiver/uma path, sandbox/send body, and migrates /users to /customers with correct fields; changes are internally consistent. |
| mintlify/global-p2p/quickstart.mdx | Updates sandbox/send body from reference/currencyAmount to quoteId; minimal change, correct. |
| mintlify/payouts-and-b2b/platform-tools/sandbox-testing.mdx | Removes invalid currency field from AccountDestination and updates sandbox/send body to quoteId schema; adds helpful note about optional currencyAmount. |
| mintlify/payouts-and-b2b/quickstart.mdx | Drops stale currencyCode/currencyAmount/reference from sandbox fund body, replacing with the correct {amount} shape. |
| mintlify/ramps/platform-tools/sandbox-testing.mdx | Adds sourceType to both quote source objects and destinationType to AccountDestination; updates sandbox/send to quoteId; all changes consistent. |
| mintlify/ramps/quickstart.mdx | Fixes auth header and adds sourceType to quotes request; updates sandbox/send body to quoteId — previously-reported P1 issues are resolved. |
| mintlify/rewards/platform-tools/sandbox-testing.mdx | Adds sourceType: ACCOUNT to three separate quote source objects; straightforward mechanical fix. |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Grid as Grid API (Sandbox)
Note over Dev,Grid: Outgoing Payment Flow (Fixed in this PR)
Dev->>Grid: GET /receiver/uma/$addr (was /receiver/$addr)
Grid-->>Dev: Lookup result + lookupId
Dev->>Grid: "POST /quotes {sourceType, ...} (sourceType now required)"
Grid-->>Dev: "{id: Quote, paymentInstructions}"
Dev->>Grid: "POST /sandbox/send {quoteId, currencyCode}"
Grid-->>Dev: Transaction PROCESSING
Note over Dev,Grid: Auth Fixed
Note right of Dev: -u replaces broken Authorization Basic header
Note over Dev,Grid: Internal Account Funding (Fixed)
Dev->>Grid: "POST /sandbox/internal-accounts/{id}/fund {amount}"
Grid-->>Dev: Transaction COMPLETED
Note over Dev,Grid: Customer Registration (Fixed)
Dev->>Grid: "POST /customers {platformCustomerId, customerType, ...}"
Grid-->>Dev: Customer with auto-generated umaAddress
Reviews (3): Last reviewed commit: "docs: align sandbox-testing curl example..." | Re-trigger Greptile
c1ce829 to
baa712d
Compare
|
@greptile review |
- /sandbox/send body: replace stale {reference, currencyCode, currencyAmount}
with {quoteId, currencyCode} per SandboxSendRequest schema
- /sandbox/internal-accounts/{id}/fund body: drop currencyCode/currencyAmount/
reference, use {amount} per SandboxFundRequest schema
- /quotes bodies: add required sourceType on quote sources, remove invalid
currency field from AccountDestination
- replace deprecated POST /users with POST /customers and correct fields
- fix /receiver/<addr> → /receiver/uma/<addr> path
- swap broken 'Authorization: Basic $ID:$SECRET' header for curl -u form
baa712d to
46cb600
Compare
|
@greptile review |

Align sandbox-testing and adjacent quickstart curl examples with the current OpenAPI schema.
with {quoteId, currencyCode} per SandboxSendRequest schema
reference, use {amount} per SandboxFundRequest schema
currency field from AccountDestination