docs: add complete API reference for fx-account and fx-payment#3
Merged
marioalvial merged 4 commits intomainfrom Apr 14, 2026
Merged
docs: add complete API reference for fx-account and fx-payment#3marioalvial merged 4 commits intomainfrom
marioalvial merged 4 commits intomainfrom
Conversation
Replace all 12 TODO stubs with full request/response schemas, reusable parameters, and examples for deposits, withdrawals, swaps, operations, beneficiaries, and payment instructions.
Create 12 MDX stub pages for operations and beneficiary endpoints with openapi frontmatter directives. Add Operations, Beneficiaries, and Payment Instructions groups to the API Reference tab in docs.json.
Remove reference to non-existent POST /api/quotes endpoint. The quote is created automatically when creating a swap and returned in the response.
Include the complete fx-account OpenAPI spec with all 12 endpoint schemas and 12 MDX stub pages for account, UBO, document, and funding instruction endpoints.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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.
Description
Add full OpenAPI specs and API reference pages for both fx-account (12 endpoints) and fx-payment (12 endpoints), giving customers a complete, navigable API reference for the Trace FX platform.
Key Changes
openapi:frontmatter for auto-renderingPOST /api/swapsendpoint instead of non-existentPOST /api/quotesType of change
How Has This Been Tested?
OpenAPI spec validated: 12 endpoints with zero TODO stubs, 102
$refreferences all resolve, valid YAML/JSON structure. All docs.json navigation pages verified to exist on disk.Checklist: