ZibaPaySDK

The ZibaPaySDK is a Node.js package designed to simplify the integration of the Zibapay Payment API. This SDK enables developers to interact with the Zibapay API to initiate MTN Mobile Money (MoMo) payments with minimal setup.

Features

• Easy integration with the Zibapay Payment API.
• Handles API authentication using API key and secret.
• Supports MTN Mobile Money payments.
• Provides robust error handling for API requests.

Installation

Install the package using npm or yarn:

npm install zibapay-sdk
# or
yarn add zibapay-sdk

Usage

Import the sdk

import ZibaPaySDK from "zibapay-sdk";  

Initialize SDK

-To start using the SDK, you need your API key and API secret from Zibapay:

const zibaPay = new ZibaPaySDK("your-api-key", "your-api-secret");

Initiate MTN Momo Payment

(async () => {  
    try {  
        const paymentResponse = await zibaPay.initiateMtnPayment({  
            phoneNumber: "250788123456", // Customer's phone number  
            amount: 1000,               // Payment amount  
            currency: "RWF",            // Currency (e.g., RWF)  
            description: "Payment for Order #12345", // Payment description  
        });  

        console.log("Payment Response:", paymentResponse);  
    } catch (error) {  
        console.error("Payment Failed:", error.message);  
    }  
})();  

API Reference

Constructor

new ZibaPaySDK(apiKey: string, apiSecret: string)  

• apiKey: Your Zibapay API key.
• apiSecret: Your Zibapay API secret.

Methods

*initiateMtnPayment(params: initiateMtnPayment): Promise Initiates an MTN Mobile Money payment

Parameters

params (object): An object containing payment details: phoneNumber (string): The phone number of the payer (e.g., "250788123456"). amount (number): The payment amount. currency (string): The currency (e.g., "RWF"). description (string): Description of the transaction.

Returns

Promise: A promise resolving to the API response.

Example Response

{  
    "status": "success",  
    "message": "Payment initiated successfully",  
    "transactionId": "123456789"  
}  

Support

For help with the Zibapay SDK, contact Zibapay Support or create an issue on the project's repository.

License

This project is licensed under the MIT License.