V2 Docs - Introduction

What is the ConnexPay payments SDK?

The ConnexPay payments SDK is a JavaScript library that enables you to securely collect payment information from your customers through an iframe-based payment form. The SDK reduces PCI exposure by ensuring sensitive payment data never touches your servers.

Key Features

Secure Payment Collection

• PCI Scope Minimized: Payment data is collected in a secure iframe that never touches your server
• Iframe-based Security: Sensitive payment information is isolated from your application code

Multiple Payment Methods

• Credit Cards: Accept all major credit and debit cards
• Digital Wallets: Google Pay and Apple Pay support*
• Flexible Configuration: Choose which payment methods to display per transaction

*Apple Pay and Google Pay availability depends on merchant registration and domain configuration.

Customizable Experience

• Brand Matching: Customize colors, fonts, and layout to match your brand
• Responsive Design: Forms adapt to different screen sizes automatically
• Theme Support: Built-in light and dark themes with custom CSS override support

Developer-Friendly

• Event-Driven Architecture: React to SDK states with clear event callbacks
• Promise-Based API: Modern async/await patterns for all operations
• Structured Error Handling: Detailed error information with field-level validation

How It Works

The ConnexPay SDK follows a simple integration pattern:

1. Initialize the SDK with your client credentials
2. Create a checkout session on your backend with payment details
3. Render the payment form using the session ID
4. Handle user interactions through events and callbacks
5. Process the payment when the user submits the form

[Your App] → [Backend API] → [Checkout Session] → [SDK Payment Form] → [Payment Processing]

What You Need to Get Started

Frontend Requirements

• Modern web browser with JavaScript enabled
• HTTPS domain (required for production, recommended for development)
• Basic knowledge of HTML, CSS, and JavaScript

Backend Requirements

• ConnexPay merchant account and API credentials
• Server endpoint capable of creating checkout sessions

Client Credentials

• Client ID: Your unique merchant identifier used to initialize the SDK
• API Credentials: Used for server-side checkout session creation on ConnexPay's Sales API
• Device GUID: Authorized transaction device identifier

Next Steps

Ready to start integrating? Continue to the Quick Start Guide for a working implementation in under 5 minutes.