Flutter PayPal Payment Plus #

A powerful and easy-to-use PayPal payment integration package for Flutter. Seamlessly integrate PayPal Checkout into your mobile applications with support for both sandbox testing and live production environments.

✨ Features #

📦 Installation #

Add the dependency to your pubspec.yaml:

dependencies:
  flutter_paypal_payment_plus: ^1.1.0

Then run:

flutter pub get

🚀 Quick Start #

1. Import the package #

import 'package:flutter_paypal_payment_plus/flutter_paypal_payment_plus.dart';

2. Navigate to PaypalCheckoutView #

Navigator.of(context).push(
  MaterialPageRoute(
    builder: (context) => PaypalCheckoutView(
      sandboxMode: true, // Set to false for production
      clientId: 'YOUR_CLIENT_ID',
      secretKey: 'YOUR_SECRET_KEY',
      returnURL: 'https://yourapp.com/success',
      cancelURL: 'https://yourapp.com/cancel',
      transactions: const TransactionOption(
        payPalAmount: PayPalAmount(
          total: '100.00',
          currency: 'USD',
          details: PaymentDetails(
            subtotal: '100.00',
            shipping: '0',
            shippingDiscount: 0,
          ),
        ),
        description: 'Purchase from MyApp',
        itemList: ItemList(
          items: [
            Item(name: 'Product 1', quantity: 2, price: '50.00', currency: 'USD'),
          ],
        ),
      ),
      onSuccess: (PaymentSuccessModel model) {
        log('Payment successful: ${model.toJson()}');
        Navigator.pop(context);
      },
      onError: (error) {
        log('Payment error: $error');
        Navigator.pop(context);
      },
      onCancel: () {
        log('Payment cancelled');
        Navigator.pop(context);
      },
    ),
  ),
);

📖 Complete Example #

import 'dart:developer';
import 'package:flutter/material.dart';
import 'package:flutter_paypal_payment_plus/flutter_paypal_payment_plus.dart';

void main() {
  runApp(const PaypalPaymentDemo());
}

class PaypalPaymentDemo extends StatelessWidget {
  const PaypalPaymentDemo({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'PayPal Payment Demo',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.blue),
        useMaterial3: true,
      ),
      home: const HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('My Shop'),
        centerTitle: true,
      ),
      body: Center(
        child: ElevatedButton.icon(
          icon: const Icon(Icons.payment),
          label: const Text('Pay with PayPal'),
          onPressed: () => _startPayment(context),
        ),
      ),
    );
  }

  void _startPayment(BuildContext context) {
    Navigator.of(context).push(
      MaterialPageRoute(
        builder: (context) => PaypalCheckoutView(
          sandboxMode: true,
          clientId: 'YOUR_CLIENT_ID',
          secretKey: 'YOUR_SECRET_KEY',
          returnURL: 'https://yourapp.com/success',
          cancelURL: 'https://yourapp.com/cancel',
          transactions: const TransactionOption(
            payPalAmount: PayPalAmount(
              total: '100',
              currency: 'USD',
              details: PaymentDetails(
                subtotal: '100',
                shipping: '0',
                shippingDiscount: 0,
              ),
            ),
            description: 'Order from My Shop',
            itemList: ItemList(
              items: [
                Item(name: 'Apple', quantity: 1, price: '50', currency: 'USD'),
                Item(name: 'Pineapple', quantity: 5, price: '10', currency: 'USD'),
              ],
            ),
          ),
          note: 'Contact us for any questions on your order.',
          onSuccess: (PaymentSuccessModel model) {
            log('Success: ${model.toJson()}');
            Navigator.pop(context);
            ScaffoldMessenger.of(context).showSnackBar(
              const SnackBar(content: Text('Payment successful!')),
            );
          },
          onError: (error) {
            log('Error: $error');
            Navigator.pop(context);
            ScaffoldMessenger.of(context).showSnackBar(
              SnackBar(content: Text('Payment failed: $error')),
            );
          },
          onCancel: () {
            log('Cancelled');
            Navigator.pop(context);
          },
        ),
      ),
    );
  }
}

⚙️ Configuration #

PaypalCheckoutView Parameters #

TransactionOption Structure #

TransactionOption(
  payPalAmount: PayPalAmount(
    total: '150.00',        // Must equal subtotal + shipping - discount
    currency: 'USD',
    details: PaymentDetails(
      subtotal: '140.00',   // Sum of item prices × quantities
      shipping: '10.00',
      shippingDiscount: 0,
    ),
  ),
  description: 'Order description',
  itemList: ItemList(
    items: [
      Item(name: 'Item 1', quantity: 2, price: '50.00', currency: 'USD'),
      Item(name: 'Item 2', quantity: 1, price: '40.00', currency: 'USD'),
    ],
    shippingAddress: ShippingAddress(  // Optional
      recipientName: 'John Doe',
      line1: '123 Main St',
      city: 'San Jose',
      state: 'CA',
      postalCode: '95131',
      countryCode: 'US',
    ),
  ),
  paymentOptions: PaymentOptions(  // Optional
    allowedPaymentMethod: PaymentMethodEnum.instantFundingSource,
  ),
)

🔑 Getting PayPal Credentials #

1. Go to PayPal Developer Dashboard
2. Log in or create a PayPal account
3. Navigate to Apps & Credentials
4. Click Create App (or use the default sandbox app)
5. Copy your Client ID and Secret Key

⚠️ Important: Never hardcode production credentials in your app. Use environment variables or secure storage.

🧪 Testing #

Use sandbox mode for testing:

PaypalCheckoutView(
  sandboxMode: true,  // Enable sandbox mode
  clientId: 'SANDBOX_CLIENT_ID',
  secretKey: 'SANDBOX_SECRET_KEY',
  // ...
)

Sandbox Test Accounts #

Create test accounts in the PayPal Developer Dashboard to simulate buyer and seller transactions.

📋 Requirements #

🐛 Troubleshooting #

Common Issues #

📄 License #

This project is licensed under the MIT License.

🤝 Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📮 Support #

• 🐛 Bug Reports: Open an issue
• 💡 Feature Requests: Open an issue
• ⭐ Like this package? Give it a star on GitHub!

Made with ❤️ by Yaseen Hussein