Skip to main content

​
Getting Started

1

Start with Sandbox

Begin your integration using the Sandbox environment at api.sandbox.rampnow.io. This allows you to test without affecting real data.
2

Test thoroughly

Verify all API endpoints, error handling and edge cases work as expected in Sandbox.
3

Request Production access

Once testing is complete and your integration is stable, request Production access.
4

Deploy to Production

Switch your base URL to api.rampnow.io and go live with confidence.

​
Open API documentation

Our OpenAPI documentation: OpenAPI. For the starter kit, we are using the following OpenAPI specification.

Rampnow OpenAPI

View the OpenAPI specification file

​
API Environments

Rampnow provides two separate environments to support your development and production workflows:

Production

https://api.rampnow.ioLive environment for production applications with real transactions.

Sandbox

https://api.sandbox.rampnow.ioTesting environment for development and integration testing.

​
Environment Comparison

Both environments use the same API structure and authentication methods. Simply change the base URL when moving from Sandbox to Production.
You must thoroughly test your integration in Sandbox mode before requesting access to Production. Production access is granted only after successful integration testing.

​
API Versioning

The Rampnow API follows a stable versioning policy to ensure your integrations remain functional.

​
Our Versioning Promise

Breaking Changes
  • All incompatible or breaking changes are versioned
  • Existing endpoints will continue to work without modification
  • You control when to migrate to new API versions
Non-Breaking Changes
  • New fields may be added to JSON responses at any time
  • New optional parameters may be introduced
  • New endpoints may be added
Important: We may add additional fields to JSON responses without notice or version changes. Ensure your code can handle unknown properties gracefully.

​
Response Format

All API responses return JSON payloads with a consistent structure:

​
Success Response

Every response is wrapped in { code, message, traceId, data } (data holds the endpoint’s payload; code 0 = success).
JSON

​
Error Response

JSON
Rely on code to branch your logic, not on the message text.
  • message is a stable, generic label for the error code (e.g. invalid_args_err). It never contains internal or upstream-provider error detail.
  • displayError is an optional, human-readable message safe to show to your end user (e.g. “Amount is below the minimum for this route.”). It is present only when a user-facing message applies; fall back to your own copy keyed on code when it is absent.
  • traceId identifies the request in our logs — include it when contacting support.

​
Key Features

Built on REST principles with predictable resource-oriented URLs and standard HTTP methods.
All responses are returned in JSON format for easy parsing and integration.
All API requests must be made over HTTPS. Plain HTTP requests are rejected for security.
Secure request signing using HMAC-SHA256 ensures request authenticity and integrity.
Detailed error codes and messages help you quickly identify and resolve issues.

​
Next Steps

Ready to start building? Here’s what to do next:

Authentication

Learn how to authenticate your API requests

Error Codes

Understand error codes and how to handle them

API Endpoints

Explore available API endpoints