@hypersokrat/hyper-pay

HyperPay System Documentation

Welcome to the HyperPay system documentation. This guide provides a detailed walkthrough for administrators and developers, explaining how to integrate cryptocurrency payments seamlessly into applications using HyperPay and MetaMask.

Admin Registration and Configuration

1. Admin Account Creation

To get started with HyperPay, administrators need to create an account:

• Visit the HyperPay admin page and sign up.
• Provide necessary details: username, email, and password.

2. MetaMask Address Registration

After logging in, administrators should register their MetaMask address:

• Navigate to the Company section in the admin panel.
• Register the MetaMask address that will receive cryptocurrency payments.
• This address will automatically generate a unique project ID for identification purposes.

3. Project ID Generation

Upon registering the MetaMask address:

• A unique project ID is generated automatically.
• This project ID will be used to associate payments with your company's account.

Integration into User Applications

Developers can integrate HyperPay's cryptocurrency payment functionality into applications:

1. Install Library

Install the HyperPay library using npm or yarn package managers:

npm install hyperpay-library

Once installed, import the payment module into your application:

import { HyperPay } from "hyperpay-library";

Connect MetaMask

Users initiate payments securely through MetaMask:

• Click the module button to connect to MetaMask.
• This connection authorizes transactions securely.

Invoke Payment Component

Developers integrate payment components:

// Example usage of HyperPay component
<HyperPay
  projectId="your_project_id_here"
  amount={100} // Amount to be paid in cryptocurrency
  modulStyles={modulStyles} //custom styles
/>