@nexysbank/sdk

Official TypeScript/JavaScript SDK for the Nexys Bank API.

Installation

npm install @nexysbank/sdk
# or
yarn add @nexysbank/sdk
# or
pnpm add @nexysbank/sdk

Quick Start

import { NexysBankClient } from '@nexysbank/sdk';

// Initialize the client
const client = new NexysBankClient({
  baseUrl: 'https://api.nexysbank.com/api/v1'
});

// Set authentication token (after user login)
client.setToken('your-jwt-token');

// Create a customer
const customer = await client.createCustomer({
  customerType: 'individual',
  email: '[email protected]',
  firstName: 'John',
  lastName: 'Doe',
  dateOfBirth: '1990-01-15',
  nationality: 'US',
  mobile: '+14155551234',
  address: {
    addressLine1: '123 Main St',
    city: 'San Francisco',
    state: 'CA',
    country: 'US',
    postcode: '94102'
  }
});

if (customer.success) {
  console.log('Customer created:', customer.data.id);
}

Features

• Full TypeScript support with complete type definitions
• All Nexys Bank API endpoints covered
• Zero dependencies (uses native fetch)
• Works in Node.js and browsers

API Reference

Customers

client.createCustomer(input)      // Create a new customer
client.getCustomer(customerId)    // Get customer by ID
client.getCurrentCustomer()       // Get authenticated customer
client.updateCustomer(id, data)   // Update customer

Wallets

client.createWallet(input)              // Create wallet
client.listWallets()                    // List all wallets
client.getWallet(walletId)              // Get wallet details
client.getWalletBalance(walletId)       // Get wallet balance
client.getWalletTransactions(walletId)  // Get transactions
client.assignVan(walletId, currencies)  // Assign virtual account

Transfers & Payouts

client.createTransfer(input)     // Internal transfer
client.addBeneficiary(input)     // Add beneficiary
client.listBeneficiaries()       // List beneficiaries
client.createPayout(input)       // Send payout
client.listPayouts()             // List payouts

FX

client.getFxRates(from, to)           // Get exchange rates
client.createFxQuote(from, to, lock)  // Lock a rate
client.executeFxConversion(input)     // Execute conversion

Cards

client.issueCard(input)              // Issue new card
client.listCards()                   // List cards
client.activateCard(cardId)          // Activate card
client.blockCard(cardId, reason)     // Block card
client.unblockCard(cardId)           // Unblock card
client.updateCardLimits(cardId, limits)  // Update limits

Error Handling

const result = await client.createPayout(payoutData);

if (result.success) {
  console.log('Payout created:', result.data);
} else {
  console.error('Error:', result.error.code, result.error.message);
}

License

MIT