Merchant console
Open /en/dashboard or /pt/dashboard after signing in with a verified account. Each account has one business. The internal workspace ID scopes its records; it does not enable multiple businesses or access to another account.
First integration
- Create your account's business after signing in. Configure its fixed receiving addresses by network and asset in Settings → Receiving when preparing for a future approved live integration. Sandbox previews do not require a real destination.
- Open Checkouts and create a named configuration.
- Add exact authorized HTTPS origins and the networks you want to test. These are sandbox choices, not proof of live provider entitlement.
- Choose language, light/dark/system theme, accent and corner radius.
- Preview the checkout in the dashboard. The preview uses a separate, short-lived configuration and cannot widen the original integration's origins.
- Create a scoped API key and save its secret on your server. It appears only once.
- Create order sessions from your backend, passing a fixed BRL amount and the authorized parent origin. Send only the returned checkout URL to the browser.
The copy-embed action creates a temporary sample session. For repeatable order checkout use the backend API; do not reuse a public session indefinitely.
Available views
| View | Source and behavior |
|---|---|
| Overview | Database records for the selected business, environment and period; separate BRL received and USDT settled totals |
| Transactions | Paginated records, status/search filters, event history, masked payer data and chain-correct explorer links when a hash exists |
| Payment requests | Expiring server-authorized sessions, status and protected checkout links |
| API keys | Scoped key creation, one-time disclosure, last usage, atomic rotation and revocation |
| Requests | Sanitized method, route, status, duration and correlation ID; no headers or request bodies |
| Webhooks | HTTPS endpoints, event subscriptions, one-time signing secret, delivery status, controlled retry and explicitly marked tests |
| Settings | Profile, language, business details, password, sessions and fixed receiving addresses by network and asset |
CSV exports are authorized, capped at 5,000 records and neutralize spreadsheet formulas. A viewer cannot change business settings or credentials. Sensitive key and receiving-configuration changes require a session created within the last 15 minutes.
Financial state
Live payments are disabled. Only the Magnum operator manages the private global 4P credential; businesses cannot supply or inspect it. The business may configure its own fixed receiving addresses through authorized settings. The payer cannot choose a wallet or change the beneficiary. Saving an address or the operator credential does not open live payments or establish provider approval for multiple businesses.
The overview has no custodial balance. A Pix receipt is not crypto settlement. A settlement total requires provider-confirmed destination, network, amount and transaction hash. Empty views represent no records, not fabricated sales.
Account lifecycle
Verification, recovery, welcome and password-change notices are rendered in PT/EN and stored encrypted in EmailOutbox. The worker sends through Resend or SMTP. Recovery tokens expire and cannot be reused; a successful reset revokes prior sessions. Successful verification creates a verified session and queues one welcome message. Registration stays off until a transport and authorized sender are configured and AUTH_ALLOW_SIGNUP is enabled. An accepted message is only provider acceptance, not inbox delivery. The Google option remains visible but reports unavailable until its OAuth credentials are configured.
Session API
All paths below require a verified account cookie. Mutations also require Magnum's exact Origin; owner/admin permissions apply to workspace mutations.
| Method | Path under /v1/console | Purpose |
|---|---|---|
| GET | /session | User and authorized workspaces |
| GET, DELETE | /sessions, /sessions/:id | Own session metadata and revocation |
| GET, PATCH | /workspaces/:workspaceId/settings | Business settings |
| GET | /workspaces/:workspaceId/overview | Period metrics, days=7..90, environment |
| GET | /workspaces/:workspaceId/transactions | Filters: page, limit, search, status, from, to, environment |
| GET | /workspaces/:workspaceId/transactions/export | Authorized CSV export |
| GET | /workspaces/:workspaceId/transactions/:id | Transaction details and event history |
| GET | /workspaces/:workspaceId/requests | Sanitized request history |
| GET, POST | /workspaces/:workspaceId/integrations | Integration configurations |
| PATCH | /workspaces/:workspaceId/integrations/:id | Appearance and policy updates |
| POST | /workspaces/:workspaceId/integrations/:id/preview | Isolated 10-minute preview |
| GET, POST | /workspaces/:workspaceId/checkouts | Payment requests; POST needs Idempotency-Key |
| GET | /workspaces/:workspaceId/checkouts/:id/link | Audited access to an unexpired link |
| POST | /workspaces/:workspaceId/api-keys/:id/rotate | Revoke and replace a key atomically |
| GET, POST | /workspaces/:workspaceId/webhooks | Endpoint metadata and creation |
| DELETE | /workspaces/:workspaceId/webhooks/:id | Disable endpoint |
| POST | /workspaces/:workspaceId/webhooks/:id/test | Queue a marked test event |
| GET | /workspaces/:workspaceId/deliveries | Paginated delivery history |
| POST | /workspaces/:workspaceId/deliveries/:id/retry | Controlled retry |
| GET, PUT | /workspaces/:workspaceId/settlement | Fixed receiving addresses by network and asset |
GET /workspaces/:workspaceId/provider exposes sanitized operator-integration status only. Provider credential writes are unavailable to businesses. See accounts for receiving-setting bodies, replacement semantics and validation errors.
Public support submissions use POST /v1/public/support with email, subject, message, locale and an empty optional honeypot website. A submission is stored encrypted; the response is a receipt reference, not a claim of email delivery. Public contact details are configured by the operator.
Overview periods use UTC calendar days. Receipt and settlement totals follow their confirmation date, including payments requested before the selected period. Pending charges include unexpired requests before and after QR creation.