README

Bleumi Pay SDK for PHP

Bleumi Pay SDK 帮助您将 Algo、Algorand 标准资产、Ethereum、ERC-20、RSK、RSK ERC-20 和 xDai 支付和支付款集成到您的业务或应用中。该 SDK 将 Bleumi Pay API 打包成一个 SDK，以简化实现并支持。

bleumi-pay-sdk-php 是一个 PHP 库，它为您的 PHP 应用程序和 Bleumi Pay API 之间提供了一个接口。本教程涵盖了使用 SDK 所需的基础知识，包括示例。

入门

先决条件

开发环境

PHP 5.5 及更高版本

获取 API 密钥

Bleumi Pay SDK 使用 API 密钥进行请求认证。您可以通过 Bleumi Pay 控制台获取 API 密钥。

安装包

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

{
  "require": {
        "bleumi/bleumi-pay-sdk-php":"1.0.23"
    }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/bleumi-pay-sdk-php/vendor/autoload.php');

运行示例代码

以下代码生成一个唯一的结账 URL，以接受买家的付款。

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = Bleumi\Pay\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', '<Your API Key>');

$apiInstance = new Bleumi\Pay\Api\HostedCheckoutsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$chain = new \Bleumi\Pay\Model\Chain(); 

try {
    $createReq = new \Bleumi\Pay\Model\CreateCheckoutUrlRequest();  // Checkout URL creation parameters. 
    $createReq->setId("<ID>"); // string |  Eg. '1'
    $createReq->setCurrency("<CURRENCY>"); // string |  Eg. 'USD'
    $createReq->setAmount("<AMOUNT>"); // string | Eg. '10'
    $createReq->setSuccessUrl("<SUCCESS_URL>"); // string | Eg. https://demo.store/api/completeOrder
    $createReq->setCancelUrl("<CANCEL_ORDER_URL>"); // string | Eg. https://demo.store/api/cancelOrder
    $createReq->setToken("<TOKEN>"); // string |  Replace <TOKEN>  by anyone of the following values: 'ETH' or 'XDAI' or 'XDAIT' or ECR-20 Contract Address or 'RBTC' or RSK ECR-20 Contract Address or 'Asset ID' of Algorand Standard Asset. | Optional
    $createReq->setChain($chain::GOERLI); //Optional, but required if '<Token>' is specified; Replace GOERLI with the Chain as required
    $result = $apiInstance->createCheckoutUrl($createReq);
    echo  json_encode($result, JSON_PRETTY_PRINT);
} catch (Exception $e) {
    echo 'Exception when calling HostedCheckoutsApi->createCheckoutUrl: ', $e->getMessage(), nl2br (" \n ");
    echo 'Code: ', $e->getCode(), nl2br (" \n ");
    if (method_exists($e, 'getResponseBody')) {
        echo 'Response Body: ', $e->getResponseBody(), nl2br (" \n ");
    }
}
?>

更多示例可以在 SDK 类部分找到。

SDK 类

类	方法	HTTP 请求	描述
HostedCheckoutsApi	createCheckoutUrl	POST /v1/payment/hc	生成一个唯一的结账 URL 以接受付款。
HostedCheckoutsApi	listTokens	GET /v1/payment/hc/tokens	从 Bleumi Pay 控制台中检索您账户中配置的所有 Hosted Checkout 令牌。
HostedCheckoutsApi	validateCheckoutPayment	POST /v1/payment/hc/validate	在成功完成付款后，验证 Hosted Checkout 在 successUrl 中传递的 GET 参数。
PaymentsApi	getPayment	GET /v1/payment/{id}	检索给定付款的钱包地址和令牌余额。
PaymentsApi	listPayments	GET /v1/payment	检索创建的所有付款。
PaymentsApi	settlePayment	POST /v1/payment/{id}/settle	结算特定金额的代币到转账地址，剩余余额（如有）将退还给买家地址
PaymentsApi	退款支付	POST /v1/payment/{id}/refund	将特定支付中的代币余额退还给买家地址
PaymentsApi	获取支付操作	GET /v1/payment/{id}/operation/{txid}	获取特定支付的支付操作。
PaymentsApi	列出支付操作	GET /v1/payment/{id}/operation	获取特定支付的所有支付操作。
支付API	创建退款	POST /v1/payout	创建退款。
支付API	列出退款	GET /v1/payout	返回退款列表

bleumi / bleumi-pay-sdk-php

维护者

详细信息