@hipaymn/miniapp-sdk

Hipay MiniApp SDK – A global JavaScript bridge for building MiniApps in the Hipay SuperApp ecosystem. Provides a clean, Promise-based API for MiniApps to communicate with the native container, such as payments, navigation, and device features.

Installation

npm install @hipaymn/miniapp-sdk

or

yarn add @hipaymn/miniapp-sdk

Usage

Named Imports

import { pay, navigate, back } from "@hipaymn/miniapp-sdk";

await pay("checkout_123");
navigate("Home", { from: "checkout" });
back();

Default Import

import wallet from "@hipaymn/miniapp-sdk";

await wallet.pay("checkout_123");
wallet.navigate("Home");
wallet.back();

API Reference

pay(checkoutId: string)

Initiates a payment in the Hipay container.

await wallet.pay("checkout_123");

navigate(screen: string, params?: object)

Navigate to a specific screen in the Hipay container.

await wallet.navigate("Home", { from: "checkout" });

back()

Navigates back to the previous screen in the container.

await wallet.back();

MiniApp Requirements

• Must run inside the Hipay SuperApp WebView container.
• HPSNative bridge is injected automatically before MiniApp scripts run.
• Using this SDK outside the container will throw errors.

Contributing

1. Fork the repository
2. Run npm install
3. Make your changes in src/
4. Run npm run build
5. Submit a pull request

License

MIT © Hipay LLC