> For the complete documentation index, see [llms.txt](https://docs.cashramp.co/cashramp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cashramp.co/cashramp/introduction/readme.md).

# Getting Started

Welcome to the Cashramp Developer Documentation where you'll learn to build delightful payment experiences with the Cashramp API.

Cashramp lets you charge customers in **local African currencies** and settle instantly in **USD‑denominated stablecoins**. This five‑minute quick‑start walks you from sign‑up to your first API call.

***

## Environments

Cashramp has two separate environments. Each one has its own dashboard, its own accounts and its own API keys.

| Environment    | Use it for                            | Dashboard                                                                | API URL                                                  |
| -------------- | ------------------------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------- |
| **Sandbox**    | Building and testing your integration | [staging.business.useaccrue.com](https://staging.business.useaccrue.com) | `https://staging.api.useaccrue.com/cashramp/api/graphql` |
| **Production** | Live customers and real money         | [business.useaccrue.com](https://business.useaccrue.com)                 | `https://api.useaccrue.com/cashramp/api/graphql`         |

{% hint style="warning" %}
Keys only work in the environment they were created in. A sandbox key sent to the production API URL, or a production key sent to the sandbox API URL, returns `401 Unauthorized`.
{% endhint %}

***

## 1. Create an account ✅

1. Sign up on the dashboard for the environment you're working in:
   * **Sandbox:** <https://staging.business.useaccrue.com/signup>
   * **Production:** <https://business.useaccrue.com/signup>
2. Complete the business signup form.
3. You’ll land in the **Developer Dashboard**.

> **Tip** – Keep the Dashboard open in another tab; you’ll copy values from it in the next step.

***

## 2. Get your API keys ✅

1. In the same dashboard, open **Settings → Developers → API keys** ([Sandbox](https://staging.business.useaccrue.com/dashboard/settings) · [Production](https://business.useaccrue.com/dashboard/settings)).
2. Click **Generate keys**. You’ll receive:
   * **Public key** (`CSHRMP‑PUBK_…`): safe for front‑end use.
   * **Secret key** (`CSHRMP‑SECK_…`): **server only**; store it in an environment variable.
3. Copy your **secret key** somewhere safe—Cashramp shows it **once**.

> **Going live** – Your sandbox account and keys don’t carry over. When you’re ready for production, sign up on the production dashboard, generate a production secret key there, and change the base URL from `https://staging.api.useaccrue.com` to `https://api.useaccrue.com`.

***

## 3. Send your first request 🚀

The example below calls the **sandbox** API, so use a **sandbox** secret key. Paste the cURL snippet into a terminal and replace **`<YOUR_SECRET_KEY>`** with it.

```bash
curl https://staging.api.useaccrue.com/cashramp/api/graphql \
  -H "Authorization: Bearer <YOUR_SECRET_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
        "query": "{ account { id accountBalance } }"
      }'
```

Expected response (pretty‑printed):

```json
{
  "data": {
    "account": {
      "id": "QWNjb3VudC0xMjM0NTY=",
      "accountBalance": "0.00"
    }
  }
}
```

**Run it live** – Try the same query in our GraphiQL [Playground](https://cloud.hasura.io/public/graphiql?query=%7B+account+%7B+id+accountBalance+%7D+%7D\&endpoint=https%3A%2F%2Fstaging.api.useaccrue.com%2Fcashramp%2Fapi%2Fgraphql)

***

## 4. Next steps

| Flow                                                   | What you can build next                                     |
| ------------------------------------------------------ | ----------------------------------------------------------- |
| [**Hosted Ramp**](/cashramp/hosted-ramp/overview.md)   | Drop‑in checkout page that handles UI, FX, and settlement.  |
| [**Direct Ramp**](/cashramp/direct-ramp/overview.md)   | Server‑side API to collect local payments — no UI required. |
| [**Onchain Ramp**](/cashramp/onchain-ramp/overview.md) | Let self‑custody wallets deposit or withdraw stablecoins.   |

***

## 5. Reference & resources

* **API reference**: All queries, mutations, and types. [\[Docs\]](/cashramp/cashramp-api/queries.md)
* **Webhooks**: Real‑time transaction updates. [\[Guide\]](/cashramp/introduction/webhooks.md)
* **SDKs**: [\[Docs\]](/cashramp/introduction/sdks.md)