リファレンス
2328.io API 全体で使用されるネットワークコード、通貨とネットワークの対応表、および支払いステータス値。
このページでは、API リクエストおよびレスポンス全体で使用されるすべてのリファレンス値を一覧表示します。
ネットワークコード
これらのコードは、network フィールドが存在するすべての場所で使用されます：
| Code | Network |
|---|---|
TRX-TRC20 | Tron TRC-20 |
BSC-BEP20 | BNB Smart Chain |
ETH-ERC20 | Ethereum (ERC-20) |
BASE | Base |
AVAX-C | Avalanche C-Chain |
POL-MATIC | Polygon (Matic) |
TON | TON |
BTC | Bitcoin |
LTC | Litecoin |
DASH | Dash |
SOL | Solana |
DOGE | Dogecoin |
ZEC | Zcash |
XRP | XRP Ledger |
XMR | Monero |
通貨とネットワークの対応
各通貨は一部のネットワークでのみ利用可能です。有効な組み合わせを選ぶには、この表を参照してください：
| Currency | Allowed networks |
|---|---|
USDT | TRX-TRC20, BSC-BEP20, ETH-ERC20, BASE, AVAX-C, POL-MATIC, TON, SOL |
USDC | BSC-BEP20, ETH-ERC20, BASE, AVAX-C, POL-MATIC, SOL |
BTC | BTC |
ETH | ETH-ERC20, BASE |
BNB | BSC-BEP20 |
TRX | TRX-TRC20 |
LTC | LTC |
DASH | DASH |
GRAM | TON |
AVAX | AVAX-C |
POL | POL-MATIC |
SOL | SOL |
DOGE | DOGE |
ZEC | ZEC |
XRP | XRP |
XMR | XMR |
GRAM は TON ネイティブ通貨の標準的な資産コードです。支払い、静的ウォレット、および支払い作成 API は現在、従来の TON 入力を受け入れ、GRAM に正規化します。統合では、API が返す標準値を保存および取り扱う必要があります。Polygon ネイティブ資産は POL であり、そのネットワークコードは POL-MATIC です。MATIC をネットワークコードとして送信してはいけません。
有効な方向は運用構成であり、このカタログとは独立して変更できます。選択肢を提示する前に /v1/directions をクエリしてください。この表を有効なコードマップとして扱い、現在すべてのペアが有効である保証とは見なさないでください。
支払いステータス
支払いの payment_status フィールドおよび /v1/payment/list のフィルターは、以下の値を取ります：
| Status | Description |
|---|---|
pending | 作成済み、初期化待ち |
check | 顧客からの支払い待ち |
paid | 支払い完了 |
underpaid_check | 不足支払い（追加入金可能） |
underpaid | 不足支払い |
overpaid | 超過支払い（クレジット済み） |
cancel | キャンセル／期限切れ |
aml_lock | AML によりトランザクションがブロック |
支払い成功を待ち受ける際は、paid と overpaid の両方を成功状態として扱い、顧客の注文をクレジットしてください。
ステータス処理ポリシー
| ステータス | 注文を履行しますか？ | 待機を続けますか？ | 操作アクション |
|---|---|---|---|
pending / check | いいえ | はい、期限まで | 保留状態を表示し、通常通り照合します。 |
underpaid_check | デフォルトはいいえ | はい、追加入金が到着する可能性があります | 各txidを冪等的に保存し、残り支払いのワークフローを表示します。 |
paid | はい、一度だけ | いいえ | 確認済みイベントから原子単位で履行します。 |
overpaid | はい、一度だけ | いいえ | 加盟店ポリシーのために過剰/実際の金額を履行および保持する。 |
underpaid | 製品別 | いいえ | 明示的な部分支払い/手動レビューのポリシーを適用する。 |
cancel | いいえ | いいえ | 期限切れ/キャンセル済みをマークするが、その後のオンチェーンの証拠はエスカレーションする。 |
aml_lock | いいえ | 自動履行なし | コンプライアンス/サポートレビュー；自動的に価値を開放しない。 |
ステータスはプラットフォームの支払いに対する見解を示すものであり、ローカルの履行状態に取って代わるものではない。返金済み、手動でレビュー済み、または既に履行済みの注文が古いウェブフックによって破損しないよう、両方を保存する。
/v1/payment/list リクエストフィルターは現在、pending、check、paid、underpaid_check、underpaid、overpaid、および cancel を受け入れます。AML ロックされた支払いであっても、他の支払いエンドポイントで返金可能である aml_lock は、フィルターとしては受け入れられません。
出金ステータス
/v1/payout および /v1/payout/status/{uuid} の status フィールドは以下のいずれかを取ります：
| Status | Description |
|---|---|
pending | 作成済み、処理待ち |
completed | 正常に完了 — txid が設定される |
failed | 送信エラー — error_type を参照 |
cancelled | キャンセル済み |
出金エラータイプ
出金が status = failed の場合、error_type フィールドが理由を示します：
| Code | Description |
|---|---|
aml_risk | AML リスクチェックにより出金がブロックされました（受取アドレスが高リスクとしてフラグ付け） |