Skip to content

docs: align sandbox-testing curl examples with current OpenAPI schema#484

Merged
jklein24 merged 1 commit into
mainfrom
05-19-docs_align_sandbox-testing_curl_examples_with_current_openapi_schema
May 20, 2026
Merged

docs: align sandbox-testing curl examples with current OpenAPI schema#484
jklein24 merged 1 commit into
mainfrom
05-19-docs_align_sandbox-testing_curl_examples_with_current_openapi_schema

Conversation

@jklein24
Copy link
Copy Markdown
Contributor

@jklein24 jklein24 commented May 20, 2026

Align sandbox-testing and adjacent quickstart curl examples with the current OpenAPI schema.

  • /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/ → /receiver/uma/ path
  • swap broken 'Authorization: Basic $ID:$SECRET' header for curl -u form

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview May 20, 2026, 6:46 AM

@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 20, 2026 7:58am

Request Review

Copy link
Copy Markdown
Contributor Author

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

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 20, 2026

Greptile Summary

This 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.

  • Replaces the broken Authorization: Basic $ID:$SECRET header with curl's -u flag everywhere, fixes /receiver/$addr/receiver/uma/$addr, updates /sandbox/send to accept {quoteId, currencyCode} instead of the stale {reference, currencyCode, currencyAmount}, adds the required sourceType discriminator to all quote source objects, removes the invalid currency field from AccountDestination, drops stale fields from the /sandbox/internal-accounts/{id}/fund body (currencyCode, currencyAmount, referenceamount), and replaces the deprecated POST /users endpoint with POST /customers and its current field set.
  • The fixes are consistent and complete across all affected guides (global-p2p, payouts-and-b2b, ramps, rewards); two previously-flagged issues (missing sourceType and stale auth header in ramps/quickstart.mdx) are now resolved.

Confidence Score: 5/5

Documentation-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.

Important Files Changed

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
Loading

Reviews (3): Last reviewed commit: "docs: align sandbox-testing curl example..." | Re-trigger Greptile

@jklein24 jklein24 force-pushed the 05-19-docs_align_sandbox-testing_curl_examples_with_current_openapi_schema branch from c1ce829 to baa712d Compare May 20, 2026 06:48
@jklein24
Copy link
Copy Markdown
Contributor Author

@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
@jklein24 jklein24 force-pushed the 05-19-docs_align_sandbox-testing_curl_examples_with_current_openapi_schema branch from baa712d to 46cb600 Compare May 20, 2026 07:58
@jklein24
Copy link
Copy Markdown
Contributor Author

@greptile review

@jklein24 jklein24 merged commit 677e21c into main May 20, 2026
8 of 9 checks passed
Copy link
Copy Markdown
Contributor Author

Merge activity

@jklein24 jklein24 deleted the 05-19-docs_align_sandbox-testing_curl_examples_with_current_openapi_schema branch May 20, 2026 16:48
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.

2 participants