Flutter支付功能插件gmpay的使用

Flutter支付功能插件GMPay的使用

1. 简介

GMPay 是一个现代化的支付平台，旨在为企业和个人提供安全便捷的交易服务。GMPay Flutter 插件允许您无缝地将 GMPay 集成到您的 Flutter 应用程序中。

2. 安装

要开始使用 GMPay Flutter 插件，您需要在 Flutter 项目中安装它。您可以通过在 pubspec.yaml 文件中添加依赖项来完成此操作。

dependencies:
  gmpay: ^latest_version  # 请替换为最新版本号

安装完成后，运行以下命令以安装包：

flutter pub get

3. 配置

在使用 GMPay Flutter 插件之前，您需要使用 GMPay 账户详细信息和凭据进行配置。以下是设置配置的方法：

initialize 方法

initialize 方法用于使用您的 GMPay 账户凭据配置和初始化 GMPay Flutter 插件。此方法应在任何其他 GMPay 相关操作之前调用，以确保插件已正确配置。

参数：

• pubKey (String, 必填)：您的 GMPay 公钥，与您的 GMPay 账户关联。此密钥用于与 GMPay 服务器的安全通信。
• secret (String, 必填)：您的 GMPay 秘钥，也与您的 GMPay 账户关联。此密钥用于加密操作和身份验证。

示例：

Gmpay.instance.initialize(
  "GMPAY-PUB-XXXXXXXXXXXXX-YY",
  secret: "GMPAY-SEC-XXXXXXXXXXXXXXX-YY",
);

使用说明：

在发起任何支付交易或与 GMPay 服务交互之前，您应该使用您的 GMPay 公钥和秘钥调用 initialize 方法。这一步骤对于确保与 GMPay 服务器的安全和成功通信至关重要。

注意事项：

• 确保将示例中的 pubKey 和 secret 值替换为您的实际 GMPay 账户凭据。
• initialize 方法应在应用程序执行的早期阶段调用，最好是在初始化或设置期间。
• 保持您的 GMPay 秘钥安全，切勿将其暴露在客户端代码或公共仓库中，因为它是一个敏感凭据。
• 确保已在 pubspec.yaml 文件中添加了 GMPay Flutter 插件作为依赖项，并完成了必要的安装步骤，然后再使用 initialize 方法。

此方法应每应用程序会话调用一次，以根据您的 GMPay 账户配置 GMPay Flutter 插件。

4. API 参考

有关可用方法和选项的详细信息，请参阅 API 参考。

5. 示例

以下是一个完整的示例代码，展示了如何在 Flutter 应用程序中使用 GMPay Flutter 插件。

示例代码：

import 'package:flutter/material.dart';
import 'package:gmpay/flutter_gmpay.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await dotenv.load(fileName: ".env");
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    // 初始化 GMPay 插件
    Gmpay.instance.initialize(
      packageName: "com.test.app",  // 替换为您的应用包名
      testMode: false,  // 是否启用测试模式
    );
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: WeNeedTheNavigator(),
      themeMode: ThemeMode.dark,
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('GMPAY PLUGIN TEST'),
        centerTitle: true,
      ),
      body: ListView(children: [
        ElevatedButton(
          onPressed: () {
            // 显示支付表单
            Gmpay.instance.presentPaymentSheet(
              context,
              amount: 3000,  // 支付金额
              account: dotenv.env['PHONE']!,  // 用户账户（例如手机号）
              metadata: {
                "callback_url": "https://example.com/callback",  // 回调URL
              },
              waitForConfirmation: true,  // 是否等待确认
              approvalUrlHandler: (url) {
                debugPrint(url);  // 打印审批URL
              },
              callback: (result) {
                if (result == null) {
                  debugPrint("Transaction cancelled");  // 交易取消
                } else {
                  debugPrint(result.status?.name);  // 打印交易状态
                }
              },
            );
          },
          child: const Text("Show Payment Bottomsheet"),
        ),
        ElevatedButton(
          onPressed: () {
            // 显示提现表单
            Gmpay.instance.presentWithdrawSheet(
              context,
              amount: 1000,  // 提现金额
              account: dotenv.env['PHONE']!,  // 用户账户（例如手机号）
              waitForConfirmation: true,  // 是否等待确认
              callback: (result) {
                if (result == null) {
                  debugPrint("Transaction cancelled");  // 交易取消
                } else {
                  if (kDebugMode) {
                    print(result);  // 打印交易结果
                  }
                }
              },
            );
          },
          child: const Text("Show Withdraw Bottomsheet"),
        ),
        ElevatedButton(
          onPressed: () {
            // 查询交易状态
            Gmpay.instance.presentVerificationSheet(
              context,
              reference: "1X4BJYKO6E8D",  // 交易参考号
              callback: (result) {
                if (result == null) {
                  debugPrint("Transaction cancelled");  // 交易取消
                } else {
                  if (kDebugMode) {
                    print(result);  // 打印交易结果
                  }
                }
              },
            );
          },
          child: const Text("Check Transaction Status"),
        ),
      ]),
    );
  }
}