End2EndPay Android SDK

A secure and easy-to-use Android SDK for integrating End2EndPay payment processing into your Jetpack Compose applications.

Features

Click on me

🔒 Secure WebView Integration - Industry-standard security practices
🎨 Jetpack Compose Native - Built specifically for modern Android development
⚡ Easy Integration - Get started with just a few lines of code
🔄 Real-time Callbacks - Success, error, and cancellation handling
✅ Input Validation - Built-in validation for all payment parameters
📱 Responsive - Works seamlessly across different screen sizes

Requirements

Android SDK: 26 (Android 8.0) or higher

Target SDK: 36

Kotlin: 1.9+

Jetpack Compose: 1.5+

Installation

Step 1: `Add JitPack Repository`

Add JitPack to your project's settings.gradle.kts:

Step 2: Add Dependency

Add the SDK to your app's build.gradle.kts:

💡

🚀 Quick Start

Basic Implementation

💡

📖 Detailed Usage

Parameter Validation

The SDK automatically validates all inputs:

Parameter	Validation Rule	Example
`apiKey`	Cannot be blank	`"KEY-E2E-xxx"`
`accessToken`	Cannot be blank	`"E2E_AK_xxx"`
`amount`	Must be > 0 and ≤ 999,999,999.99	`99.99`
`currency`	Must be 3-letter ISO code	`"USD", "EUR", "NGN"`
`reference`	Cannot be blank, max 255 chars	`"ORDER-12345"`
`payerEmail`	Must be valid email format	`"user@example.com"`

If validation fails, the onError callback is triggered immediately with a descriptive message.

🔧 API Reference

End2EndPayWebView

Parameters

Callback Details

onSuccess

Triggered when payment is completed successfully

Receives JSON response as a string containing transaction details

Example response: {"transactionId": "abc123", "status": "completed"}

onError

Triggered when payment fails or validation errors occur

Receives error message describing what went wrong

Common errors: validation failures, network issues, payment error

onCancel

Triggered when user cancels the payment

Receives cancellation message

User can retry payment or navigate away

📌

🔒 Security Features

The SDK implements multiple security layers:

✅ JavaScript execution is sandboxed within the WebView
✅ File access is disabled (allowFileAccess = false)
✅ Content access is disabled (allowContentAccess = false)
✅ Database storage is disabled
✅ Geolocation is disabled
✅ All credentials are passed securely to the payment gateway
✅ HTTPS-only communication with End2EndPay servers

Best Practices

Never hardcode credentials - Store API keys securely using:

Android Keystore

Encrypted SharedPreferences

BuildConfig fields (for non-production)

Validate on your backend - Always verify payments server-side

Use ProGuard/R8 - Obfuscate your production builds

💡

🎨 Customization

Custom Styling with Modifier

Handling Different Screen States

📱 Sample App

This repository includes a fully functional sample app demonstrating best practices.

Running the Sample

Clone the repository:

cd end2endpay-android-sdk
2. Open the project in Android Studio
3. Update credentials in sample/src/.../PaymentScreen.kt:

Run the sample module

Sample Features

✅ Home screen with payment overview
✅ Payment flow with status tracking
✅ Navigation between screens
✅ Success/error/cancel handling
✅ Material 3 design implementation

🐛 Troubleshooting

Common Issues

WebView not loading

Solution: Ensure JavaScript is enabled and you have internet permission

Callbacks not firing

Solution: Check that JavaScript interface is properly initialized

Validation errors

Solution: Verify all parameters meet the validation requirements

Debug Logging

Enable WebView logging in debug builds:

Step 1: Add JitPack Repository#

Step 2: Add Dependency#

🚀 Quick Start#

Basic Implementation#

📖 Detailed Usage#

Complete Example with Navigation#

Parameter Validation#

🔧 API Reference#

End2EndPayWebView#

Callback Details#

🔒 Security Features#

Best Practices#

🎨 Customization#

📱 Sample App#

Sample Features#

🐛 Troubleshooting#

Common Issues#

Debug Logging#

Step 1: `Add JitPack Repository`

Step 2: Add Dependency

🚀 Quick Start

Basic Implementation

📖 Detailed Usage

Complete Example with Navigation

Parameter Validation

🔧 API Reference

End2EndPayWebView

Callback Details

🔒 Security Features

Best Practices

🎨 Customization

📱 Sample App

Sample Features

🐛 Troubleshooting

Common Issues

Debug Logging