> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rampnow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Basics of Rampnow API

## Getting Started

<Steps>
  <Step title="Start with Sandbox">
    Begin your integration using the Sandbox environment at `api.dev.rampnow.io`. This allows you to test without affecting real data.
  </Step>

  <Step title="Test thoroughly">
    Verify all API endpoints, error handling and edge cases work as expected in Sandbox.
  </Step>

  <Step title="Request Production access">
    Once testing is complete and your integration is stable, request Production access.
  </Step>

  <Step title="Deploy to Production">
    Switch your base URL to `api.rampnow.io` and go live with confidence.
  </Step>
</Steps>

## Open API documentation

Our OpenAPI documentation: [OpenAPI](https://rampnow-io.github.io/core/partner_external.yaml). For the starter kit, we are using the following OpenAPI specification.

<Card title="Rampnow OpenAPI" icon="leaf" href="https://rampnow-io.github.io/core/partner_external.yaml">
  View the OpenAPI specification file
</Card>

## API Environments

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

<div style={{display: 'grid', gridTemplateColumns: '1fr 1fr', gap: '1rem'}}>
  <Card title="Production" icon="globe" color="#16a34a">
    `https://api.rampnow.io`

    Live environment for production applications with real transactions.
  </Card>

  <Card title="Sandbox" icon="flask" color="#ea580c">
    `https://api.sandbox.rampnow.io`

    Testing environment for development and integration testing.
  </Card>
</div>

### Environment Comparison

| Feature      | Sandbox                 | Production        |
| ------------ | ----------------------- | ----------------- |
| Base URL     | api.sandbox.rampnow\.io | api.rampnow\.io   |
| Purpose      | Testing & Development   | Live Transactions |
| Data         | Test data only          | Real data         |
| Access       | Immediate               | Requires approval |
| Transactions | Simulated               | Real              |

<Note> Both environments use the same API structure and authentication methods. Simply change the base URL when moving from Sandbox to Production. </Note>

<Warning>
  You must thoroughly test your integration in Sandbox mode before requesting access to Production. Production access is granted only after successful integration testing.
</Warning>

## API Versioning

<Info>
  The Rampnow API follows a stable versioning policy to ensure your integrations remain functional.
</Info>

### 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

<Warning>
  **Important:** We may add additional fields to JSON responses without notice or version changes. Ensure your code can handle unknown properties gracefully.
</Warning>

## Response Format

All API responses return JSON payloads with a consistent structure:

### Success Response

```JSON JSON theme={null}
{
  "code": 0,
  "data": {
    "orderId": "12345",
    "status": "completed",
    "amount": "100.00"
  }
}
```

### Error Response

```JSON JSON theme={null}
{
  "code": 100004,
  "message": "Invalid arguments - input data is not valid JSON"
}
```

## Key Features

<AccordionGroup> <Accordion title="RESTful Architecture" icon="arrows-rotate"> Built on REST principles with predictable resource-oriented URLs and standard HTTP methods. </Accordion> <Accordion title="JSON Responses" icon="brackets-curly"> All responses are returned in JSON format for easy parsing and integration. </Accordion> <Accordion title="HTTPS Only" icon="lock"> All API requests must be made over HTTPS. Plain HTTP requests are rejected for security. </Accordion> <Accordion title="HMAC Authentication" icon="key"> Secure request signing using HMAC-SHA256 ensures request authenticity and integrity. </Accordion> <Accordion title="Comprehensive Error Codes" icon="circle-exclamation"> Detailed error codes and messages help you quickly identify and resolve issues. </Accordion> </AccordionGroup>

## Next Steps

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

<div style={{display: 'grid', gridTemplateColumns: '1fr 1fr', gap: '1rem'}}>
  <Card title="Authentication" icon="shield-halved" href="/api-reference/Authentication">
    Learn how to authenticate your API requests
  </Card>

  <Card title="Error Codes" icon="list-check" href="/api-reference/error-codes">
    Understand error codes and how to handle them
  </Card>

  <Card title="API Endpoints" icon="code" href="/api-reference/users/createcustomeruser">
    Explore available API endpoints
  </Card>
</div>