API reference

The public origin is https://magnum.lat. Development uses http://localhost:3100. Functional responses use { "data": ... }; errors use { "error": ... }.

Server integration

MethodPathAuthorization
GET/v1/capabilitiesPublic
GET/v1/networksPublic
GET/v1/quotes?asset=USDTPublic
GET/POST/v1/integrationsintegrations:read/write
POST/v1/checkout-sessionscheckouts:write + idempotency
GET/v1/checkout-sessions/:idcheckouts:read
GET/v1/paymentspayments:read
GET/v1/metricsmetrics:read
GET/v1/requestsmetrics:read
POST/v1/webhook-endpointswebhooks:write
DELETE/v1/webhook-endpoints/:idwebhooks:write
GET/v1/webhook-deliverieswebhooks:write

Checkout browser

MethodPathRequirement
GET/v1/public/checkouts/:idCheckout capability
POST/v1/public/checkouts/:id/paymentsCapability + idempotency
GET/v1/public/checkouts/:id/paymentCheckout capability
POST/v1/public/checkouts/:id/simulateCapability + sandbox
POST/v1/sandbox/sessionsSame origin + rate limit

Account endpoints are covered in Accounts. /healthz is liveness; /readyz checks PostgreSQL. /v1/providers/4p/notifications is blocked by live policy.

OpenAPI

The generated contract is at /v1/openapi.json. Business-input schemas come from the same validation used by the server. Account authentication is delegated to Better Auth and is not part of this document. Undocumented extra fields are rejected.

Merchant session API

See Merchant console for the authenticated console endpoints, configuration builder and account lifecycle. These session endpoints are distinct from server API-key authorization.

GET /v1/metrics returns receivedBrlCents as integer BRL cents and settledUsdt as an exact decimal string, with sandbox counts separate from live results. See operations for definitions. Business owners configure fixed network/asset receiving addresses with GET and PUT /v1/console/workspaces/:workspaceId/settlement; provider credentials are operator-only and are not accepted in these requests.

Magnum integration documentationAPI v1

Search documentation