Flutter

Digitalpaye Flutter SDK

SDK Description

The Digitalpaye Flutter SDK allows developers to easily integrate payments via Digitalpaye into their Flutter applications. It provides a simple interface to configure and initiate payment transactions.

Installation

To install the SDK, use the following command:

flutter pub add digitalpaye_sdk_flutter

Alternatively, you can download the SDK directly from Pub.dev: Download here

Getting started

Configuration

Before using the SDK, configure it with your API information. You must provide an API key, an API secret, and other configuration parameters.

final config = DigitalpayeConfig(
  apiKey: 'live_digitalpaye931',
  apiSecret: 'f511e4f4-d932-928cd-a804-51539700d60c',
  isSandbox: false,
  color: AppColors.orange,
);

// DigitalpayeConfig constructor
DigitalpayeConfig({required String apiKey, required String apiSecret, required bool isSandbox, Color ? color, String ?logo});

• apiKey : Your API key

• apiSecret : Your API secret

• isSandbox : Boolean indicating whether the environment is in sandbox mode

• color : Primary color of the application

• logo : The application's logo

Payment configuration

Set the parameters for your payment transaction.

final payment = DigitalpayePaymentConfig(
  codeCountry: DigitalpayeEnumCountries.ivoryCoast,
  amount: 10000.0,
  transactionId: paymentId,
  designation: "Sale of television",
  currency: DigitalpayeEnumCurrencies.xof,
  emailUser: "[email protected]",
  nameUser: "HELIE GUEI",
  customerId: "0777101308",
  urlError: "https://digitalpaye.com",
  urlSuccess: "https://digitalpaye.com",
);

• codeCountry : Country code

• amount : Transaction amount

• transactionId : Transaction ID

• designation : Transaction description

• currency : Transaction currency

• emailUser : User's email

• nameUser : User's name

• customerId : Customer ID

• urlError : URL in case of error

• urlSuccess : URL in case of success

Payment callback

DigitalpayeFlutterSDK(
  config: config,
  payment: payment,
  errorBuilder: (error) {
    return Container();
  },
  successBuilder: (success) {
    return Container();
  },
  pendingBuilder: (pending) {
    return Container();
  },

• config : DigitalpayeConfig

• payment: DigitalpayePaymentConfig

• errorBuilder : is a function that returns a Widget to display in case of an error.

• successBuilder : is a function that returns a Widget to display in case of a successful transaction.

• pendingBuilder : is a function that returns a Widget to display in case of a pending transaction.

Usage example

Here is a complete example of using the SDK in a Flutter application.

import 'dart:math';
import 'package:digitalpaye_sdk_flutter/digitalpaye_sdk_flutter.dart';
import 'package:digitalpaye_sdk_flutter/enum/digitalpaye_enum_countries.dart';
import 'package:digitalpaye_sdk_flutter/enum/digitalpaye_enum_currencies.dart';
import 'package:digitalpaye_sdk_flutter/models/digitalpaye_config.dart';
import 'package:digitalpaye_sdk_flutter/models/digitalpaye_payment_config.dart';
import 'package:digitalpaye_sdk_flutter/utils/app_color.dart';
import 'package:flutter/material.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

String generatePaymentId({int length = 20}) {
  const characters =
      'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
  final random = Random();
  return String.fromCharCodes(Iterable.generate(
    length,
    (_) => characters.codeUnitAt(random.nextInt(characters.length)),
  ));
}

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

  @override
  Widget build(BuildContext context) {
    final config = DigitalpayeConfig(
      apiKey: 'live_digitalpaye961',
      apiSecret: 'f511e4f4-d932-8299-a804-51539700d60c',
      isSandbox: false,
      color: AppColors.orange,
    );
    return Scaffold(
      appBar: AppBar(title: const Text('Digitalpaye Flutter SDK Example')),
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            final paymentId = generatePaymentId();
            final payment = DigitalpayePaymentConfig(
              codeCountry: DigitalpayeEnumCountries.ivoryCoast,
              amount: 10000.0,
              transactionId: paymentId,
              designation: "Sale of television",
              currency: DigitalpayeEnumCurrencies.xof,
              emailUser: "[email protected]",
              nameUser: "HELIE GUEI",
              customerId: "0777101308",
              urlError: "https://digitalpaye.com",
              urlSuccess: "https://digitalpaye.com",
            );
            Navigator.push(
              context,
              MaterialPageRoute(
                builder: (context) => DigitalpayeFlutterSDK(
                  config: config,
                  payment: payment,
                  errorBuilder: (error) {
                    return Column(
                      children: [
                        const Text("Payment failed"),
                        Row(
                          children: [
                            const Text("Reference"),
                            Text("${error.transactionId}")
                          ],
                        ),
                        Row(
                          children: [
                            const Text("Amount"),
                            Text("${error.amount}")
                          ],
                        ),
                      ],
                    );
                  },
                  successBuilder: (success) {
                    return Column(
                      children: [
                        const Text("Payment completed successfully"),
                        Row(
                          children: [
                            const Text("Reference"),
                            Text("${success.transactionId}")
                          ],
                        ),
                      ],
                    );
                  },
                  pendingBuilder: (pending) {
                    return Column(
                      children: [
                        const Text("Payment pending"),
                        Row(
                          children: [
                            const Text("Reference"),
                            Text("${pending.transactionId}")
                          ],
                        ),
                        Row(
                          children: [
                            const Text("Amount"),
                            Text("${pending.amount}")
                          ],
                        ),
                      ],
                    );
                  },
                ),
              ),
            );
          },
          child: const Text('Make Payment'),
        ),
      ),
    );
  }
}