safepay_checkout 1.0.2

A simple and easy-to-integrate Flutter package for Safepay Checkout.

Safepay Checkout

A Flutter package to seamlessly integrate the Safepay Payment Gateway for secure and efficient payment processing. This package simplifies the checkout integration by providing a pre-built widget that handles all payment operations for you.

Installation

Step 1: Add Dependency

To get started, add the following dependency to your pubspec.yaml file:

dependencies:
  safepay_checkout: ^1.0.2

Step 2: Import the Package

Import the package in the Dart file where you want to use it:

import 'package:safepay_checkout/safepay_payment_gateway.dart';

Step 3: Add the Checkout Widget

Add the SafepayCheckout widget to your screen. This widget handles the entire payment process.

SafepayCheckout(
  amount: 100,
  publicKey: 'Your public key',
  secretKey: 'Your secret key',
  currency: 'PKR',
  environment: Safe,
  orderId: '9023',
  successUrl: 'yourdomain.com',
  failUrl: 'yourfaildomain.com',
  onPaymentFailed: () {
    // Payment failed
    print('Payment cancelled');
  },
  onPaymentCompleted: () {
    // Payment successful
    print('Payment successful');
  },
  onAuthenticationError: () {
    // In case of wrong public or secret key
    print('Authentication error');
  },
);

This code will add the Safepay payment gateway to your screen, enabling payment processing.

Parameters

Parameter	Data Type	Description
amount	double	The amount to be processed in the payment transaction.
publicKey	String	Your Safepay public key.
secretKey	String	Your Safepay secret key.
currency	String	The currency code, e.g., PKR, USD.
environment	SafePayEnvironment	The environment setting for the payment (e.g., Safe, Test).
orderId	String	Unique identifier for the order.
onPaymentFailed	VoidCallback	Callback triggered in case of a payment failure.
onPaymentCompleted	VoidCallback	Callback triggered when the payment has been successfully completed.
onAuthenticationError	VoidCallback	Callback triggered in case of an authentication error, such as wrong keys.
successUrl	String	URL to redirect to on successful payment.
failUrl	String	URL to redirect to in case of payment failure.

Full Screen Example

If you'd like a complete screen to handle payments, take a look at the example below.

Checkout.dart

Create a new file named Checkout.dart and navigate to this screen in your app. This will handle the payment logic and trigger success, failure, or authentication error events.

import 'package:flutter/material.dart';
import 'package:safepay_checkout/safepay_payment_gateway.dart';

class CheckoutScreen extends StatefulWidget {
  final double amount;
  final String publicKey;
  final String secretKey;
  final String currency;
  final SafePayEnvironment environment;
  final String orderId;
  final String successUrl;
  final String failUrl;

  const CheckoutScreen({
    Key? key,
    required this.amount,
    required this.publicKey,
    required this.secretKey,
    required this.currency,
    required this.environment,
    required this.orderId,
    required this.successUrl,
    required this.failUrl,
  }) : super(key: key);

  @override
  State<CheckoutScreen> createState() => _CheckoutScreenState();
}

class _CheckoutScreenState extends State<CheckoutScreen> {
  @override
  Widget build(BuildContext context) {
    return SafepayCheckout(
      amount: widget.amount,
      publicKey: widget.publicKey,
      secretKey: widget.secretKey,
      currency: widget.currency,
      environment: widget.environment,
      orderId: widget.orderId,
      onPaymentFailed: () {
        // Payment failed
        print('Payment cancelled');
      },
      onPaymentCompleted: () {
        // Payment successful
        print('Payment successful');
      },
      onAuthenticationError: () {
        // In case of wrong public or secret key
        print('Authentication error');
      },
      successUrl: widget.successUrl,
      failUrl: widget.failUrl,
    );
  }
}

Additional Example

For a more detailed example, you can refer to the example folder in the repository for a complete integration.