Skip to content

Docs: add SWIFT payout documentation to external-account examples#662

Merged
shreyav merged 2 commits into
mainfrom
07-06-plan-swift-payout-docs
Jul 7, 2026
Merged

Docs: add SWIFT payout documentation to external-account examples#662
shreyav merged 2 commits into
mainfrom
07-06-plan-swift-payout-docs

Conversation

@shreyav

@shreyav shreyav commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents SWIFT payouts, which were previously absent from the narrative docs (only visible in the generated API-reference schema). Requested by shreya after a customer couldn't find how to do SWIFT payouts — and searching "SWIFT" in the docs turned up nothing.

  • New "SWIFT (International)" tab in the shared external-accounts snippet — renders on all four use-case sections (Payouts & B2B, Ramps, Rewards, Global P2P). Covers creating the SWIFT_ACCOUNT external account (the payout itself is the standard quote → execute flow).
  • Pointer in Core concepts → Currencies & Payment Rails, whose note previously implied rail selection is never explicit.

A dedicated "SWIFT Payouts" guide page was initially included but removed per shreya's feedback (excessive). Search still works without it: Mintlify indexes snippet tab titles per importing page — verified on production, where searching "PIX" surfaces the "Brazil" tab entries on all four External Accounts pages; "SWIFT (International)" will index the same way after deploy.

API mechanics verified against the OpenAPI spec and sparkcore: SWIFT is opted into via the account type (no request-level paymentRail param); SwiftAccountInfoBase requires swiftCode, bankName, country, and accountNumber or iban; SWIFT accounts are multi-currency (currency = what the destination account holds, may differ from country).

Deliberately out of scope (needs product input): which corridors are SWIFT-enabled, fees, and settlement times.

Test plan

  • python3 -m json.tool mintlify/docs.json — valid JSON
  • mint broken-links — no broken links introduced (24 pre-existing failures in untouched global-accounts snippets)
  • Rendered page verified on the Mintlify preview (screenshot in comments); examples mirror the spec's SwiftAccountInfoBase schema with a consistent Nigerian bank/BIC (Codex P2 fix)
  • Docs-only change — no openapi/ edits, so no rebundle needed

Private

Plan (S3, internal only)

Public

Adds SWIFT payout documentation to the external-accounts examples across all use-case sections.

Slack thread: https://lightsparkgroup.slack.com/archives/D0AH5T8FMGE/p1783379896777279


🤖 volatile-nonce-2(#2) | Feedback

Original PR: #655

shreyav and others added 2 commits July 7, 2026 15:17
… tab

Per shreya's feedback the separate guide page was excessive. Search
discoverability is preserved: snippet tab titles are indexed per importing
page, so the SWIFT (International) tab surfaces on all four External
Accounts pages.

Co-Authored-By: shreyav <shreyav@users.noreply.github.com>
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

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

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Jul 7, 2026 3:30pm
grid-wallet-demo Ignored Ignored Jul 7, 2026 3:30pm

Request Review

akanter commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

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

@shreyav shreyav marked this pull request as ready for review July 7, 2026 15:35
@greptile-apps

greptile-apps Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds SWIFT (International Wire) payout documentation that was previously absent from the narrative docs — discoverable only in the generated API-reference schema. The change closes a gap customers encountered when searching "SWIFT" in the docs and finding nothing.

  • New SWIFT tab in the shared external-accounts.mdx snippet: shows how to create a SWIFT_ACCOUNT external account with a representative Nigerian bank example (BIC GTBINGLA, USD-denominated account, individual beneficiary), plus a <Note> clarifying the currency/country semantics and IBAN-only corridors.
  • One-sentence pointer added to the "Currencies & Payment Rails" core-concepts note, directing users without a supported local rail to SWIFT external accounts.

Confidence Score: 5/5

Documentation-only change with no API or code modifications — safe to merge.

Both changed files are MDX documentation. The SWIFT tab example is internally consistent (valid 8-character BIC, correct Nigerian postal code format, currency/country semantics documented accurately), the new link in currencies-and-rails.mdx resolves to an existing page, and the Authorization header format matches every other cURL example in the file.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/snippets/external-accounts.mdx Adds a well-formed SWIFT (International) tab with a cURL example, a realistic Nigerian bank/BIC, and a clarifying Note — consistent with the style and structure of existing tabs.
mintlify/platform-overview/core-concepts/currencies-and-rails.mdx Adds a single sentence to the existing Note to surface SWIFT as the option for unsupported local rails, with a valid internal link to the payouts-and-b2b external-accounts page.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Dev as Developer
    participant Grid as Grid API

    Dev->>Grid: "POST /customers/external-accounts<br/>(accountType: SWIFT_ACCOUNT, swiftCode, accountNumber/iban)"
    Grid-->>Dev: "ExternalAccount { id, status: ACTIVE }"

    Dev->>Grid: "POST /quotes<br/>(source: InternalAccount, destination: ExternalAccount)"
    Grid-->>Dev: "Quote { id, exchangeRate, fees, expiresAt }"

    Dev->>Grid: "POST /quotes/{id}/execute"
    Grid-->>Grid: Route via SWIFT/international wire
    Grid-->>Dev: "Transaction { id, status }"
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
    participant Dev as Developer
    participant Grid as Grid API

    Dev->>Grid: "POST /customers/external-accounts<br/>(accountType: SWIFT_ACCOUNT, swiftCode, accountNumber/iban)"
    Grid-->>Dev: "ExternalAccount { id, status: ACTIVE }"

    Dev->>Grid: "POST /quotes<br/>(source: InternalAccount, destination: ExternalAccount)"
    Grid-->>Dev: "Quote { id, exchangeRate, fees, expiresAt }"

    Dev->>Grid: "POST /quotes/{id}/execute"
    Grid-->>Grid: Route via SWIFT/international wire
    Grid-->>Dev: "Transaction { id, status }"
Loading

Reviews (2): Last reviewed commit: "Remove dedicated SWIFT Payouts page; kee..." | Re-trigger Greptile

Comment thread mintlify/snippets/external-accounts.mdx
@ls-bolt

ls-bolt Bot commented Jul 7, 2026

Copy link
Copy Markdown

@greptileai review

@shreyav shreyav merged commit e7cf328 into main Jul 7, 2026
16 checks passed
@shreyav shreyav deleted the 07-06-plan-swift-payout-docs branch July 7, 2026 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants