mpesajs
Version:
A Node.js SDK for seamless integration with M-Pesa payment gateway, providing easy-to-use methods for handling transactions, payments, and API interactions
157 lines • 7.76 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Payout = void 0;
const axios_1 = __importStar(require("axios"));
const ErrorHandlers_1 = require("./errors/ErrorHandlers");
const crypto_1 = require("crypto");
const RateLimiter_1 = require("./utils/RateLimiter");
const env_1 = require("./utils/env");
class Payout {
/**
* Creates an instance of Payout
* @param auth - Instance of Auth class for token generation
* @param initiatorName - Name of the initiator making the request
* @param securityCredential - Encrypted security credential
* @param sandbox - Whether to use sandbox environment
*/
constructor(auth, initiatorName = (0, env_1.getEnvVar)('MPESA_INITIATOR_NAME', ''), securityCredential = (0, env_1.getEnvVar)('MPESA_SECURITY_CREDENTIAL', ''), sandbox = (0, env_1.getEnvVar)('MPESA_SANDBOX', 'true').toLowerCase() === 'true') {
this.auth = auth;
this.initiatorName = initiatorName;
this.securityCredential = securityCredential;
this.baseUrl = sandbox
? 'https://apisandbox.safaricom.et/mpesa/b2c/v2/paymentrequest'
: 'https://api.safaricom.et/mpesa/b2c/v2/paymentrequest';
this.rateLimiter = RateLimiter_1.RateLimiter.getInstance();
}
/**
* Validates the URLs are HTTPS
* @param queueTimeoutUrl - URL for timeout notifications
* @param resultUrl - URL for result notifications
*/
validateUrls(queueTimeoutUrl, resultUrl) {
const urlParams = {
queueTimeoutUrl,
resultUrl
};
if (!Object.values(urlParams).every(url => url.startsWith('https://'))) {
const invalidUrls = Object.entries(urlParams)
.filter(([_, url]) => !url.startsWith('https://'))
.map(([param, url]) => `${param}: ${url}`);
throw new ErrorHandlers_1.ValidationError('Both queue timeout and result URLs must use HTTPS protocol', invalidUrls.join(', '));
}
}
validatePhoneNumber(phoneNumber) {
if (!phoneNumber.match(/^251[7-9][0-9]{8}$/)) {
throw new ErrorHandlers_1.ValidationError('Phone number must start with 251 and be 12 digits long', 'phoneNumber');
}
}
validateAmount(amount) {
if (amount <= 0) {
throw new ErrorHandlers_1.ValidationError('Amount must be greater than 0', 'amount');
}
}
/**
* Builds the payload for payout request
*/
buildPayload(amount, remarks, occasion, commandId, shortCode, phoneNumber, queueTimeoutUrl, resultUrl) {
return {
OriginatorConversationID: `Partner name -${(0, crypto_1.randomUUID)()}`,
InitiatorName: this.initiatorName,
SecurityCredential: this.securityCredential,
CommandID: commandId,
PartyA: shortCode,
PartyB: phoneNumber,
Amount: amount,
Remarks: remarks,
Occassion: occasion,
QueueTimeOutURL: queueTimeoutUrl,
ResultURL: resultUrl
};
}
send(amount_1, remarks_1) {
return __awaiter(this, arguments, void 0, function* (amount, remarks, occasion = 'Payout', commandId = (0, env_1.getEnvVar)('MPESA_PAYOUT_COMMAND_ID', ''), shortCode = (0, env_1.getEnvVar)('MPESA_BUSINESS_SHORTCODE', ''), phoneNumber = (0, env_1.getEnvVar)('MPESA_PHONE_NUMBER', ''), queueTimeoutUrl = (0, env_1.getEnvVar)('MPESA_QUEUE_TIMEOUT_URL', ''), resultUrl = (0, env_1.getEnvVar)('MPESA_RESULT_URL', '')) {
return this.rateLimiter.execute(() => __awaiter(this, void 0, void 0, function* () {
var _a, _b;
try {
// Validate inputs
this.validateUrls(queueTimeoutUrl, resultUrl);
this.validatePhoneNumber(phoneNumber);
this.validateAmount(amount);
// Get access token
const { token: accessToken } = yield this.auth.generateToken();
// Prepare and send request
const payload = this.buildPayload(amount, remarks, occasion, commandId, shortCode, phoneNumber, queueTimeoutUrl, resultUrl);
const response = yield axios_1.default.post(this.baseUrl, payload, {
headers: {
'Authorization': `Bearer ${accessToken}`,
'Content-Type': 'application/json'
}
});
// Handle successful response
if (((_a = response.data) === null || _a === void 0 ? void 0 : _a.ResponseCode) === '0') {
return {
ConversationID: response.data.ConversationID,
OriginatorConversationID: response.data.OriginatorConversationID,
ResponseCode: response.data.ResponseCode,
ResponseDescription: response.data.ResponseDescription
};
}
ErrorHandlers_1.PayoutErrorHandler.handle(response.data);
}
catch (error) {
if (error instanceof ErrorHandlers_1.ValidationError) {
throw error;
}
if (error instanceof axios_1.AxiosError) {
ErrorHandlers_1.PayoutErrorHandler.handle((_b = error.response) === null || _b === void 0 ? void 0 : _b.data);
}
throw error;
}
}));
});
}
}
exports.Payout = Payout;
//# sourceMappingURL=payout.js.map