1.2.0 • Published 11 months ago

payaza-checkout v1.2.0

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

Payaza Web SDK Integration Library

Payaza Checkout

A simple Node.js library for integrating Payaza Checkout into your web application.

Installation

Install the library using npm:

npm install payaza-checkout

yarn add payaza-web-sdk

const { setupPayazaCheckout } = require('payaza-checkout');

``function handlePayment() {
    setupPayazaCheckout({
        merchant_key: "PZ78-PKLIVE-5F2395E0-1ED3-422B-A3WD-0FE05467879BC", // Your Payaza merchant key
        connection_mode: "Live", // "Live" or "Test"
        checkout_amount: 10, // Amount to charge (in the lowest currency unit, e.g., kobo for NGN)
        currency_code: "NGN", // Currency code
        email_address: "johndoe@gmail.com", // Customer's email address
        first_name: 'Big', // Optional: Customer's first name
        last_name: 'Maitre', // Optional: Customer's last name
        phone_number: "01232425262", // Optional: Customer's phone number
        transaction_reference: "PL12345678", // Unique transaction reference
        callback: function (response) {
            console.log('Payment successful:', response);
        },
        onClose: function () {
            console.log('Payment window closed');
        }
    });
}
``
// Call this function when the user clicks the payment button
handlePayment();

setupPayazaCheckout({
    // ... other options
    callback: function (response) {
        console.log('Payment response:', response);
        // Handle the payment response
    },
});

setupPayazaCheckout({
    // ... other options
    onClose: function () {
        console.log("Checkout was closed");
        // Perform any actions needed after the checkout is closed
    },
});

merchant_key (string, required): Your Payaza merchant key.
connection_mode (string, required): Either "Live" or "Test".
checkout_amount (number, required): The amount to be charged (in the lowest currency unit, e.g., kobo for NGN).
currency_code (string, required): The currency code, e.g., "NGN".
email_address (string, required): The customer's email address.
first_name (string, optional): The customer's first name.
last_name (string, optional): The customer's last name.
phone_number (string, optional): The customer's phone number.
transaction_reference (string, required): A unique reference for the transaction.
callback (function, optional): A function to handle the payment response.
onClose (function, optional): A function to handle when the checkout popup is closed.


setupPayazaCheckout(options)
This method initializes the Payaza Checkout with the given options.

payazaCheckout.showPopup()
Displays the payment popup.

payazaCheckout.setCallback(callback)
Sets the callback function to handle the response after the payment.

payazaCheckout.setOnClose(onClose)
Sets the function to be called when the checkout popup is closed.

#Contributing
We welcome contributions to improve this library. Please fork the repository and submit a pull request with your changes.
Development Setup
Clone the repository:
bash

git clone https://github.com/yourusername/payaza-web-sdk.git
Install dependencies:
bash

npm install
Run the development server:
bash

npm start

##License
This project is licensed under the MIT License. See the LICENSE file for details.
1.2.0

11 months ago

1.1.0

11 months ago

1.0.0

11 months ago