Flutter Payvessel #

A Flutter SDK for integrating Payvessel Payment Gateway into your mobile app. Works similar to the npm package.

Features #

payvessel-checkout

• 💳 Multiple Channels - Bank Transfer and Card payments
• 📱 Full-screen & Bottom Sheet - Choose how to display checkout
• 🔄 Callbacks - onSuccess, onError, onClose support
• 🌐 WebView-based - Uses your existing web checkout

Installation #

Add to your pubspec.yaml:

dependencies:
  flutter_payvessel: ^1.0.0

Platform Setup #

Android #

Add internet permission in android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"/>

iOS #

No additional setup required.

Usage #

Initialize and Launch Checkout #

Similar to the npm package:

import 'package:flutter_payvessel/flutter_payvessel.dart';

// Create Payvessel instance with your API key
final payvessel = Payvessel(
  config: PayvesselConfig(
    apiKey: 'YOUR_API_KEY',
  ),
);

// Launch checkout
Future<void> openCheckout() async {
  final result = await payvessel.initializeCheckout(
    context: context,
    params: CheckoutParams(
      customerEmail: 'customer@example.com',
      customerPhoneNumber: '08012345678',
      amount: '1000',
      currency: 'NGN',
      customerName: 'John Doe',
      channels: [
        PaymentChannels.bankTransfer,
        PaymentChannels.card,
      ],
      metadata: {
        'order_id': '12345',
      },
    ),
    onError: (error) => print('Error: $error'),
  );

  if (result.isSuccessful) {
    print('Payment successful!');
    print('Reference: ${result.reference}');
  } else if (result.isCancelled) {
    print('Payment cancelled');
  } else {
    print('Payment failed: ${result.message}');
  }
}

Trigger from a Button #

ElevatedButton(
  onPressed: openCheckout,
  child: Text('Pay with Payvessel'),
)

Bottom Sheet Mode #

final result = await payvessel.initializeCheckout(
  context: context,
  params: params,
  fullScreen: false, // Shows as bottom sheet
);

Parameters #

PayvesselConfig #

CheckoutParams #

PayvesselResult #

Payment Channels #

PaymentChannels.bankTransfer  // "BANK_TRANSFER"
PaymentChannels.card          // "CARD"
PaymentChannels.all           // Both channels

Comparison with npm Package #

Example #

See the example directory for a complete sample app.

License #

MIT License