paycoin/paycoin-laravel

dev-main 2021-08-09 19:16 UTC

This package is not auto-updated.

Last update: 2024-09-28 21:49:34 UTC


README

一个用于轻松处理 paycoin 的 Laravel 扩展包

安装

需要 PHP 5.4+ 和 Composer

要获取 Laravel Paycoin 的最新版本,只需要求它

$ composer require paycoin/paycoin-laravel

配置

您可以使用此命令发布配置文件

$ php artisan vendor:publish

"then input 0 follow by enter key"

使用方法

打开您的 .env 文件并添加您的 secret key,例如

secret_key=xxxxxxxxxxxxxxxxxxxxxxxxxx

您可以在控制器中直接使用这些函数

获取所有发票

use Paycoin\Paycoins\Paycoins;

public function getAllInvoices()
{
    return Paycoins::getInvoices();
}

通过 Ref 获取发票

use Paycoin\Paycoins\Paycoins;

public function getInvoiceByRef()
{
    return Paycoins::getInvoice("INV1626354432969");
}

创建发票

use Paycoin\Paycoins\Paycoins;

public function createInvoice()
{
    return Paycoins::create_invoice(
        (object)[
            "amount" => 1000000,
            "currency" => 'NGN',
            "redirect_url"=> 'https://abc.com',
            "customer" => [
                'firstname' => "test",
                'lastname' => "name",
                'email' => "testname@mail.com"
            ],
            "customization" => [
                "title" => "Sales"
            ]
        ]
    );
}

获取 1 NGN 对所有其他加密货币和法定货币的当前市场兑换率

use Paycoin\Paycoins\Paycoins;

public function getExchangeRates()
{
    return Paycoins::exchangeRate("NGN");
}

Webhooks

Webhooks 允许您配置一个 URL,每次您的账户发生事件时都会通知该 URL。当您订阅的事件之一发生时,paycoins 将通过 HTTP POST 请求将表示该事件的 JSON 对象发送到您的 webhooks URL。

Webhook 配置

您可以编辑现有的 webhook 配置,或者在 paycoins 开发者账户设置中点击“添加 Webhook”配置。最重要的是提供应将事件发送到的 URL 地址。

响应 webhook

我们不期望您配置的端点有任何响应。您可以响应一个常规的 HTTP 200 状态码,但这不是必需的。我们目前不支持重新发送未能正确交付的事件。

事件类型

这是我们当前发送的所有事件类型的列表。我们可能随时添加更多,因此您不应该仅在代码中依赖于这些类型的存在。

新存款支付

当新的支付存入您的钱包时发送。

响应结果
data: {
  currency: "BTC",
  amount: 0.001,
  type: "payment-successful",
  reference: "INV1608644446774",
},

支付

当您的钱包上有新的支付/取款时发送。

响应结果。

注意:此响应可能因支付操作的状态而异

支付成功响应

data: {
  currency: "BTC",
  amount: 0.001,
  type: "payout",
  status: "successful"
},

支付失败响应

data: {
  currency: "BTC",
  amount: 0.001,
  type: "payout",
  status: "failed"
},

支付请求过期响应

data: {
 currency: "BTC",
  amount: 0.001,
  type: "payout",
  status: "expired"
},

支付取消响应

data: {
  currency: "BTC",
  amount: 0.001,
  type: "payout",
  status:"canceled"
},