Ompay Payment Gateway

Ompay Payment Gateway is an npm package that provides an easy-to-use interface for interacting with the Ompay payment gateway API. This library allows you to create orders, check order statuses, and manage transactions securely and efficiently.

Features

• Order Management: Create and manage orders through Ompay.
• Transaction Management: Handle transactions with ease.
• Secure Authentication: Uses secure basic authentication for API requests.
• System Information: Attaches system and server information to each request for better tracking and security.

Installation

You can install the package via npm. Run the following command:

npm install ompay-paymentgateway

Usage

Importing the Package

To start using the Ompay Gateway, import the OmpayPaymentGateway class:

const OmpayPaymentGateway = require('ompay-paymentgateway');

Initializing the Gateway

Initialize the OmpayPaymentGateway class with your client ID and client secret:

const gateway = new OmpayPaymentGateway('your-client-id', 'your-client-secret');

Creating an Order

To create an order, use the createOrder method of the OrderAPI class:

const orderData = {
    receiptId: '000001',
    amount: 1,
    currency: 'INR',
    description: 'Test Payment',
    customerFields: {
        name: 'Example User',
        email: '[email protected]',
        phone: '1234567890'
    },
    uiMode: 'checkout',
    redirectType: 'post' // or 'redirect'
};
gateway.order.createOrder(orderData)
    .then(response => console.log('Order Response:', response))
    .catch(error => console.error('Error:', error));

Checking Order Status

To check the status of an existing order, use the checkStatus method:

const orderId = 'order-id';

gateway.order.checkStatus(orderId)
    .then(response => console.log('Order Status:', response))
    .catch(error => console.error('Error:', error));