Flutter支付插件khipu_pay_plugin的使用

Flutter支付插件khipu_pay_plugin的使用

KhipuPay 是一个库，允许你在你的 Flutter 应用程序中集成 Khipu 支付。

示例

要使用以下任何示例，你需要导入该库。

import 'package:khipu_pay_plugin/khipu_pay_plugin.dart';

初始化

有两种实例化库的方式，我们推荐使用第一种方式，因为它会从环境变量中获取 apiKey。

这是最好的方法，因为它允许你安全地保存你的 API 密钥，并且不会在代码中暴露它。

KhipuPay.initialize();

第二种方式是直接将 apiKey 传递给 initialize 方法。

KhipuPay.initialize(
  apiKey: 'your_api_key',
);

重要提示： 处理付款并不需要初始化库，因为可以使用后端调用 Khipu API。因此，只有当你希望从前端调用 Khipu API 时才需要初始化库。

创建付款

为了创建一个付款，需要调用 createPayment 方法并传入一个 KhipuPaymentForm 对象作为参数。createPayment 方法将返回一个 KhipuPayment 对象。

KhipuPayment khipuPayment = await KhipuPay.instance.createPayment(
  KhipuPaymentForm(
    subject: 'Test Payment',
    amount: 1000,
    currency: 'CLP',
    transactionId: '123',
    payerName: 'John Doe',
  )
);

处理付款

为了处理一个付款，需要调用 processPayment 方法并传入通过 createPayment 方法获得的 paymentId 参数。processPayment 方法将返回一个 KhipuResult 对象。

KhipuResult? result = await KhipuPay.processPayment(paymentId: 'your_payment_id');

检查付款状态

为了检查付款的状态，需要调用 paymentStatus 方法并传入通过 createPayment 方法获得的 paymentId 参数。paymentStatus 方法将返回一个 KhipuPayment 对象。

KhipuPayment? payment = await KhipuPay.instance.paymentStatus(paymentId: 'your_payment_id');

平台特定注意事项

Android

在 gradle-wrapper.properties 文件中，将 distributionUrl 更改为最新版本的 Gradle。

我们建议使用以下版本：

https\://services.gradle.org/distributions/gradle-8.4-bin.zip

在 build.gradle 文件中，将 com.android.tools.build:gradle 的版本更改为与 Gradle 版本兼容的最新版本（例如 8.3.2）。

iOS

从 Podfile 中删除 use_frameworks!，以避免与 Khipu 库发生冲突。

target 'Runner' do
  # use_frameworks!

重要提示

• 此库不是官方库，它是为方便在 Flutter 应用程序中集成 Khipu 支付而创建的。
• Khipu 提供了用于开发环境和生产环境的 apiKey，你必须根据应用程序所处的环境更改这些字段，以便正确处理付款。

参考资料

• 如何在 Flutter 中存储 API 密钥

许可证

MIT 许可证

完整示例代码

import 'package:flutter/material.dart';

import 'package:khipu_pay_plugin/khipu_pay_plugin.dart';

import 'widget/ticket_card.dart';

void main() {
  KhipuPay.initialize(apiKey: 'your_api_key');
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> {
  KhipuPayment? khipuPayment;

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        backgroundColor: Colors.blueGrey,
        body: TicketCard(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              const Spacer(),
              const Text(
                'KhipuPay Plugin',
                style: TextStyle(
                  fontSize: 25,
                  fontWeight: FontWeight.bold,
                ),
              ),
              const Spacer(),
              ElevatedButton(
                onPressed: () async {
                  khipuPayment = await KhipuPay.instance.createPayment(KhipuPaymentForm(
                    subject: 'Test Payment',
                    amount: 1000,
                    currency: 'CLP',
                    transactionId: '123',
                    payerName: 'John Doe',
                  ));
                },
                child: const Text('Create Payment'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final _ = await KhipuPay.processPayment(paymentId: khipuPayment?.paymentId ?? '');
                },
                child: const Text('Launch Khipu'),
              ),
              ElevatedButton(
                onPressed: () async {
                  final _ = await KhipuPay.instance.paymentStatus(paymentId: khipuPayment?.paymentId ?? '');
                },
                child: const Text('Get Payment Status'),
              ),
              const Spacer(),
            ],
          ),
        ),
      ),
    );
  }
}