API リファレンス
商用API を参照して、サインの例、注文の状態、およびコールバックの確認方法を確認してください。
公開ルート
| 用途 | メソッド | パス | 認証 |
|---|---|---|---|
| GMPay 注文を作成 | POST | /payments/gmpay/v1/order/create-transaction | 加盟店の HMAC-SHA256 署名 |
| 決済設定を取得 | GET | /payments/gmpay/v1/config | 公開 |
| 決済画面を開く | GET | /pay/checkout-counter/{trade_id} | 公開 |
| 決済の詳細を取得 | GET | /pay/checkout-counter-resp/{trade_id} | 公開 |
| 注文ステータスを取得 | GET | /pay/check-status/{trade_id} | 公開 |
| ネットワークまたは決済事業者を選択 | POST | /pay/switch-network | 公開 |
| 取引ハッシュを送信 | POST | /pay/submit-tx-hash/{trade_id} | 公開 |
| 加盟店サイトに戻る | GET | /pay/return/{trade_id} | ブラウザのリダイレクト |
| EPay 注文を作成 | GET または POST | /payments/epay/v1/order/create-transaction/submit.php | 加盟店の MD5 署名 |
| OKPay 通知を受信 | POST | /payments/okpay/v1/notify | OKPay の署名 |
Admin API の表面
管理APIは /admin/api/v1/* の下に配置されており、ログインと初期パスワードのエンドポイントを除くすべてのAPIはJWTで保護されています。
現在のソースで確認できる主なグループ:
- 一般のレジ係は、保留中のオンチェーン注文のハッシュを受け付けます。また、管理者も、有効期限切れの注文や、手動審査の候補を再確認できます。
- レート設定:
rate.modeはfixedまたはautoです。固定モードはrate.forced_rate_listを使います。自動モードはrate.api_urlから取得できた基準通貨ごとの応答をキャッシュし、更新失敗時は最後に保存したキャッシュを使います。rate.forced_rate_listを空にすると、CNY と USDT/USDC の組み込みの既定レートに戻ります。 /auth/*/api-keys/*/notification-channels/*/config- チェーン/チェーントーク管理
- ウォレットアドレスの管理
- 設定管理
商人の資格に関する規則
GMPay
- 必須の加盟店 ID:
pid - 署名フィールド:
signature v2.0.0以降の署名アルゴリズム:api_keys.secret_keyを利用し、pidに一致する、canonical な空でないパラメータ文字列に対する HMAC-SHA256- v2 GMPay MD5 のクライアントは、
v2.0.0以後のリリース前に、アップグレードが必要です。
EPayに対応した流れ
- 必須の加盟店 ID:
pid - 署名フィールド:
sign - シグネチャードメイン:有効な
api_keysの行における、pidに一致するsecret_key sign_typeは一般的に受け入れられ、通常はMD5を使用します。- EPay
typeは、alipayまたは、サポートされているtoken.networkセレクター(例:usdt.tron)を受け付けます。受け付けたセレクターは、EPay の返送/通知コールバックにおいて保存されます。
推奨される統合の順序
- 管理パネルで、商人の資格を作成または確認(
pid+secret_key) /payments/gmpay/v1/configのクエリを実行し、クライアントが動的ネットワーク/トークンオプションが必要な場合に、data.supported_assetsを読み取る。- 新しい連携には、GMPayをご利用をおすすめします。
- EPayに対応したリダイレクトは、上流システムがその流れを期待する場合にのみ使用してください。
- 同じ加盟店の
secret_keyでコールバックを検証します