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

# Getting Started

> Complete these three steps once to get your integration up and running.

## Step 1 — Upgrade to Reseller Tier

Only **Top User** accounts have access to the B2B API. Upgrade your account from the [Upgrade Package](https://rapidtopup.com.ng/upgrade-package) page.

> [!WARNING]
>
> Without a Top User account, all API calls return `403 Forbidden`. There are no exceptions.

***

## Step 2 — Generate an API Key (Live or Test)

After upgrading, navigate to **Settings → Developer API** in your dashboard. You can switch between **Live Mode** and **Test (Sandbox) Mode** to generate your respective API keys (`rtu_live_sk_...` or `rtu_test_sk_...`).

> [!WARNING]
>
> Your secret key is shown **only once** at the moment of creation. Copy it immediately and store it in a secure environment variable. It **cannot** be retrieved again — you would have to generate a new key.

***

## Step 3 — Set a Webhook URL *(Optional but Recommended)*

Configure a URL on your server to receive real-time `POST` notifications when a transaction status changes to `success` or `failed`.

Set this up in **Settings → Developer API → Webhook URL**.

***

## Sandbox & Test Mode (`rtu_test_sk_...`)

Before going live with real funds, use your **Test Key** (`rtu_test_sk_...`) to test your integration in the risk-free sandbox environment.

### Sandbox Test Numbers & Scenarios

When making test purchase requests, use these native test phone numbers to simulate different transaction outcomes:

| Phone Number | Event | Description |
| - | - | - |
| `08000000000` | Successful | Returns a successful response (`code: "000"`). |
| `08000000001` | Pending | Simulates a pending transaction response (`code: "091"`). |
| `08000000002` | Timeout | Simulates a gateway timeout scenario (`code: "099"`). |
| `08000000003` | Failed | Simulates a failed transaction scenario (`code: "099"`). |

***

## Test Your Setup

Once you have your API key, confirm everything is working with a balance check:

```bash theme={null}
curl --location 'https://api.rapidtopup.com.ng/api/v2/b2b/balance' \
--header 'Authorization: Bearer rtu_test_sk_YOUR_KEY_HERE'
```

A successful response looks like this:

```json theme={null}
{
  "status": "success",
  "environment": "sandbox",
  "data": {
    "balance": "500000.00",
    "currency": "NGN"
  }
}
```

***

## Postman Collection

> [card] [Download Postman Collection (v2.1)](https://rapidtopup.com.ng/downloads/RapidTopup_API.postman_collection.json)
>
> Import all B2B API endpoints, request bodies, query parameters, and response structures directly into Postman with one click.

If you see the successful balance response, you're ready to start making purchases. Proceed to the [API Reference](https://docs.rapidtopup.com.ng/api-reference/balance.md) section.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.