Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.monei.cc/llms.txt

Use this file to discover all available pages before exploring further.

The Monei Node.js SDK is written in TypeScript and ships with full type definitions. It works in any Node.js ≥ 18 environment and supports both CommonJS and ESM.

Installation

npm install monei-sdk

Initialization

import MoneiSDK from 'monei-sdk';

const monei = new MoneiSDK({
  apiKey: process.env.MONEI_API_KEY!,
});

Configuration Options

OptionTypeRequiredDescription
apiKeystringYesYour API key from the Monei dashboard
baseUrlstringNoOverride the base URL (useful for sandbox)

SDK Services Overview

NamespaceService ClassWhat it does
monei.userUserServiceFetch and update the authenticated user
monei.walletAccountWalletAccountServiceWallet info and virtual accounts
monei.depositDepositServiceNaira wallet deposits
monei.payoutPayoutServiceBank & peer transfers
monei.walletUtilityWalletUtilityServiceBank lookup & account verification
monei.paymentMethodPaymentMethodServiceSaved payment methods
monei.evmEvmServiceEVM blockchain operations
monei.solanaSolanaServiceSolana blockchain operations
monei.evmExchangeEvmExchangeServiceToken swaps (EVM)
monei.solExchangeSolanaExchangeServiceToken swaps (Solana)
monei.billsBillServiceAirtime, data, electricity, cable TV
monei.transactionsTransaction history & lookup
monei.billDiscoveryBillDiscoveryServiceFecth available biller items
monei.offrampPayoutsOfframpPayoutServiceOfframp bank lookup & Verification
monei.billPayBillPayServicePayment for bills
monei.offrampLedgerOfframpLedgerServiceOfframp transaction history & lookup
monei.billRecordsBillRecordsServiceBills history & lookup
monei.offrampExchangeOfframpExchangeServiceSwap crypto to fiat
monei.billValidationBillValidateServiceValidate bills
monei.businessBusinessServicebusiness customer operations