> For the complete documentation index, see [llms.txt](https://docs.esimpay.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.esimpay.net/eng/start-of-work.md).

# Start of work

#### Welcome to the complete ESIMPAY API documentation — a platform for managing eSIM profiles and data packages.

###  Quick navigation

* Quick start — get started in 5 minutes
* Authentication — how to sign requests
* API Reference — all endpoints
* Error handling — troubleshooting

### 🌐 Basic information

| Parameter           | Value                            |
| ------------------- | -------------------------------- |
| **API Endpoint**    | `https://api.esimpay.net/api/v1` |
| **API Version**     | `1.0.0`                          |
| **Authentication**  | HMAC-SHA256                      |
| **Response Format** | JSON                             |

### Quick start

#### 1. Check your balance

```bash
curl -X GET https://api.esimpay.net/api/v1/customer/balance \
  -H "CF-MERCHANT-ID: your_merchant_id"
```

#### 2. Get available packages

```bash
curl -X GET https://api.esimpay.net/api/v1/products/list \
  -H "CF-MERCHANT-ID: your_merchant_id"
```

#### 3. Create an order (signature required)

See the Authentication section for how to generate a signature.

#### Security

All requests require two headers:

| Header           | Description                               |
| ---------------- | ----------------------------------------- |
| `CF-MERCHANT-ID` | Your merchant identifier                  |
| `CF-ACCESS-SIGN` | HMAC-SHA256 signature of the request body |

### Core features

#### Balance Management

Track your account balance in real time.

```bash
GET /customer/balance
```

#### eSIM Orders

Create orders, top up packages, and manage eSIM profiles.

```bash
POST /orders/submit
POST /orders/topup
```

#### History & Reports

Get a detailed history of all transactions.

```bash
GET /customer/history
```

#### Product Catalog

Browse available packages and pricing.

```bash
GET /products/list
```

### Operation statuses

| Status         | Description                      |
| -------------- | -------------------------------- |
| completed      | Operation completed successfully |
| in\_processing | Operation is in progress         |
| canceled       | Operation canceled               |
| ERROR          | An error occurred                |