Reseller API Documentation

Get your account information and current balance.

Response

{
  "success": true,
  "data": {
    "companyName": "Your Company",
    "status": "approved",
    "balance": 10000,
    "balanceFormatted": "$100.00",
    "totalOrders": 42
  }
}

Get your current wallet balance and available credit.

List your transaction history with pagination.

Query Parameters

• page - Page number (default: 1)
• limit - Items per page (default: 20, max: 100)
• type - Filter by type: deposit, order, topup, refund, adjustment

List available eSIM packages with full details.

Query Parameters

• type - Filter by plan type:
  • data - Data-only eSIM packages (default)
  • phone - Phone plans with voice + SMS + data
  • all - Both data and phone plans
• country - Filter by country code (e.g., US, JP, GB)
• region - Filter by region name
• duration - Filter by duration in days
• minData - Minimum data in GB
• maxData - Maximum data in GB
• privacy - Filter by privacy level:
  • max - Only max privacy packages (non-HK/China IP routing)
  • standard - Only standard packages (HK/China IP routing)
  • all - All packages (default)
• page - Page number
• limit - Items per page (max: 200)

Response

{
  "success": true,
  "data": {
    "packages": [
      {
        "packageCode": "JP_7D_1GB",
        "name": "Japan 7 Days 1GB",
        "slug": "japan-7-days-1gb",
        "location": "JP",
        "locationCode": "JP",
        "region": null,
        "isGlobalPackage": false,
        "locationNetworkList": [
          {
            "locationName": "Japan",
            "operatorList": [
              { "operatorName": "Docomo", "networkType": "4G" }
            ]
          }
        ],
        "volume": 1073741824,
        "volumeGB": 1,
        "dataType": 1,
        "isUnlimited": false,
        "validityDays": 7,
        "dailyDataGB": null,
        "fupMbps": null,
        "duration": 7,
        "durationUnit": "DAY",
        "speed": "4G/LTE",
        "pricingType": "fixed",
        "price": 450,
        "priceFormatted": "$4.50",
        "suggestedRetailPrice": 500,
        "suggestedRetailPriceFormatted": "$5.00",
        "discount": "10%",
        "durationDiscounts": null,
        "ipExport": "US",
        "maxPrivacy": true,
        "smsStatus": 0,
        "supportTopUpType": true,
        "activeType": 1,
        "description": "7-day Japan eSIM with 1GB data"
      }
    ],
    "pagination": { "page": 1, "limit": 50, "total": 150, "pages": 3 }
  }
}

Field Descriptions

• pricingType - IMPORTANT: Either "fixed" or "per_day":
  • "fixed" - Price is total for the package (standard data plans)
  • "per_day" - Price is per day, customer selects duration at checkout (Unlimited Daily plans)
• price - Your cost in cents (10% off retail). For per_day plans, this is the daily rate.
• suggestedRetailPrice - Suggested retail price in cents. For per_day plans, this is the daily rate.
• discount - Your discount percentage
• durationDiscounts - For per_day plans only: object with discount percentages by duration tier. Null for fixed plans.
• volume - Data volume in bytes
• volumeGB - Data volume in GB
• dataType - 1 = fixed data, 2 = Unlimited Daily
• isUnlimited - true for Unlimited Daily plans (dataType=2). Use this instead of checking dataType.
• validityDays - Maximum validity period. For Unlimited plans, this is how long the eSIM remains valid if unused (e.g., 180 days), not the purchased duration.
• dailyDataGB - For Unlimited plans: daily high-speed data in GB. Null for fixed plans.
• fupMbps - Fair Usage Policy speed limit in Mbps after daily data exhausted. Parsed from name (e.g., "FUP1Mbps" → 1). Null if not specified.
• locationCode - ISO country code for single-country packages (e.g., "MA" for Morocco). Null for regional/global.
• ipExport - Country where traffic exits (null = HK)
• maxPrivacy - true if non-HK/China IP routing
• smsStatus - 0 = no SMS, 1 = SMS supported, 2 = API SMS only
• supportTopUpType - Whether top-ups are available
• activeType - 1 = first install, 2 = first network connection
• planType - "data" for data-only, "data-voice-text" for phone plans
• hasVoice - true if the plan includes voice calling
• hasSms - true if the plan includes SMS
• voiceMinutes - Number of voice minutes included (0 if none)
• smsCount - Number of SMS messages included (0 if none)
• phoneNumberIncluded - true if a real phone number is assigned on activation

Get full details for a specific package (same fields as list response).

Create a new eSIM order. The eSIM details will be delivered via webhook when ready.

Request Body

{
  "packageCode": "JP_7D_1GB",
  "externalOrderId": "YOUR-REF-123"  // Optional: your reference ID
}

Response

{
  "success": true,
  "data": {
    "orderId": "65a4f8c9...",
    "externalOrderId": "YOUR-REF-123",
    "status": "processing",
    "packageCode": "JP_7D_1GB",
    "price": 518,
    "priceFormatted": "$5.18",
    "message": "Order created. eSIM details will be sent via webhook."
  }
}

List your orders with pagination.

Query Parameters

• status - Filter by status: pending, processing, completed, failed
• page - Page number
• limit - Items per page

Get details for a specific order including eSIM details if completed.

Get full eSIM details including live status from the network.

Response

{
  "success": true,
  "data": {
    "iccid": "8901234567890123456",
    "orderId": "65a4f8c9...",
    "externalOrderId": "YOUR-REF-123",
    "packageCode": "JP_7D_1GB",
    "packageName": "Japan 7 Days 1GB",
    "qrCodeUrl": "https://...",
    "activationCode": "LPA:1$...",
    "lpaUrl": "https://...",
    "shortUrl": "https://...",
    "status": "IN_USE",
    "smdpStatus": "ENABLED",
    "totalData": 1073741824,
    "usedData": 536870912,
    "remainingData": 536870912,
    "expireTime": "2024-01-22T00:00:00Z",
    "apn": "internet",
    "imsi": "...",
    "msisdn": "+1234567890",  // Phone plans only. May be a placeholder until end user activates. See note below.
    "packageList": [...],
    "purchasedAt": "2024-01-15T10:30:00Z",
    "createdAt": "2024-01-15T10:30:05Z"
  }
}

Get detailed data usage statistics for an eSIM.

Response

{
  "success": true,
  "data": {
    "iccid": "8901234567890123456",
    "status": "IN_USE",
    "smdpStatus": "ENABLED",
    "statusDescription": "eSIM is active and in use",
    "totalData": 1073741824,
    "usedData": 536870912,
    "remainingData": 536870912,
    "totalDataGB": 1,
    "usedDataGB": 0.5,
    "remainingDataGB": 0.5,
    "totalDataMB": 1024,
    "usedDataMB": 512,
    "remainingDataMB": 512,
    "usagePercent": 50,
    "expireTime": "2024-01-22T00:00:00Z",
    "createTime": "2024-01-15T10:30:00Z",
    "packageList": [
      {
        "packageCode": "JP_7D_1GB",
        "packageName": "Japan 7 Days 1GB",
        "volume": 1073741824,
        "volumeGB": 1,
        "duration": 7,
        "createTime": "2024-01-15T10:30:00Z"
      }
    ]
  }
}

eSIM Status Values

• GOT_RESOURCE - eSIM ready for installation
• IN_USE - eSIM is active and in use
• ENABLED - eSIM is enabled and ready
• SUSPENDED - eSIM has been suspended
• USED_UP - All data has been consumed
• REVOKED - eSIM has been revoked

Get available top-up packages for an eSIM.

Add data to an existing eSIM.

Request Body

{
  "packageCode": "JP_TOPUP_1GB",
  "externalOrderId": "YOUR-REF-456"  // Optional
}

Cancel an unused eSIM and receive a refund. Only works if no data has been consumed on the network.

Requirements

• esimStatus must be GOT_RESOURCE
• orderUsage must be 0 (no data consumed)

Response

{
  "success": true,
  "data": {
    "iccid": "89852240810732443908",
    "orderId": "65a4f8c9...",
    "refundAmount": 500,
    "refundFormatted": "$5.00",
    "newBalance": 1500,
    "newBalanceFormatted": "$15.00",
    "message": "eSIM cancelled successfully. Refund added to your balance."
  }
}

Error Response (eSIM already in use)

{
  "success": false,
  "error": "eSIM cannot be cancelled - already installed or in use",
  "currentStatus": {
    "esimStatus": "IN_USE",
    "smdpStatus": "ENABLED"
  },
  "message": "Only unused eSIMs that have not been installed can be cancelled for a refund."
}

Create a Stripe checkout session to add funds to your wallet.

Request Body

{
  "amount": 10000  // Amount in cents ($100.00)
}

Response

{
  "success": true,
  "sessionId": "cs_live_...",
  "checkoutUrl": "https://checkout.stripe.com/..."
}

Create a BTCPay invoice to add funds via cryptocurrency.

Request Body

{
  "amount": 10000  // Amount in cents ($100.00)
}

Update your webhook settings.

Request Body

{
  "webhookUrl": "https://your-server.com/webhook",
  "webhookEvents": ["esim.provisioned", "esim.topup.completed", "order.failed"]
}

Send a test webhook to verify your endpoint.

{
  "event": "esim.provisioned",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "orderId": "65a4f8c9...",
    "externalOrderId": "YOUR-REF-123",
    "packageCode": "JP_7D_1GB",
    "esim": {
      "iccid": "8901234567890123456",
      "qrCodeUrl": "https://...",
      "activationCode": "LPA:1$...",
      "shortUrl": "https://..."
    }
  }
}

const crypto = require('crypto');

function verifySignature(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(JSON.stringify(payload))
    .digest('hex');
  return signature === expected;
}