README

WhapplePay SDK 文档

介绍

欢迎使用 WhapplePay SDK 文档。此 SDK 可与 WhapplePay 支付网关无缝集成，使开发者能够在他们的应用中处理支付和提款。

安装

要在项目中使用 WhapplePay SDK，请按照以下步骤操作：

1. 使用 Composer 安装 SDK 包

   composer require vendor/whapplepay-sdk:^1.0.0
   

2. 在您的 PHP 文件中包含 SDK

   use Whapplepay\WhapplePaySDK;

配置

在开始使用 WhapplePay SDK 之前，请确保在您的 .env 文件中设置以下环境变量

基础 URL = http://whapplepay.com/api/sdkprocess-payment/payments

WHAPPLEPAY_API_URL=https://api.whapplepay.com/
WHAPPLEPAY_PAYMENT_METHOD=MobileMoney
WHAPPLEPAY_SUCCESS_URL=http://example.com/success
WHAPPLEPAY_CANCEL_URL=http://example.com/cancel
WHAPPLEPAY_CLIENT_ID=your_whapplepay_client_id
WHAPPLEPAY_CLIENT_SECRET=your_whapplepay_client_secret
CURRENCY=XAF

用法

初始化

实例化 WhapplePaySDK 类以开始使用 SDK

$whapplePay = new WhapplePaySDK();

处理支付

要使用 WhapplePay SDK 处理支付，请使用 processPayment 方法

// Process Payment and Handle Response
$response = $whapplePay->processPayment($amount, $currency, $paymentMethod, $clientId, $clientSecret, $phoneNumber);

// Check if the payment was successful
if (isset($response['transaction']) && isset($response['status']) && $response['status'] == 200) {
    $transaction = $response['transaction'];
    
    // Display payment details
    echo "Payment Details:\n";
    echo "Transaction ID: " . $transaction['id'] . "\n";
    echo "Amount: " . $transaction['total'] . " " . $transaction['currency'] . "\n";
    echo "Status: " . $transaction['status'] . "\n";

    // Additional processing or actions based on the payment success
    // For example, update user balance, send confirmation email, etc.
    // Your code here...

    // Display success message
    echo "Payment successful!\n";
} else {
    // Handle payment failure or other errors
    if (isset($response['error'])) {
        echo "Error: " . $response['error'] . "\n";
    } else {
        echo "Payment failed!\n";
    }
}

参数

• $amount：支付的金额。
• $currency：支付的货币（例如，"F.CFA"，"NGN"）。
• $paymentMethod：支付方式（例如，"WhapplpePay"，"MobileMoney"）。
• $clientId：您的客户端 ID 以进行身份验证。
• $clientSecret：您的客户端密钥以进行身份验证。
• $phoneNumber：MobileMoney 支付的电话号码。

提款

要使用 WhapplePay SDK 初始化提款，请使用 withdrawMoney 方法

$response = $whapplePay->withdrawMoney($amount, $currency, $withdrawMethod, $clientId, $clientSecret);

参数

• $amount：要提款的金额。
• $currency：提款的货币。
• $withdrawMethod：提款方式。
• $clientId：您的客户端 ID 以进行身份验证。
• $clientSecret：您的客户端密钥以进行身份验证。

支持的支付方式

以下表格显示了支持的支付方式和它们在存款和提款中的实现状态

错误处理

如果在 API 调用过程中发生任何错误，SDK 会返回错误消息。请适当地在您的应用程序中处理这些错误。

版本控制

WhapplePay SDK 遵循语义版本控制。在安装包时指定所需的版本以确保兼容性。

支持和反馈

有关 WhapplePay SDK 的支持或反馈，请联系我们的支持团队 support@whapplepay.com。

许可证

WhapplePay SDK 在 MIT 许可证下授权。有关详细信息，请参阅 LICENSE 文件。