Getting Started

Installation

Install the SDK via npm:

npm install wirex-pay-sdk

Setup and Initialization

To begin using the SDK, import the WirexPay class and initialize it with the necessary configuration options.

To obtain JWT API token please see Authorization.

Configuration Interface

interface IConfig {
  token: string;              // API token for authentication (required)
  subscribeToSocket?: boolean; // Enable WebSocket subscription (optional)
  socketUrl?: string;          // WebSocket server URL (optional)
  apiUrl?: string;             // API base URL (optional)
}

Initializing WirexPay SDK

import { WirexPay } from 'wirex-pay-sdk';

const config = {
  token: 'your-user-specific-token',
  subscribeToSocket: true, // Enable real-time updates via WebSocket
};

WirexPay.init(config);