Docs: add SWIFT payout documentation to external-account examples#655
Closed
ls-bolt[bot] wants to merge 2 commits into
Closed
Docs: add SWIFT payout documentation to external-account examples#655ls-bolt[bot] wants to merge 2 commits into
ls-bolt[bot] wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
ls-bolt
Bot
force-pushed
the
07-06-plan-swift-payout-docs
branch
from
44c6a8a to
554444c
Compare
ls-bolt
Bot
changed the title
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Author
Preview validationThe new page renders correctly on the Mintlify preview (SWIFT Payouts): Search requirement ('SWIFT' must show up in docs search)Heads-up for anyone testing on the preview: preview deployments have no search index — searching anything there (even "PIX") returns only the Ask-Assistant suggestion. Validated the mechanism against production instead:
So "SWIFT" search results will appear after merge + production deploy. |
… 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>
ls-bolt
Bot
changed the title
shreyav
added a commit
that referenced
this pull request
Jul 7, 2026
## 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](https://s3.console.aws.amazon.com/s3/object/lightspark-dev-bolt-logs?prefix=jobs/volatile-nonce-2/plan.md) (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](https://zeus.dev.dev.sparkinfra.net/#/arc?id=volatile-nonce)[(#2)](https://zeus.dev.dev.sparkinfra.net/#/instance?id=volatile-nonce-2) | [Feedback](https://zeus.dev.dev.sparkinfra.net/feedback) Original PR: #655 --------- Co-authored-by: shreyav <shreyav@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
SWIFT_ACCOUNTexternal account (the payout itself is the standard quote → execute flow).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
paymentRailparam);SwiftAccountInfoBaserequiresswiftCode,bankName,country, andaccountNumberoriban; SWIFT accounts are multi-currency (currency= what the destination account holds, may differ fromcountry).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 JSONmint broken-links— no broken links introduced (24 pre-existing failures in untouched global-accounts snippets)SwiftAccountInfoBaseschema with a consistent Nigerian bank/BIC (Codex P2 fix)openapi/edits, so no rebundle neededPrivate
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