コンテンツへスキップ
ArionPay

Laravelパッケージ

Laravelアプリで暗号資産決済を受け付け

ArionPay::createInvoiceで請求書を作成し、InvoicePaidリスナーで注文の商品を提供します。署名、テスト/本番モード、重複配信のチェックは、パッケージが代わりに行います。

インストール

composer require arionpay/arionpay-laravel
GitHubのソースコード
例

機能

Laravel開発者向けArionPay

arionpay/arionpay-laravelは公式PHPライブラリをベースにした、PHP 8.1以降で動作するLaravel 10〜13向けのパッケージです。署名付きの更新をすべて検証し、通常のLaravelイベントとして1回だけ発火させるWebhookルートを追加します。
続きを読むテストモードでは新しい請求書がすべてテスト請求書になるため、実際のお金を使わずに全体の流れを試せます。支払いはご自身のウォレットに直接届きます。ArionPayが資金を預かることはありません。
  • ArionPay::createInvoice([...])で、支払いページのアドレス(invoiceUrl)を取得できます。
  • 支払いの更新はLaravelイベントとして届きます:InvoicePaid、InvoicePending、InvoicePartial、InvoiceExpired、InvoiceNeedsReview、TestWebhookReceived。
  • ルートPOST /arionpay/webhookは、正確なボディに対してArionPay-Signatureを検証します(許容幅5分)。それ以外には401が返され、イベントは発火しません。
  • 各イベントは1回だけ発火します。キャッシュに96時間記憶されます。
  • ARIONPAY_TEST_MODE=trueにすると、新しい請求書はテスト請求書になり、テストWebhookだけを受け付けます。一致しない場合は409が返されます。
  • php artisan arionpay:check はキーを確認し、Webhookアドレスを表示します。php artisan arionpay:test-webhook は、署名付きのサンプルイベントをArionPayに要求します。
  • すべてのイベントには、注文との照合に使うmatches($amount, $currency)、invoiceId()、orderId()、metadata()があります。

動作要件とライセンス

対応環境
Laravel 10〜13 · PHP 8.1以降 · arionpay/arionpay-phpをベースに構築
動作確認
Laravel 13.42と12(実際のArionPayサーバーで検証)
費用
ライブラリは無料です。ArionPayの手数料は1回の支払いにつき0.5%で、月額料金はかかりません。
ソースコード
GitHubでオープンソース(MIT)として公開。

セットアップ

5つのステップで設定

  1. ステップ1

    パッケージをインストール

    composer require arionpay/arionpay-laravel を実行します。サービスプロバイダーとArionPayファサードは、Laravelが自動で読み込みます。

  2. ステップ2

    .envにキーを追加

    ArionPayダッシュボードの値を使ってARIONPAY_API_KEY(pk_)、ARIONPAY_API_SECRET(sk_)、ARIONPAY_WEBHOOK_SECRET(whsec_)を設定し、ARIONPAY_TEST_MODE=trueにします。その後、php artisan arionpay:check を実行します。

  3. ステップ3

    請求書を作成

    金額、orderId、'order-' . $order->idのようなidempotencyKeyを指定してArionPay::createInvoiceを呼び出し、$invoice['invoiceUrl']にリダイレクトします。独自のcallbackUrlを渡さない限り、請求書は更新をアプリのWebhookルートに送ります。

  4. ステップ4

    InvoicePaidで商品を提供

    ArionPay\Laravel\Events\InvoicePaidをリッスンし、注文を見つけて$event->matches($order->total, $order->currency)を確認してから、商品を提供します。リスナーが例外をスローするとルートは500を返し、ArionPayが後で再送します。

  5. ステップ5

    テストしてから本番へ

    テストモードでは、'asset' => 'USDT_TRC20'で請求書を作成してArionPay::simulatePayment($invoice['id'], 'exact')を呼び出すか、ダッシュボードの「Try a test payment」ボタンを使います。本番の支払いではARIONPAY_TEST_MODE=falseに設定してください。

設定の後

支払いがコードに届くまで

  • InvoicePaid:全額が支払われて承認されたので、商品を提供します。遅れた支払い、支払い許容範囲(初期値1%)内の小さな差、Payment Radarで受け付けた支払いでも発火します。
  • InvoicePending:ネットワーク上で支払いが検知され、承認を待っています。まだ商品を提供しないでください。
  • InvoicePartialとInvoiceExpired:全額は支払われていません。その後、遅れた支払いによってInvoicePaidが続くこともあります。
  • InvoiceNeedsReview:ArionPayダッシュボードで判断してください。受け付けると、InvoicePaidが続きます。
  • TestWebhookReceived:「Send test webhook」による、架空の請求書についてのサンプルです。これで商品を提供しないでください。

9つのネットワークで16種類のコインとトークン

すべてのコイン
  • BTCBitcoin
  • ETHEthereum
  • USDTEthereum
  • USDCEthereum
  • BNBBNB Smart Chain
  • USDTBNB Smart Chain
  • USDCBNB Smart Chain
  • POLPolygon
  • USDTPolygon
  • USDCPolygon
  • TRXTRON
  • USDTTRON
  • LTCLitecoin
  • DOGEDogecoin
  • BCHBitcoin Cash
  • DASHDash

ArionPay Laravelライブラリに関するよくある質問

コードに組み込む前に知っておきたいことを簡潔にお答えします。

Laravel 10〜13で、PHP 8.1以降が必要です。Laravel 13.42と12で、実際のArionPayサーバーを使って動作を確認しています。

開発者向けライブラリ