# PortalPay [![npm version](https://badge.fury.io/js/portalpay.svg)](https://www.npmjs.com/package/portalpay) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![CDN](https://img.shields.io/badge/CDN-jsDelivr-blue.svg)](https://cdn.jsdelivr.net/npm/portalpay@latest/dist/portalpay.js) > Complete browser-based payment SDK for PortalPay. Zero-dependency IIFE bundle that works with any website or CMS. ## Overview `portalpay` is the standalone browser bundle of the PortalPay SDK. It provides a complete payment solution that: - 💳 **Supports Multiple Payment Methods** - Cards, Mobile Money - 🔒 **Built-in Security** - Tamper detection and fraud prevention - 🎨 **Customizable** - Style buttons to match your brand - 🌐 **Universal** - Works with any website, CMS, or framework - 📱 **Mobile-First** - Optimized for mobile payments - 🧪 **Mock Mode** - Test without real transactions ## Quick Start ### CDN (Recommended) Add to your HTML ``: ```html ``` ### npm ```bash npm install portalpay # or yarn add portalpay # or pnpm add portalpay ``` ## Basic Usage ### 1. Add the Script ```html ``` ### 2. Configure the SDK ```html ``` ### 3. Add Payment Button ```html 7500 ``` ## Configuration Options ### Global Configuration (window.EMBEDPAY) | Option | Type | Required | Description | |--------|------|----------|-------------| | `publishableKey` | string | ✅ | Your publishable key from payment provider | | `currency` | string | ❌ | Currency code (GHS, NGN, USD, KES, ZAR) | | `method` | string | ❌ | Payment method: 'card' or 'mobile-money' | | `narration` | string | ❌ | Default payment description | | `callback` | string | ❌ | Success redirect URL | | `cancel` | string | ❌ | Cancel redirect URL | | `forceMock` | boolean | ❌ | Enable test mode (default: false) | | `checkoutUrl` | string | ❌ | Custom checkout page URL (for mock mode) | ### Button Attributes | Attribute | Description | Example | |-----------|-------------|---------| | `data-checkout` | Marks button as checkout trigger | `