Flutter Package

Package Link

https://pub.dev/packages/paylink_payment

Usage

To integrate Paylink's payment gateway into your Flutter application using the paylink_payment package, follow these steps:

1. Install the Package:

   Add paylink_payment to your pubspec.yaml file under dependencies:

   YAML

   dependencies:
     paylink_payment: ^2.0.0 # Use the latest version
   

2. Import the Package:

   Import the paylink_payment package in your Dart file:

   Dart

   import 'package:paylink_payment/paylink_payment.dart';
   

3. Initialize Paylink instance

• For Testing

  Dart

  paylink = PaylinkPayment.test(
    context: context,
    webViewTitle: 'Payment Screen', // optional
    textColor: Colors.white, // optional
    themeColor: Colors.blue, // optional
  )
  

• For Production

  Dart

  paylink = PaylinkPayment.production(
    context: context,
    apiId: '**************',
    secretKey: '**************',
    webViewTitle: 'Payment Screen', // optional
    textColor: Colors.white, // optional
    themeColor: Colors.blue, // optional
  )
  

Package Functionalities

1. Open Payment Form:

Use the PaylinkPayment class to open the payment form when a button or action is triggered. Here's an example of how to do this:

// paylink instance initialized in previous step
paylink.openPaymentForm(
  transactionNo: '1713690519134',
  onPaymentComplete: (PaylinkInvoice orderDetails) {
    /// Handle payment completion
  },
  onError: (Object error) {
    /// Handle payment error
  },
);

• Implement the onPaymentComplete and onError callbacks to handle the payment completion and any errors that occur during the payment process. Customize these callbacks based on your app's requirements.

2. Add Invoice:

paylink.addInvoice(
  amount: 220.0,
  clientMobile: '0512345678',
  clientName: 'Mohammed',
  orderNumber: '123456789',
  callBackUrl: 'https://example.com',
  products: [
    PaylinkProduct(title: 'Book', price: 100, qty: 2),
    PaylinkProduct(title: 'Pen', price: 2, qty: 10),
  ],
  cancelUrl: 'https://example.com',
  clientEmail: '[email protected]',
  currency: 'SAR',
  displayPending: true,
  note: 'Test invoice',
  smsMessage: 'URL: [SHORT_URL], Amount: [AMOUNT]',
  supportedCardBrands: ['mada', 'visaMastercard', 'amex', 'tabby', 'tamara', 'stcpay', 'urpay'],
)
.then((PaylinkInvoice orderDetails) {
  /// Handle success response
})
.onError((error, stackTrace) {
  /// Handle error response
});

3. Retrieve Invoice Details:

paylink.getInvoice('1713690519134')
.then((PaylinkInvoice orderDetails) {
  /// Handle success response
})
.onError((error, stackTrace) {
  /// Handle error response
});

4. Cancel Invoice:

paylink.cancelInvoice('1713690519134')
.then((bool result) {
  /// Handle success response
})
.onError((error, stackTrace) {
  /// Handle error response
});

By following these steps, you can easily integrate Paylink's payment gateway into your Flutter application using the paylink_payment package.