Using the API Reference

Navigate the OpenAPI spec, environments, and authentication models.

The API reference tab loads the same OpenAPI document the dashboard uses. Use it to explore every path, schema, and security model.

Item	Value
Production base URL	https://api.gnosisramp.io/v1
Sandbox base URL	https://sandbox.api.gnosisramp.io/v1
Content type	application/json
Auth schemes	HTTP Basic (project client credentials), Bearer (GnosisRamp JWT)

Integration flow

The typical API integration follows this sequence:

1. GET /currencies/supported — discover available currency pairs and provider IDs (Basic Auth)
2. GET /external-accounts/requirements?src=...&dest=... — get JSON Schemas for account fields (Basic Auth)
3. POST /customers/external-accounts — create source + destination account pair (Bearer JWT)
4. POST /intent — create a payment intent, optionally with a preferred providerId (Bearer JWT)

The external accounts carry currency, rail, country, and account type metadata that filters which providers are eligible at intent time. The providerId is an optional preference on top of that filtering.

Calling the APIs

1. Project-scoped endpoints (/customers, /currencies/supported, /providers, /external-accounts/requirements) expect HTTP Basic headers: Authorization: Basic base64(clientId:clientSecret).
2. Customer-scoped endpoints (/customers/external-accounts, /intent, /intent/:id/transaction, etc.) expect Authorization: Bearer <GNOSISRAMP_JWT> obtained from the customer creation response.
3. All request bodies should be JSON; numbers such as transfer amounts must be strings (see the Money Movement section for precision rules).

Working with the spec

• Download the spec: openapi.yaml
• Import into Postman, Insomnia, or your favourite client to bootstrap requests.
• Use the schema definitions for strongly typed clients; they include enums for rails, currencies, and webhook events.
• The Mintlify playground supports live requests once you provide credentials in the “Headers” panel.

If something is missing from the reference, check the Guides tab — it contains conceptual explanations plus runnable snippets.