ivorypay_flutter 0.0.10+1

Ivorypay Flutter SDK to allow you receive crypto payments in Africa

ivorypay_flutter_example

Demonstrates how to use the ivorypay_flutter plugin.

Getting Started

To initiate a transaction, a email address must be specified in the body of the request. ///This email address will be used to create an entry in the Business Customer list of your business if it does not already exist.

So, typically, the email of the person making the payment is to be provided.

Every newly initiated transaction is only valid for 5 mins unless payment is received and a verification request is made to the IvoryPay API

Public Key

In order to use this library you are required to use your ivorypay public key and not the secret key. See how to get your API Keys here

Usage

Below are a few examples showcasing how you can use the library to implement payment in your Flutter app.

Getting Started

To install, add it to your pubspec.yaml file:

dependencies:
    ivorypay_flutter: <latest>

Required Parameters

The following parameters are required for SDK initialization:

• crypto: The cryptocurrency in which the amount is to be charged. Supported currencies are USDT, USDC, and SOL.

• baseFiat: The fiat currency of the amount to be charged. Supported fiats are NGN, GHS, ZAR, and KES.

• amount: The amount in the fiat currency which is to be charged in the specified cryptocurrency.

• email: The email of the person making the payment.

Make sure to provide values for these parameters when initializing the SDK to ensure proper functionality.

SDK Initialization

There are two options to initialize the SDK for iOS and Android Platforms:

1. Using the provided button:

   import 'package:ivorypay_flutter/ivorypay_flutter.dart';
   
   // Create an Ivorypay button widget
   final button = IvorypayButton(
     option: IvorypayButtonOption.two,
     onTap: () async {
       final ivoryService = IvorypayFlutter(
         context: context,
         data: InitiateIvorypayTransaction(
           baseFiat: "NGN",
           amount: int.tryParse(amountCtrl.text.trim()),
           crypto: crypto.text,
           email: email.text,
           authorization: authCtrl.text,
         ),
         onError: (value, e) {
           ScaffoldMessenger.of(context).showSnackBar(
             SnackBar(content: Text(e.toString())));
         },
         onSuccess: (res) {
           ScaffoldMessenger.of(context).showSnackBar(
             SnackBar(content: Text(res.toString())));
         },
         onLoading: (valueLoading) {
           setState(() {
             isLoading = valueLoading;
           });
         },
       );
   
       ivoryService.run();
     },
   );
   
   // Add the button to your UI
   // ...
   

   ![Ivorypay Button]

   Clicking the button will trigger the onTap callback, where you can create an instance of IvorypayFlutter and initialize the SDK with the specified parameters.

2. Calling the function directly:

   import 'package:ivorypay_flutter/ivorypay_flutter.dart';
   
   final ivoryService = IvorypayFlutter(
     context: context,
     data: InitiateIvorypayTransaction(
       baseFiat: "NGN",
       amount: 4000,
       crypto: "USDC",
       email: "[e-mail]",
       authorization: 'PUBLIC_API_KEY',
     ),
     onError: (value, e) {},
     onSuccess: (res) {},
     onLoading: (valueLoading) {
       setState(() {
         isLoading = valueLoading;
       });
     },
   );
   
   ivoryService.run()
   

   You can call the IvorypayFlutter constructor directly and initialize the SDK with the desired parameters without using the provided button.

Choose the option that suits your needs and integrate it into your code accordingly.

For web initialization use this function instead, the Ivorypay button widget as described above can be used to call this function

1. initialize the pulgin

///Add this initialization for flutter web
final ivorypayWebService = IvorypayFlutterWeb();

2. call the ivorypayWebService above.

This code snippet demonstrates the usage of the ivorypayWebService.run method for initiating an Ivorypay transaction in a Flutter application with the required parameters

You can also call verifyStatus to verify the payment was successfull