Getting Started

Configure a GnosisRamp project, environments, and tooling before hitting the APIs.

New to GnosisRamp? Contact the GnosisRamp team to set up your organization. Once created, you can login to the dashboard and begin your integration.

Every integration begins with a project that owns credentials, provider accounts, and webhook settings. Use the dashboard to create a sandbox project, then follow these steps to wire your stack.

1. Provision project credentials

   Each project exposes clientId/clientSecret pairs (Project Client Credentials). Store them in your secret manager; they are used to call token-exchange endpoints and to configure outgoing webhook signing.

2. Activate provider accounts

   To enable payment providers for your project, you’ll need to establish accounts directly with each ramp provider you wish to use. Once you have your provider accounts, input the credentials into the GnosisRamp dashboard. All credentials are encrypted and stored securely. After configuration, these providers will participate in routing for your transactions.

Environments & URLs

Environment	API base URL	Notes
Production	https://api.gnosisramp.io/v1	Full provider roster + live money movement
Sandbox	https://sandbox.api.gnosisramp.io/v1	Same schemas with mock providers

Discover supported currencies and providers

Before building your integration, query GET /currencies/supported to discover which currency pairs are available for your project. This tells you which source and destination combinations you can offer to your customers. Use GET /providers to get details about available providers. See the Supported Currencies guide for details.

Integration Flow

Once your project is configured, the API integration follows four steps:

1. Discover supported currency pairs

   Call GET /currencies/supported to find out which source→destination routes are available and which providers can handle each pair. The response includes providerIds per pair — the same IDs you can pass as providerId when creating intents. See Supported Currencies.

2. Fetch external account requirements

   Call GET /external-accounts/requirements?src=USD&dest=USDC_GNO to get JSON Schemas defining the fields needed for source and destination accounts. The schemas adapt based on the currency pair — different rails (ACH, WIRE, PIX) and providers may require different fields. See Fetching Requirements.

3. Create external accounts

   Submit source and destination account details via POST /customers/external-accounts. The accounts are created as a pair and carry the currency, rail, country, and account type information that GnosisRamp uses to filter eligible providers at intent time. See Creating External Accounts.

4. Create an intent

   Call POST /intent with the external account IDs, amount, and an optional providerId. GnosisRamp evaluates the external account metadata (currency, rail, country, account type) against each provider’s capabilities to find eligible candidates. The providerId is an extra filter — “of the providers that can handle my accounts, I specifically want this one.” The selected provider then determines which KYC/compliance requirements the user must complete. See Intent Lifecycle.