Pythonライブラリ
Pythonアプリで暗号資産決済を受け付け
Flask、Django、FastAPI、または単純なスクリプトから暗号資産の請求書を作成し、顧客が支払ったときに署名付きWebhookを検証します。資金はご自身のウォレットに直接届きます。
インストール
pip install arionpay例
機能
Python開発者向けArionPay
arionpayは、Python 3.8以降向けのArionPay公式クライアントで、標準ライブラリのみで書かれています。請求書の作成と取得、生のボディでのWebhook署名の検証、テスト請求書を支払いシナリオで進める機能を備えています。
続きを読む
請求書はWebhookと同じフィールド名を持つdictとして返るため、1つの関数でWebhookと取得結果の両方を処理できます。ArionPayが資金を預かることはありません。資金はご自身のウォレットに直接届きます。- 依存関係なし(標準ライブラリのみ)。Python 3.8以降。
- Flask、Django、FastAPI向けのREADMEの例。単純なスクリプトでも動作します。
- 請求書の各リクエストには冪等キー(idempotency key)が付くため、ネットワークエラーで請求書が二重に作成されることはありません。
- 請求書の各リクエストに、HMAC-SHA256とAPIシークレットで署名します。シークレット自体が送信されることはありません。
- verify_webhookは生のボディでArionPay-Signatureヘッダーを検証し、一致しない場合や5分以上前のものである場合はSignatureErrorを送出します。
- simulate_paymentはテスト請求書をexact、partial_half、overpaid、lateなどのシナリオで進めます。send_test_webhookは署名付きのサンプルイベントを送信します。
- 型ヒント(py.typed)付き。
動作要件とライセンス
- 対応環境
- Python 3.8以降 · Flask、Django、FastAPI、または単純なスクリプト · 標準ライブラリのみ
- 費用
- ライブラリは無料です。ArionPayの手数料は1回の支払いにつき0.5%で、月額料金はかかりません。
- ソースコード
- GitHubでオープンソース(MIT)として公開。
セットアップ
5つのステップで設定
ステップ1
パッケージをインストール
pip install arionpay を実行します。標準ライブラリのみを使用します。
ステップ2
キーをコピー
ArionPayダッシュボードでストアを開き、APIキー(pk_)とAPIシークレット(sk_。認証アプリのコードが求められます)をコピーします。Webhook署名シークレット(whsec_)は「Webhooks」ページにあります。環境変数などを使って、サーバー側に保管してください。
ステップ3
請求書を作成
金額、通貨、order_idを指定してcreate_invoiceを呼び出し、顧客をinvoice["invoiceUrl"]に誘導します。
ステップ4
Webhookを検証
「Webhooks」ページでWebhookアドレスを設定するか、請求書ごとにcallback_urlで指定します。生のボディとArionPay-Signatureヘッダーをverify_webhookに渡し、invoice.paidで注文の商品を提供します。
ステップ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が一致し、金額と通貨が注文の現在の合計と同じであることを確認します。
- 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 Pythonライブラリに関するよくある質問
コードに組み込む前に知っておきたいことを簡潔にお答えします。
はい。ビューに@csrf_exemptと@require_POSTを付け、request.bodyとArionPay-Signatureヘッダーをverify_webhookに渡します。
await request.body()で生のバイト列を読み取り、arionpay-signatureヘッダーとともにverify_webhookに渡します。SignatureErrorが送出された場合は401で応答してください。
いいえ。依存関係はなく、Pythonの標準ライブラリのみを使用します。
test=Trueとasset="USDT_TRC20"を指定して請求書を作成し、simulate_payment(invoice["id"], "exact")を呼び出します。テスト請求書には"test": Trueが付くため、本番のショップでは無視できます。
ライブラリは無料のオープンソース(MITライセンス)です。ArionPayは各支払いの0.5%を前払いの手数料残高から差し引くため、全額がウォレットに届きます。月額料金や初期費用はなく、新規アカウントには$20分の手数料クレジットが付与されます。