flutter_paystack_payment 0.1.4 copy "flutter_paystack_payment: ^0.1.4" to clipboard
flutter_paystack_payment: ^0.1.4 copied to clipboard

A plugin for Payment through Paystack made By Oreofe Solarin.

Build and Test

A Paystack Plugin for Flutter Apps #

Flutter plugin for making payments with Paystack Payment System. Fully supports all platform.

Features #


  • Card
  • Bank

In Development

  • USSD
  • QR Code
  • Mobile Money

Installation #

To use this plugin, add flutter_paystack_payment as a dependency in your pubspec.yaml file.

Then initialize the plugin preferably in the initState of your widget.

import 'package:flutter_paystack_payment/flutter_paystack_payment.dart';

class _ExamplePayementPageState extends State<ExamplePayementPage> {
  var publicKey = 'Add your Paystack Public Key Here';
  final plugin = PaystackPayment();

  void initState() {
    plugin.initialize(publicKey: publicKey);

New Feature #

You can now scan the card instead of inputting the card details manually.

Setup - Android #

You need to add the permission to use the CAMERA <uses-permission android:name="android.permission.CAMERA" />

Setup - iOS #

You need to add the permission to use the CAMERA NSCameraUsageDescription NSCameraUsageDescriptionwith the reason the camera is being used. E.g.To Scan Details on Card While trying to process payment`

Making Payments #

There are two ways of making payment with the plugin.

  1. Checkout: This is the easy way; as the plugin handles all the processes involved in making a payment (except transaction initialization and verification which should be done from your backend).
  2. Charge Card: This is a longer approach; you handle all callbacks and UI states.

You initialize a charge object with an amount, email & accessCode or reference. Pass an accessCode only when you have initialized the transaction from your backend. Otherwise, pass a reference.

Charge charge = Charge()
      ..amount = 10000
      ..reference = _getReference()
       // or ..accessCode = _getAccessCodeFrmInitialization()
      ..email = 'customer@email.com';
    CheckoutResponse response = await plugin.checkout(
      context context,
      method: CheckoutMethod.card, // Defaults to CheckoutMethod.selectable
      charge: charge,

Please, note that an accessCode is required if the method is CheckoutMethod.bank or CheckoutMethod.selectable.

plugin.checkout() returns the state and details of the payment in an instance of CheckoutResponse .

It is recommended that when plugin.checkout() returns, the payment should be verified on your backend.

2. Charge Card #

You can choose to initialize the payment locally or via your backend.

1.a. This starts by making a HTTP POST request to paystack on your backend.

1.b If everything goes well, the initialization request returns a response with an access_code. You can then create a Charge object with the access code and card details. The charge is in turn passed to the plugin.chargeCard() function for payment:

  PaymentCard _getCardFromUI() {
    // Using just the must-required parameters.
    return PaymentCard(
      number: cardNumber,
      cvc: cvv,
      expiryMonth: expiryMonth,
      expiryYear: expiryYear,

  _chargeCard(String accessCode) async {
    var charge = Charge()
      ..accessCode = accessCode
      ..card = _getCardFromUI();

    final response = await plugin.chargeCard(context, charge: charge);
    // Use the response

The transaction is successful if response.status is true.

2. Initialize Locally

Just send the payment details to plugin.chargeCard

      // Set transaction params directly in app (note that these params
      // are only used if an access_code is not set. In debug mode,
      // setting them after setting an access code would throw an error
      Charge charge = Charge();
      charge.card = _getCardFromUI();
        ..amount = 2000
        ..email = 'user@email.com'
        ..reference = _getReference()
        ..putCustomField('Charged From', 'Flutter PLUGIN');

Validating Card Details #

You are expected but not required to build the UI for your users to enter their payment details. For easier validation, wrap the TextFormFields inside a Form widget. Please check this article on validating forms on Flutter if this is new to you.

NOTE: You don't have to pass a card object to Charge. The plugin will call-up a UI for the user to input their card.

You can validate the fields with these methods:


This method helps to perform a check if the card number is valid.


Method that checks if the card security code is valid.


Method checks if the expiry date (combination of year and month) is valid.


Method to check if the card is valid. Always do this check, before charging the card.


This method returns an estimate of the string representation of the card type(issuer).

Verifying Transactions #

This is quite easy. Just send a HTTP GET request to https://api.paystack.co/transaction/verify/$[TRANSACTION_REFERENCE]. Please, check the official documentaion on verifying transactions.

Testing your implementation #

Paystack provides tons of payment cards for testing.

Running Example project #

For help getting started with Flutter, view the online documentation.

An example project has been provided in this plugin. Clone this repo and navigate to the example folder. Open it with a supported IDE or execute flutter run from that folder in terminal.

Contributing, Issues and Bug Reports #

The project is open to public contribution. Please feel very free to contribute. Experienced an issue or want to report a bug? Please, report it here. Remember to be as descriptive as possible.

Credits #

Thanks to the author of the initial Paystack Plugin @wilburt, I really build it upon his work.