VePay TypeScript SDK

Official TypeScript/JavaScript developer client for VePay — Shariah-compliant instant financing and business funding for global eCommerce marketplace sellers.

Features

• Shariah-Compliant: Transparent flat fees (1% - 2%). No compounding interest, no hidden penalties, and zero late fees.
• Invoice Financing (Instapay): Programmatically request daily sales advances up to 70% of total invoice values.
• Algorithmic Eligibility: Submit store metrics to receive immediate financing limits.
• First-Class TypeScript Support: Full type-safety with JSDocs for IDE autocomplete.

Installation

Install via npm:

npm install @vepay/sdk

Or via yarn:

yarn add @vepay/sdk

Quickstart

Initialize the VePayClient using the API key obtained from your VePay Seller Portal.

import { VePayClient } from '@vepay/sdk';

// Initialize Client
const client = new VePayClient({
  apiKey: 'vp_live_abc123...', // Replace with your live API Key
});

async function run() {
  try {
    // 1. Get Account Balance & Limits
    const balance = await client.getBalance();
    console.log(`Available Limit: ${balance.availableLimit} ${balance.currency}`);
    console.log(`Pending Outstanding Balance: ${balance.pendingRepayment} ${balance.currency}`);

    // 2. Request Daily Invoice Draw (Advance 70%)
    if (balance.availableLimit > 1000) {
      const advanceResult = await client.requestAdvance({
        storeId: 'amzn_store_us_1029',
        amount: 5000.00, // Request financing from invoice total
      });
      console.log(`Disbursement Initiated! ID: ${advanceResult.advanceId}`);
      console.log(`Advanced Amount: ${advanceResult.advancedAmount}`);
      console.log(`Flat Fee: ${advanceResult.serviceFee} (No Interest)`);
    }
  } catch (error) {
    console.error('API Error:', error);
  }
}

run();

API Reference

new VePayClient(config: SDKConfig)

Initializes the client.

• apiKey: string (Required)
• baseUrl: string (Optional, defaults to https://api.vepay.io/v1)

client.checkEligibility(criteria: EligibilityRequest)

Evaluate eligibility based on store volumes.

const result = await client.checkEligibility({
  platform: 'Amazon',
  monthlySales: 45000.00,
  currency: 'USD',
  country: 'US',
});

client.requestAdvance(advance: AdvanceRequest)

Requests an advance on daily sales invoices.

const result = await client.requestAdvance({
  storeId: 'shopify_store_uk_7721',
  amount: 2500.00
});

client.getBalance()

Retrieve live limits and active repayments.

const balance = await client.getBalance();

License

This SDK is open-source software licensed under the MIT License.