コンテンツへスキップ
ArionPay

Ruby gem

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

Rails、Sinatra、Rackアプリから暗号資産の請求書を作成し、顧客が支払ったときに署名付きWebhookを検証します。資金はご自身のウォレットに直接届きます。

インストール

gem install arionpay
GitHubのソースコード
例

機能

Ruby開発者向けArionPay

arionpay gemは、Ruby 3.0以降向けのArionPay公式クライアントで、標準ライブラリのみを使用しています。請求書の作成と取得、生のボディでのWebhook署名の検証、テスト請求書を支払いシナリオで進める機能を備えています。
続きを読む請求書はWebhookと同じフィールド名を持つHashなので、1つのメソッドでWebhookと取得結果の両方を処理できます。ArionPayが資金を預かることはありません。資金はご自身のウォレットに直接届きます。
  • 依存関係なし(標準ライブラリのみ)。Ruby 3.0以降。
  • Rails、Sinatra、素のRack向けのREADMEの例。Hanamiや単純なスクリプトでも動作します。
  • 請求書の各リクエストには冪等キー(idempotency key)が付くため、ネットワークエラーで請求書が二重に作成されることはありません。
  • verify_webhookは生のボディで署名を検証し、一致しない場合や5分以上前のものである場合はArionPay::SignatureErrorを送出します。
  • ArionPay.order_matches?(invoice, "49.90", "USD")で、商品を提供する前に注文の合計をセント単位まで確認します。
  • クライアントは複数のスレッド(Puma、Sidekiq)で安全に共有できます。
  • 不正な引数の場合は、何かが送信される前にArgumentErrorが送出されます。APIエラーはArionPay::APIErrorで、メッセージにシークレットが含まれることはありません。

動作要件とライセンス

対応環境
Ruby 3.0以降 · Rails、Sinatra、Hanami、任意のRackアプリ、または単純なスクリプト · 標準ライブラリのみ
費用
ライブラリは無料です。ArionPayの手数料は1回の支払いにつき0.5%で、月額料金はかかりません。
ソースコード
GitHubでオープンソース(MIT)として公開。

セットアップ

5つのステップで設定

  1. ステップ1

    gemをインストール

    gem install arionpay を実行するか、Gemfileにgem "arionpay"を追加します。

  2. ステップ2

    キーをコピー

    ArionPayダッシュボードでストアを開き、APIキー(pk_)とAPIシークレット(sk_。認証アプリのコードが求められます)をコピーします。Webhook署名シークレット(whsec_)は「Webhooks」ページにあります。環境変数かRailsのcredentialsに保管してください。

  3. ステップ3

    請求書を作成

    amount:、currency:、order_id:を指定してcreate_invoiceを呼び出し、顧客をinvoice["invoiceUrl"]にリダイレクトします。

  4. ステップ4

    Webhookを検証

    「Webhooks」ページでWebhookアドレスを設定するか、請求書ごとにcallback_url:で指定します。生のボディ(Railsではrequest.raw_post)とArionPay-Signatureヘッダーをverify_webhookに渡し、invoice.paidで商品を提供します。

  5. ステップ5

    実際のお金を使わずにテスト

    test: trueとUSDT_TRC20などのassetを指定して請求書を作成し、simulate_payment(invoice["id"], "exact")を呼び出します。実際の支払いと同じように、Webhookにinvoice.paidが届きます。

設定の後

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

  • invoice.pending:ネットワーク上で支払いが検知され、承認を待っています。まだ商品を提供しないでください。
  • invoice.paid:全額が支払われて承認された、またはあなたがダッシュボードで手動で受け付けたことを意味します。商品の提供は、このイベントを受け取ったとき(またはget_invoiceがpaidを返したとき)だけにしてください。success_urlに戻ってきたことは、支払いの証明になりません。
  • 商品を提供する前に、請求書を注文と照合してください。order_idまたはmetadataと、金額と通貨についてはArionPay.order_matches?で確認します。
  • invoice.partial、invoice.expired、invoice.needs_reviewは、どれも商品を提供してよいという意味ではありません。期限切れの請求書でも、遅れた支払いによって支払い済みになることがあります。
  • サーバーが2xxで応答しない場合、ArionPayは約3日間再送します。各event["id"]は1回だけ処理し、すばやく応答してください。メールの送信はバックグラウンドジョブで行います。

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 Rubyライブラリに関するよくある質問

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

はい。ActionController::APIをベースにしたコントローラー、またはskip_forgery_protectionを使って、request.raw_postとrequest.headers["ArionPay-Signature"]をverify_webhookに渡します。ArionPay::SignatureErrorをrescueして401を返してください。

開発者向けライブラリ