Skip to main content

​
Overview

Before making eSIM purchases, you can check your wallet balance to display it to users or verify sufficient funds are available. The system automatically checks balance during purchase, but displaying it beforehand improves user experience.

​
Quick Start

async function getBalance() {
  const response = await fetch('https://api.vellosim.com/api/wallet/balance', {
    method: 'GET',
    headers: {
      'X-API-Key': `API_KEY}`,
      'Content-Type': 'application/json'
    }
  });
  
  const data = await response.json();
  return data.balance;
}

// Usage
const balance = await getBalance();
console.log(`Available balance: ${balance.currency} ${balance.amount}`);

​
Response Format

{
  "balance": {
    "amount": 50000.00,
    "currency": "NGN"
  },
  "lastUpdated": "2024-01-15T10:30:00Z"
}

​
Response Fields

FieldTypeDescription
balance.amountnumberAvailable balance amount
balance.currencystringCurrency code (e.g., NGN, USD)
lastUpdatedstringISO 8601 timestamp of last balance update

​
Next Steps

Purchase eSIM

Use wallet balance to purchase eSIM packages

API Reference

Complete API documentation