Flutter支付网关插件biapay_gateway的使用

Flutter支付网关插件biapay_gateway的使用

BIAPAY支付网关SDK是围绕BIAPAY支付网关API构建的一个高级封装，提供了强类型的响应和异常处理。

特性

• BIAPAY支付网关SDK适用于Flutter。
• 易于使用。
• 支持Android和iOS平台。
• 无需额外配置。
• 安全且可靠。
• 实时提现。
• 端到端加密。
• 透明定价。

开始使用

安装

从pub.dev安装最新版本。

在你的包的pubspec.yaml文件中添加以下内容：

dependencies:
  biapay_gateway: [version]

或者在终端运行以下命令：

$ flutter pub add biapay_gateway

编写代码

导入包

在Dart文件中导入包。如果你使用的是Android Studio或VS Code，可以通过按下Alt+Enter并选择导入包选项来轻松完成此操作。否则，可以手动导入包，在Dart文件中添加以下行：

// 导入包
import 'package:biapay_gateway/biapay_gateway.dart';

示例

创建一个新的BiaPayGateway类实例，并传递所需参数。clientId、clientSecret、email、mobileNumber、orderId、amount、currencyCode、transactionId 和 transactionType 是必需的参数。

// 导入包
import 'package:biapay_gateway/biapay_gateway.dart';

// 创建一个BiaPayGateway类的新实例
final biapay = BiaPayGateway(
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  email: 'email',
  mobileNumber: 'mobileNumber',
  orderId: 'orderId',
  amount: 'amount',
  currencyCode: 'currencyCode',
  transactionId: 'transactionId',
  transactionType: 'transactionType',
);

• 在创建了新的BiaPayGateway类实例后，调用launch方法开始支付流程。launch方法将返回一个Future对象。你可以使用onSuccess和onFailed回调函数来处理成功和错误响应。

• 在onSuccess和onFailed回调函数内部，可以通过回调函数参数访问数据。你可以为onSuccess和onFailed回调函数参数使用任何名称。

// 调用launch方法开始支付流程
biapay.launch(
  onSuccess: (response) {
    // 处理成功响应
  },
  onFailed: (error) {
    // 处理失败响应
  },
);

• 访问onSuccess和onFailed回调响应数据。onSuccess和onFailed都以包含status和message键的Map对象形式返回数据列表。就像JSON响应一样，你可以通过键名访问数据。键名代表数据的名称。

• 例如，status是一个status数据的键名。你可以通过status键名访问status数据。

// 调用launch方法开始支付流程
await biapay.launch(
  onSuccess: (response) {
    // 处理成功响应
    final orderId = response['orderId'];
    final status = response['status'];
    final currency = response['currency'];
    final amount = response['amount'];
    final biapayTransactionId = response['biapayTransactionId'];
    final transactionId = response['transactionId'];
    final biapaySignature = response['biapaySignature'];
    final message = response['message'];
    
    // 使用响应数据做些什么
  },
  onFailed: (error) {
    // 处理失败响应
    final status = error['status'];
    final message = error['message'];
    
    // 使用错误数据做些什么
  },
);

onSuccess是一个当支付流程成功完成时被调用的回调函数。

onFailed是一个当支付流程失败时被调用的回调函数。

onSuccess和onFailed都以包含status和message键的JSON响应形式返回。

验证签名

• 你可以使用verifySignature方法检查支付签名。verifySignature方法将返回一个Future对象。

• verifySignature方法需要orderId、biapayTransactionId、transactionId、clientSecret和biapaySignature参数。

• verifySignature方法将以包含签名验证过程的message的数据列表形式返回。

• verifySignature方法将以包含orderId、biapayTransactionId、transactionId、biapaySignature、generatedSignature和message键的Map对象形式返回数据。就像JSON响应一样，你可以通过键名访问数据。键名代表数据的名称。

// 调用verifySignature方法验证支付签名
final value = await biapay.verifySignature(
  orderIdVerify,
  biapayTransactionIdVerify,
  transactionIdVerify,
  clientSecret,
  biapaySignatureVerify
);

// 通过键名访问数据
final orderId = value['orderId'];
final biapayTransactionId = value['biapayTransactionId'];
final transactionId = value['transactionId'];
final biapaySignature = value['biapaySignature'];
final generatedSignature = value['generatedSignature'];
final message = value['message'];

响应

成功响应

• onSuccess回调函数将以包含status和message键的数据列表形式返回。status键是一个字符串值，将返回支付流程的状态。message键是一个字符串值，将返回支付流程的消息。

{
  "orderId": "xxx",
  "status": "COMPLETED",
  "currency": "USD",
  "amount": 240,
  "biapayTransactionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "transactionId": "xxxxx",
  "biapaySignature": "/*************",
  "message": "您的付款已成功完成。"
}

错误响应

• onFailed回调函数将以包含status和message键的数据列表形式返回。status键是一个字符串值，将返回支付流程的状态。message键是一个字符串值，将返回支付流程的消息。

{
  "status": "FAILED",
  "message": "您的付款已失败。"
}

验证签名响应

{
  "orderId": "xxx",
  "biapayTransactionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "transactionId": "xxxxx",
  "biapaySignature": "xxxxxxxxxxxxxxxxxxxxxxx",
  "generatedSignature": "xxxxxxxxxxxxxxxxxxxxxxx",
  "message": "签名验证成功。"
}