POST Register New User

Create a new user account (mobile_user, reseller, or developer).

{
  "email": "user@example.com",
  "password": "SecurePassword123!",
  "role": "reseller",
  "name": "My Business"
}

{
  "success": true,
  "message": "Registration successful. Please verify your email.",
  "user": {
    "id": "user-123",
    "email": "user@example.com",
    "role": "reseller",
    "verified_at": null,
    "profile_complete": false,
    "initial_deposit_made": false
  },
  "verification_token_status": "sent"
}

POST User Login

Authenticate with email and password to obtain access and refresh tokens.

{
  "email": "user@example.com",
  "password": "SecurePassword123!"
}

{
  "success": true,
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
  "user": {
    "id": "user-123",
    "email": "user@example.com",
    "role": "reseller"
  },
  "token_expires_in": 3600
}

POST Verify Email Address

Verify user email using verification token sent to email.

{
  "email": "user@example.com",
  "verification_token": "token-from-email"
}

POST Resend Verification Email

Send a new verification link to the user’s email.

{
  "email": "user@example.com"
}

POST Refresh Access Token

Exchange a valid refresh token for a new access token.

{
  "refresh_token": "eyJhbGciOiJIUzI1NiIs..."
}

{
  "success": true,
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_expires_in": 3600
}

POST Request Password Reset

Send password reset email.

{
  "email": "user@example.com"
}

POST Reset Password with Token

Reset password using token from email.

{
  "reset_token": "token-from-email",
  "new_password": "NewSecurePassword123!"
}

POST Logout User 🔒 Auth Required

Invalidate user session and tokens.

GET Get Current User Profile 🔒 Auth Required

Fetch authenticated user’s profile with role-specific data. For resellers/developers: includes credit account info. For resellers: includes reseller profiles list.

{
  "success": true,
  "data": {
    "id": "user-123",
    "email": "user@example.com",
    "role": "reseller",
    "verified_at": "2025-01-15T10:00:00Z",
    "profile_complete": true,
    "initial_deposit_made": true,
    "created_at": "2025-01-15T10:00:00Z"
  }
}

PUT Change User Password 🔒 Auth Required

Update password with validation of old password.

{
  "old_password": "OldPassword123!",
  "new_password": "NewPassword123!",
  "confirm_password": "NewPassword123!"
}

GET List Available eSIM Plans 🔒 Auth Required

Get available eSIM plans with filtering and pagination. Resellers see plans with their custom markup applied. Russia plans are excluded.

GET Get Specific Plan Details 🔒 Auth Required

Retrieve details for a specific eSIM plan by ID.

GET Get Regional Plans 🔒 Auth Required

Get all plans for a specific region (e.g., “EU”, “NA”, “ASIA”).

POST Create New eSIM Order 🔒 Auth Required

Create a new eSIM order. For Resellers: Must have completed onboarding, must have sufficient credit balance, order total is deducted from credit account, applies custom pricing markups if configured.

{
  "plan_id": "plan-123",
  "quantity": 1,
  "provider_id": "provider-1",
  "reseller_profile_id": "profile-1",
  "end_customer_email": "customer@example.com",
  "customer_name": "John Customer"
}

{
  "success": true,
  "message": "Order created successfully",
  "order": {
    "id": "ord-abc123def456",
    "user_id": "user-123",
    "plan_id": "plan-123",
    "plan_name": "5GB - USA",
    "quantity": 1,
    "unit_price": 15.00,
    "total_amount": 15.00,
    "currency": "USD",
    "status": "active",
    "iccid": "8901234567890123456",
    "qr_code_url": "https://api.example.com/qr/order-123.png"
  }
}

GET List User’s Orders 🔒 Auth Required

Get paginated list of user’s orders with optional filtering.

GET Get Order Details 🔒 Auth Required

Retrieve details for a specific order.

PUT Update Order 🔒 Auth Required

Update order details (status, customer info, etc.).

{
  "status": "completed",
  "customer_email": "updated@example.com",
  "customer_name": "Updated Name"
}

DELETE Cancel Order 🔒 Auth Required

Cancel or delete an order.

GET Get Profile Information 🔒 Auth Required

Get eSIM profile information by ICCID, esimTranNo, or order_id.

Path Parameters

{
  "identifier": "89012345678901234567" // ICCID, esimTranNo, or order_id
}

Response (200 OK)

{
  "success": true,
  "profile": {
    "iccid": "89012345678901234567",
    "status": "active",
    "data_remaining": 4500,
    "validity_days": 28
  }
}

GET Get Profile Usage 🔒 Auth Required

Check usage data for an eSIM profile.

Response (200 OK)

{
  "success": true,
  "usage": {
    "data_used": 500,
    "data_limit": 5000,
    "percent_used": 10
  }
}

POST Suspend Profile 🔒 Auth Required

Suspend an active eSIM profile.

Response (200 OK)

{
  "success": true,
  "message": "Profile suspended successfully"
}

POST Unsuspend Profile 🔒 Auth Required

Restore a suspended eSIM profile.

Response (200 OK)

{
  "success": true,
  "message": "Profile unsuspended successfully"
}

POST Revoke Profile 🔒 Auth Required

Permanently revoke an eSIM profile.

Response (200 OK)

{
  "success": true,
  "message": "Profile revoked successfully"
}

POST Top Up Profile 🔒 Auth Required

Add data to an existing eSIM profile.

Request Body

{
  "package_code": "PKG_5GB_30D"
}

Response (200 OK)

{
  "success": true,
  "message": "Profile topped up successfully",
  "topup_details": {}
}

GET Get Available Topup Plans 🔒 Auth Required

Retrieve available topup plans for a profile.

Response (200 OK)

{
  "success": true,
  "plans": [
    {
      "package_code": "PKG_5GB_30D",
      "data_volume_mb": 5120,
      "price": 15.00,
      "validity_days": 30
    }
  ]
}

POST Send SMS to Profile 🔒 Auth Required

Send an SMS message to an eSIM profile.

Request Body

{
  "message": "Your eSIM has been activated"
}

Response (200 OK)

{
  "success": true,
  "message": "SMS sent successfully"
}

GET Get Current Credit Balance 🔒 Auth Required

Retrieve current credit balance for reseller/developer. Response differs by billing mode: Prepaid shows balance, soft_limit_threshold, current_usage. Postpaid shows credit_limit, current_usage, available_credit.

{
  "success": true,
  "balance": 1500.00,
  "currency": "USD",
  "billing_mode": "prepaid",
  "soft_limit_threshold": 100.00,
  "current_usage": 50.00,
  "available_credit": 1450.00
}

GET Get Credit Transaction History 🔒 Auth Required

Retrieve credit transactions with filtering by type, status, and date range.

POST Top Up Credits via PayPal 🔒 Auth Required

Initiate credit top-up for prepaid mode. Requirements: Prepaid billing mode only, initial deposit must be completed.

{
  "amount": 500.00,
  "currency": "USD"
}

{
  "success": true,
  "message": "PayPal order created",
  "paypal_order": {
    "id": "paypal-order-123",
    "amount": 500.00,
    "currency": "USD",
    "approval_link": "https://sandbox.paypal.com/checkoutnow?token=...",
    "status": "CREATED"
  }
}

POST Create PayPal Order 🔒 Auth Required

Create a PayPal order for payment.

{
  "amount": 500.00,
  "currency": "USD",
  "orderId": "ord-abc123"
}

POST Capture PayPal Payment 🔒 Auth Required

Capture PayPal payment and credit account. Accepts multiple field names: orderID, orderId, order_id, or paypal_order_id.

{
  "orderID": "paypal-order-123"
}

{
  "success": true,
  "transaction": {
    "id": "txn-125",
    "amount": 500.00,
    "status": "completed",
    "new_balance": 2000.00
  }
}

POST Initiate Initial Deposit 🔒 Auth Required

Start the initial deposit process for resellers. Requirements: First-time deposit only, Minimum: $50, Maximum: $50,000.

{
  "amount": 100.00,
  "currency": "USD",
  "return_url": "https://yoursite.com/success",
  "cancel_url": "https://yoursite.com/cancel",
  "payment_method": "paypal_redirect"
}

POST Confirm Initial Deposit 🔒 Auth Required

Confirm and process initial deposit payment.

{
  "paypal_order_id": "paypal-order-deposit-123"
}

GET Check Initial Deposit Status 🔒 Auth Required

Check if initial deposit has been made and view current balance.

GET Get Reseller Dashboard 🔒 Auth Required

Retrieve dashboard data including account balance, pending invoices, recent orders, and transactions.

Response (200 OK)

{
  "success": true,
  "data": {
    "account": {
      "balance": 1500.00,
      "billing_mode": "prepaid",
      "currency": "USD",
      "credit_limit": 5000.00,
      "current_usage": 250.00
    },
    "pending_invoices": [],
    "recent_orders": [],
    "recent_transactions": []
  }
}

GET Get Reseller Profiles 🔒 Auth Required

Retrieve all reseller branding profiles.

POST Create Reseller Profile 🔒 Auth Required

Create a new branding profile for reseller.

{
  "name": "My eSIM Store",
  "email_sender_name": "My Store",
  "is_default": true,
  "color_scheme": "#FF5733"
}

PUT Update Reseller Profile 🔒 Auth Required

Update an existing reseller profile.

DELETE Delete Reseller Profile 🔒 Auth Required

Delete a reseller profile.

GET Get SMTP Configuration 🔒 Auth Required

Retrieve SMTP configuration for a reseller profile. Password is never returned, only a flag indicating if it’s configured.

Response (200 OK)

{
  "success": true,
  "smtp_config": {
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587,
    "smtp_user": "noreply@example.com",
    "smtp_secure": true,
    "email_from": "noreply@example.com",
    "email_from_name": "My eSIM Store",
    "use_custom_smtp": true,
    "smtp_pass_configured": true
  }
}

PUT Update SMTP Configuration 🔒 Auth Required

Update or configure custom SMTP settings for a reseller profile. Password is encrypted using AES-256-CBC. Connection is tested automatically after update.

Request Body

{
  "smtp_host": "smtp.gmail.com",
  "smtp_port": 587,
  "smtp_user": "noreply@example.com",
  "smtp_pass": "yourpassword",
  "smtp_secure": true,
  "email_from": "noreply@example.com",
  "email_from_name": "My eSIM Store",
  "use_custom_smtp": true
}

Response (200 OK)

{
  "success": true,
  "message": "SMTP configuration updated and tested successfully",
  "smtp_config": {
    "smtp_host": "smtp.gmail.com",
    "smtp_port": 587,
    "smtp_user": "noreply@example.com",
    "use_custom_smtp": true
  }
}

POST Test SMTP Configuration 🔒 Auth Required

Test the SMTP connection for a reseller profile.

Response (200 OK)

{
  "success": true,
  "message": "SMTP connection test successful"
}

DELETE Disable Custom SMTP 🔒 Auth Required

Disable custom SMTP configuration and clear all SMTP data. Emails will be sent using default system SMTP.

Response (200 OK)

{
  "success": true,
  "message": "Custom SMTP disabled successfully"
}

GET Get Reseller Pricing Overrides 🔒 Auth Required

Retrieve custom pricing overrides for plans.

PUT Update Plan Pricing 🔒 Auth Required

Set custom pricing for a plan (markup % or fixed price).

{
  "markup_percent": 20
}

{
  "final_price_usd": 18.00
}

GET Get Enhanced Balance 🔒 Auth Required

Get balance with timestamp for specific provider.

POST Check Usage for eSIMs 🔒 Auth Required

Get data usage for specific eSIMs or orders.

{
  "provider_id": "provider-1",
  "esimTranNoList": ["esim-tran-123", "esim-tran-124"]
}

GET Get Order Usage 🔒 Auth Required

Get data usage for a specific order.

{
  "success": true,
  "order_id": "ord-abc123",
  "usage": {
    "data_used": "1.2GB",
    "data_total": "5GB",
    "data_remaining": "3.8GB",
    "percentage_used": 24.0,
    "validity_remaining_days": 25
  }
}

GET List Webhook Subscriptions 🔒 Auth Required

Get user’s webhook subscriptions with available event types.

POST Create Webhook Subscription 🔒 Auth Required

Create a new webhook subscription with automatic test.

{
  "name": "Order Status Updates",
  "endpoint_url": "https://yourapp.com/webhooks/orders",
  "event_types": ["ORDER_STATUS", "ESIM_STATUS"],
  "secret": "your-webhook-secret",
  "timeout_seconds": 30,
  "retry_count": 3
}

GET Get Webhook Subscription 🔒 Auth Required

Retrieve details for a specific webhook subscription.

PUT Update Webhook Subscription 🔒 Auth Required

Update webhook subscription settings.

DELETE Delete Webhook Subscription 🔒 Auth Required

Delete a webhook subscription.

POST Send Test Webhook 🔒 Auth Required

Send a test webhook to the endpoint.

GET Get Webhook Delivery Logs 🔒 Auth Required

Get webhook delivery history for a subscription.

GET Health Check

Check API and service health status.

{
  "status": "healthy",
  "timestamp": "2025-01-15T10:00:00Z",
  "services": {
    "database": "connected",
    "redis": "connected"
  }
}

POST Upload Reseller Logo 🔒 Auth Required

Upload a reseller logo file (PNG/JPEG, max 5MB).

Content-Type: multipart/form-data

logo: [binary file data]