Flutter支付功能插件flutter_openmoney的使用

Flutter插件用于OpenMoney SDK。

• 开始使用
• 安装
• 使用
• API
• 示例应用

开始使用

该Flutter插件是围绕OpenMoney Android SDK的封装。

以下文档仅关注围绕原生Android SDK的封装。要了解有关这些SDK及其在项目中的集成方式的更多信息，请参阅以下文档：

Android: https://github.com/eshantmittal/open-payment-android-aar

要发起支付，paymentToken 和 accessKey 是必需的变量。 paymentToken - 在服务器端生成。了解更多 accessKey - 从openmoney仪表板获取

安装

该插件可在Pub上找到: https://pub.dev/packages/flutter_openmoney

在你的项目的pubspec.yaml文件中添加以下依赖项：

dependencies:
  flutter_openmoney: ^0.0.1

注意对于Android: 确保你的应用的最低API级别为19或更高。

使用

可以在以下位置找到集成示例代码: https://github.com/thoshpathi/flutter_openmoney/blob/main/example/lib/main.dart。

导入包

import 'package:flutter_openmoney/flutter_openmoney.dart';

创建FlutterOpenmoney实例

_flutterOpenmoney = FlutterOpenmoney();

添加事件监听器

该插件使用基于事件的通信，并在支付成功或失败时发出事件。

事件名称通过eventPaymentSuccess和eventPaymentError常量从FlutterOpenmoney类中暴露出来。

使用FlutterOpenmoney实例上的on(String event, Function handler)方法来附加事件监听器。

_flutterOpenmoney.on(FlutterOpenmoney.eventPaymentSuccess, _handlePaymentSuccess);
_flutterOpenmoney.on(FlutterOpenmoney.eventPaymentError, _handlePaymentError);

处理程序将在其他地方定义为：

void _handlePaymentSuccess(PaymentSuccessResponse response) {
  // 当支付成功时执行某些操作
}

void _handlePaymentError(PaymentFailureResponse response) {
  // 当支付失败时执行某些操作
}

要清除事件监听器，使用FlutterOpenmoney实例上的clear方法。

_flutterOpenmoney.clear(); // 移除所有监听器

设置选项

var options = PaymentOptions('<ACCESS_KEY_HERE>', '<PAYMENT_TOKEN_HERE>', PaymentMode.sandbox);

结账

_flutterOpenmoney.initPayment(options.toMap());

API

initPayment(Map<String, String> options)

options是PaymentOptions类的一个实例。 options必须包含paymentToken和accessKey作为必需属性。 使用options.toMap()方法将options转换为Map对象。

on(String eventName, Function listener)

注册支付事件的事件监听器。

• eventName: 事件的名称。
• listener: 要调用的函数。监听器应该接受一个单一参数，类型如下：
  • 对于eventPaymentSuccess，类型为PaymentSuccessResponse
  • 对于eventPaymentError，类型为PaymentFailureResponse

clear()

清除所有事件监听器。

错误码

错误码由FlutterOpenmoney类以整数形式暴露。

错误码作为PaymentFailureResponse实例传递给回调的code字段可用。

事件名称

事件名称也由Razorpay类以字符串形式暴露。

PaymentSuccessResponse

要确认支付详情，请参阅此链接 https://docs.bankopen.com/reference/status-check-api-with-token-id

PaymentFailureResponse

示例代码

import 'package:flutter/material.dart';
import 'package:flutter_openmoney/flutter_openmoney.dart';
import 'package:fluttertoast/fluttertoast.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late final FlutterOpenmoney flutterOpenmoney;

  [@override](/user/override)
  void initState() {
    super.initState();

    flutterOpenmoney = FlutterOpenmoney();
    flutterOpenmoney.on(
      FlutterOpenmoney.eventPaymentSuccess,
      _handlePaymentSuccess,
    );
    flutterOpenmoney.on(
      FlutterOpenmoney.eventPaymentError,
      _handlePaymentError,
    );
  }

  void _initPayment() async {
    /// 从openmoney仪表板获取
    const accessKey = 'xxxxxxxx-xxxx-xxxx-xxxx-cfd6fc92bd19';

    /// 使用openmoney创建令牌API在服务器端生成
    /// 参阅https://docs.bankopen.com/reference/generate-token
    const paymentToken = 'sb_pt_BUFJpEalhWmO6cm';
    final options = PaymentOptions(accessKey, paymentToken);

    try {
      flutterOpenmoney.initPayment(options);
    } catch (e) {
      debugPrint('Error: $e');
    }
  }

  void _handlePaymentSuccess(PaymentSuccessResponse response) {
    Fluttertoast.showToast(
      msg: 'SUCCESS: ${response.paymentId}',
      toastLength: Toast.LENGTH_LONG,
    );
  }

  void _handlePaymentError(PaymentFailureResponse response) {
    Fluttertoast.showToast(
      msg: 'ERROR: ${response.code} - ${response.message}',
      toastLength: Toast.LENGTH_LONG,
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('FlutterOpenmoney插件示例应用'),
        ),
        body: Center(
          child: Row(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: _initPayment,
                child: const Text('initPayment'),
              )
            ],
          ),
        ),
      ),
    );
  }
}