Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .claude/rules/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,14 @@ machine-checkable subset.

- `/v1` is a **header selector** (`X-Trace-Version: 1`). It is **never**
a URL path segment. Do not write paths like `/api/v1/...`.
- Server URL is per-service: `https://faas.{env}.tracefinance.io/account`,
`/payment`, `/webhook`.
- Server URL is the bare gateway host. Only the sandbox host is
published: `https://api.sandbox.tracefinance.com`. The production
host is **not** documented publicly — it is shared with the customer
at go-live. Do **not** add a production `servers:` entry, a
`productionUrl` Mintlify variable, or any production URL in MDX.
- Do **not** include the internal service segment (`/account`,
`/payment`, `/webhook`) — service names are not exposed publicly.
Paths begin at the source channel (`/api/...`).
- Strip `/dashboard` and `/admin` paths — only `/api` channel is
documented. Public discovery endpoints (e.g.,
`/references/...`) sit outside `/api` and require no auth — set
Expand Down
4 changes: 1 addition & 3 deletions apis/fx-account/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ info:
version: 1.0.0
description: API for managing multi-currency accounts on the Trace FX platform.
servers:
- url: https://faas.sandbox.tracefinance.io/account
- url: https://api.sandbox.tracefinance.com
description: Sandbox
- url: https://faas.tracefinance.io/account
description: Production
security:
- bearerAuth: []
tags:
Expand Down
4 changes: 1 addition & 3 deletions apis/fx-payment/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ info:
API for deposits, withdrawals, swaps, and beneficiary management
on the Trace FX platform.
servers:
- url: https://faas.sandbox.tracefinance.io/payment
- url: https://api.sandbox.tracefinance.com
description: Sandbox
- url: https://faas.tracefinance.io/payment
description: Production
security:
- bearerAuth: []
tags:
Expand Down
4 changes: 1 addition & 3 deletions apis/fx-webhook/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@ info:
API for managing webhook subscriptions and inspecting webhook delivery
history on the Trace FX platform.
servers:
- url: https://faas.sandbox.tracefinance.io/webhook
- url: https://api.sandbox.tracefinance.com
description: Sandbox
- url: https://faas.tracefinance.io/webhook
description: Production
security:
- bearerAuth: []
tags:
Expand Down
8 changes: 2 additions & 6 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -246,18 +246,14 @@
]
},
"api": {
"baseUrl": [
"https://faas.sandbox.tracefinance.io",
"https://faas.tracefinance.io"
],
"baseUrl": "https://api.sandbox.tracefinance.com",
"auth": {
"method": "bearer"
}
},
"description": "Explore guides, examples, and API references to build with Trace Finance.",
"variables": {
"sandboxUrl": "https://faas.sandbox.tracefinance.io",
"productionUrl": "https://faas.tracefinance.io",
"sandboxUrl": "https://api.sandbox.tracefinance.com",
"authUrl": "https://auth.tracefinance.io"
},
"seo": {
Expand Down
5 changes: 1 addition & 4 deletions guides/environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@ description: "Sandbox and production base URLs, and what differs between them."

Trace FX provides two environments. Use sandbox for development and testing, and production for live integrations.

| Environment | Base URL |
| --- | --- |
| Sandbox | `{{sandboxUrl}}` |
| Production | `{{productionUrl}}` |
The sandbox base URL is `{{sandboxUrl}}`. The production base URL is shared with you at go-live, after your integration has been validated in sandbox.

## Details

Expand Down
2 changes: 1 addition & 1 deletion webhooks/test-in-sandbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Develop and verify webhook handlers against the Trace sandbox."

The sandbox environment delivers real webhook events as you exercise the API — creating orders, registering beneficiaries, initiating PIX payments, and so on. Use it to develop and test your handler before going to production.

The sandbox base URL is `{{sandboxUrl}}` (`https://faas.sandbox.tracefinance.io`).
The sandbox base URL is `{{sandboxUrl}}`.

## Recommended workflow

Expand Down
Loading