npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lipad-sdk

v1.0.5

Published

A secure and user-friendly data encryption and direct charge library for Node.js applications for Lipad platform transactions.

Downloads

9

Readme

Lipad

The Lipad class provides a simple way to encrypt payloads using the given IV key, secret key, and encryption algorithm.

Installation

This class relies on the built-in crypto module and axios so no additional installations are required.

Checkout Usage

  1. Import the Lipad class:

    ```javascript
    const Lipad = require('../Lipad/Lipad');
    ```

    Note: Specify either 'sandbox' or 'production' for the environment parameter when creating an instance of the Lipad class.

  2. Create an instance of Lipad by providing the required parameters:

    const IVKey = "your_IV_key";
    const consumerSecret = "your_secret_key";
    const consumerKey = "your_consumer_key";
    const environment = "sandbox";
    
    let payload = {};
    let lipad = new Lipad(IVKey, consumerSecret, consumerKey, environment);
  3. Validate the payload using the validatePayload method:

    lipad.validatePayload(payload);
  4. Encrypt a payload using the encrypt method:

    const payloadStr = JSON.stringify(payload);
    let encryptedPayload = lipad.encrypt(payloadStr);
    
    console.log("Encrypted Payload:", encryptedPayload);
  5. Retrieve checkout status using the getCheckoutStatus method:

    lipad
      .getCheckoutStatus(
        payload.merchant_transaction_id,
      )
      .then((checkoutData) => {
        console.log("Checkout Data:", checkoutData);
      })
      .catch((error) => {
        console.error("Error:", error);
      });

Direct API Usage

  1. Import the Lipad class:

    ```javascript
    const Lipad = require('../Lipad/Lipad');
    ```

    Note: Specify either 'sandbox' or 'production' for the environment parameter when creating an instance of the Lipad class.

  2. Create an instance of Lipad by providing the required parameters:

    const IVKey = "your_IV_key";
    const consumerSecret = "your_secret_key";
    const consumerKey = "your_consumer_key";
    const environment = "sandbox";
    
    let payload = {};
    let lipad = new Lipad(IVKey, consumerSecret, consumerKey, environment);
    
  3. Charge using DirectCharge method:

    lipad
      .DirectCharge(payload)
      .then((response) => {
        console.log("Direct Charge Response:", response);
      })
      .catch((error) => {
        console.error("Error during Direct Charge:", error);
      });
  4. Retrieve the status of a charge request using getChargeRequestStatus method

    lipad.getChargeRequestStatus(chargeRequestId)
    .then(status => {
        console.log('Charge Request Status:', status);
    })
    .catch(error => {
        console.error('Error retrieving Charge Request Status:', error);
    });

The getCheckoutStatus and DirectCharge methods include access token retrieval. Additionally, make sure to provide the consumerKey and consumerSecret when creating an instance of the Lipad class.

API

Lipad(IVKey, consumerSecret, consumerKey, environment)

Creates an instance of the Lipad class.

  • IVKey: The IV key used for encryption.
  • consumerSecret: The secret key used for encryption.
  • consumerKey: The consumer key used for authentication.
  • environment: Specify either 'sandbox' or 'production' for the desired environment.

encrypt(payload)

Encrypts a given payload.

  • payload: The payload to be encrypted.

Returns the encrypted payload in base64-encoded format.

validatePayload(payload)

Validates the required properties of a given payload object.

  • payload: The payload object to be validated.

Throws an error if any required property is missing.

getCheckoutStatus(payload.merchant_transaction_id)

Retrieves checkout status for a specific merchant transaction ID.

  • payload.merchant_transaction_id: The ID of the merchant transaction in the payload.

Returns a Promise that resolves with the checkout data.

DirectCharge(payload)

Initiates a direct charge using Lipad's API.

  • payload: The payment payload containing transaction details.

Returns a Promise that resolves with the response from the charge request.

getChargeRequestStatus(chargeRequestId)

Retrieves the status of a charge request.

  • chargeRequestId: The ID of the charge request.

Returns a Promise that resolves with the status of the charge request.

License.

This SDK is open-source and available under the MIT License.