💳 ネイティブチェックアウトの統合

API 更新通知

最近 API エンドポイントとパラメータに更新がありました。詳細は変更履歴をご参照ください。

Native Checkout API: ユーザーはサイト/アプリ上に構築されたチェックアウトページの QR コードをスキャンするか、アドレスをコピーして支払いを行うことができます。

Native Checkout API と統合して、サイト/アプリのチェックアウトページを構築します。ユーザーはあなたのサイト/アプリ内で支払います。外部ページに誘導する必要はありません。ユーザーのチェックアウト体験を完全にコントロールできます。

📦 1. 注文の作成

インターフェースの説明: このインターフェースを介して支払い注文を送信し、受領情報を取得します。
インターフェースのアドレス: POST /api/order/create

リクエストパラメータ

フィールド	タイプ	必須	説明
out_trade_no	string	はい	マーチャントの注文 ID
currency_id	int	はい	グローバルに一意の通貨 ID
`fiat_name`	string	いいえ	法定通貨名 (USD / USDT / JPY / CHF / CAD / NOK / SEK / HKD / SGD / KRW / TWD / CNY / INR / BRL / MXN / ZAR / RUB / TRY / EUR / GBP / AUD / VND / THB)
fiat_amount	string	いいえ	法定通貨の金額 ("1.2")
token_amount	string	いいえ	トークンの金額
callback_url	string	いいえ	コールバック URL
time_out	int64	いいえ	10桁の有効期限タイムスタンプ、0 を入力すると、デフォルトは 30 分 (1753513764) です

レスポンスフィールドの説明

フィールド	タイプ	説明	例
trade_no	string	トランザクション ID	"20250629153045a7b3c9d2e5f8a1b4c6"
chain	string	ブロックチェーンネットワーク	"Tron"
token	string	暗号通貨トークン	"TRX"
contract	string	トークンコントラクトアドレス	"TRX"
amount	string	トランザクション金額	"15.724197"
mode	string	支払いモード	"address"
pay_address	string	受取人アドレス	"TSg8kWPE2s7z5Lon6bSnZZrYnquGHx2..."
time_expire	integer	有効期限タイムスタンプ	1753515371
decimal	integer	トークンの小数点桁数	6
chain_id	integer	チェーン ID	3448148188
equity	integer	エクイティ値	1
create_time	integer	作成タイムスタンプ	1753513571
amount_collected	string	収集された金額	"0"
need_confirms	integer	必要な確認数	0
already_confirms	integer	現在の確認数	0
entrust_url	string	支払い URL	"https://checkout.pay.halochat.io/20260....b876498e0771e1"
referer	string	リファラー情報	""
chain_info	object	チェーン情報	`{"token": "TRX", "rpc": "...", ...}`

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "trade_no": "20260317173635066d54f5b6c7269d41",
    "chain": "Tron",
    "token": "TRX",
    "contract": "TRX",
    "amount": "16.556743",
    "mode": "address",
    "pay_address": "THgSjcyhyxfzrjtS7VYw1vnHvb7QkMsY...",
    "time_expire": 1773741995,
    "decimal": 6,
    "chain_id": 3448148188,
    "equity": 1,
    "create_time": 1773740196,
    "amount_collected": "",
    "need_confirms": 0,
    "already_confirms": 0,
    "entrust_url": "https://checkout.pay.halochat.io/20260317173635066d54f5b6c7269d41",
    "referer": "",
    "chain_info": {
      "token": "TRX",
      "abi": "",
      "rpc": "https://nile.trongrid.io",
      "browser_url": "https://nile.tronscan.org/#/transaction",
      "decimal": 6,
      "logo": "https://halo-n.oss-ap-southeast-1.aliyuncs.com/png/202505/45d1f4b5-b80f-4331-af78-ec557f97d832.png",
      "series": "Tron",
      "monitor_chain_id": 3448148188
    }
  }
}

🔍 2. 注文のクエリ

インターフェースの説明: このインターフェースを使用して注文ステータスをクエリします。
インターフェースのアドレス: POST /api/order/detail

リクエストパラメータ

フィールド	タイプ	必須	説明
trade_no	string	はい	トランザクション ID

レスポンスフィールドの説明

フィールド	タイプ	説明	例
trade_no	string	トランザクション ID (プラットフォーム)	"20250629153045a7b3c9d2e5f8a1b4c6"
out_trade_no	string	マーチャントの注文 ID	"202401011753513569"
chain	string	ブロックチェーンネットワーク	"Tron"
token	string	暗号通貨トークン	"TRX"
contract	string	トークンコントラクトアドレス	"TRX"
fiat_name	string	法定通貨名	"USD"
fiat_amount	string	支払う法定通貨の金額	"5"
amount	string	送信する暗号通貨の金額	"15.724197"
mode	string	支払いモード	"address"
pay_address	string	受取人の暗号通貨アドレス	"TSg8kWPE2s7z5Lon6bSnZZrYnquGHx2bsj"
status	string	トランザクションステータス	"TO-BE-PAID"
time_expire	integer	有効期限タイムスタンプ (Unix)	1753515371
decimal	integer	トークンの小数点桁数	6
chain_id	integer	チェーン ID	3448148188
equity	integer	エクイティ値	1
create_time	integer	作成タイムスタンプ (Unix)	1753513571
amount_collected	string	収集された金額	"0"
need_confirms	integer	必要な確認数	0
already_confirms	integer	現在の確認数	0
entrust_url	string	支払い URL (該当する場合)	""
referer	string	リファラー情報	""
chain_info	object	チェーン情報	`{"token": "TRX", "rpc": "...", ...}`

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "trade_no": "20260317173635066d54f5b6c7269d41",
    "out_trade_no": "ORDER_1773740195363",
    "chain": "Tron",
    "token": "TRX",
    "contract": "TRX",
    "fiat_name": "USD",
    "fiat_amount": "5",
    "amount": "16.556743",
    "mode": "address",
    "pay_address": "THgSjcyhyxfzrjtS7VYw1vnHvb7QkMsY7w",
    "status": "TO-BE-PAID",
    "time_expire": 1773741995,
    "decimal": 6,
    "chain_id": 3448148188,
    "equity": 1,
    "create_time": 1773740196,
    "amount_collected": "0",
    "need_confirms": 0,
    "already_confirms": 0,
    "entrust_url": "",
    "referer": "",
    "chain_info": {
      "token": "TRX",
      "abi": "",
      "rpc": "https://nile.trongrid.io",
      "browser_url": "https://nile.tronscan.org/#/transaction",
      "decimal": 6,
      "logo": "",
      "series": "",
      "monitor_chain_id": 0
    }
  }
}

💱 3. 価格の為替レート

インターフェースの説明: TOKEN と法定通貨の間の現在の為替レートを取得します。
インターフェースのアドレス: POST /api/order/exchange-rates

リクエストパラメータ

フィールド	タイプ	必須	説明
currency_id	int	はい	グローバルに一意の通貨 ID
`fiat_name`	string	はい	法定通貨の略称 (USD / USDT / JPY / CHF / CAD / NOK / SEK / HKD / SGD / KRW / TWD / CNY / INR / BRL / MXN / ZAR / RUB / TRY / EUR / GBP / AUD / VND / THB)
fiat_amount	string	はい	法定通貨の金額

レスポンスフィールドの説明

フィールド	タイプ	説明
amount	string	金額
exchange_rate	string	為替レート

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "amount": "0.00001971",
    "exchange_rate": "100"
  }
}

📋 4. アプリ別トークン一覧（残高付き）

インターフェースの説明: 現在のアプリ（X-Appid）で入金受取が有効な暗号資産と、アドレス集計による残高を返します（POST /api/account/balance と同等の集計基準）。プラットフォーム上の全トークン一覧ではありません。全件は §5 トークンリスト を参照してください。
インターフェースのアドレス: POST /api/currency/app-token-list
リクエストパラメータ: ボディは {}。認証ヘッダーは他 API と同様です。

レスポンスフィールドの説明

ルートオブジェクト:

フィールド	タイプ	説明
code	integer	業務コード、`0` は成功
msg	string	メッセージ
data	array	現在のアプリで入金有効なトークンと残高

data[] の要素:

フィールド	タイプ	説明
currency_id	integer	グローバルに一意の通貨 ID
chain	string	チェーン名
network	string	ネットワーク名
token	string	トークンシンボル
contract	string	コントラクトアドレス
chain_id	integer	チェーン ID
logo	string	トークンロゴ URL
decimal	integer	小数桁数
balance	string	総残高（10 進文字列）
operable_balance	string	操作可能残高
frozen_amount	string	凍結額
status	integer	状態: 1 — 有効、2 — 無効
transaction_enabled	boolean	入金有効（本レスポンスでは常に `true`）

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "currency_id": 46,
      "chain": "Tron",
      "network": "Nile",
      "token": "JST",
      "contract": "TF17BgPaZYbxxxxhriubPDsA7ArKoLX3",
      "chain_id": 3448148188,
      "logo": "https://halo-n.oss-ap-southeast-1.aliyuncs.com/png/202505/xxx-c3f3-4d5d-a9b5-0143d78326f9.png",
      "decimal": 18,
      "balance": "0.785074013",
      "operable_balance": "0.785074013",
      "frozen_amount": "0",
      "status": 1,
      "transaction_enabled": true
    }
  ]
}

📋 5. トークンリスト

インターフェースの説明: システムでサポートされている Token リストを取得します。アプリで入金が有効なトークンと残高が必要な場合は §4 アプリ別トークン一覧 を使用してください。
インターフェースのアドレス: POST /api/currency/token-list
リクエストパラメータ: なし

レスポンスフィールドの説明

フィールド	タイプ	説明
currency_id	int	グローバルに一意の通貨 ID。
chain	string	チェーン
network	string	ネットワーク
token	string	トークン
contract	string	コントラクトアドレス。現在のメイン通貨が通貨名と同じ場合、値は通貨名と一致します。
chain_id	int	チェーン ID。イーサリアムシリーズのみ値があります。
logo	string	ロゴ
decimal	int	精度

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "currency_id": 46,
      "chain": "Tron",
      "token": "JST",
      "network": "Nile",
      "contract": "TF17BgPaZYbxxxxhriubPDsA7ArKoLX3",
      "chain_id": 3448148188,
      "logo": "https://halo-n.oss-ap-southeast-1.aliyuncs.com/png/202505/xxx-c3f3-4d5d-a9b5-0143d78326f9.png",
      "decimal": 18
    }
  ]
}

💸 6. ペイアウト (出金)

インターフェースの説明: マーチャントはこのインターフェースを介して指定されたアドレスに現金を引き出すことができます。
インターフェースのアドレス: POST /api/payout/create

リクエストパラメータ

フィールド	タイプ	必須	説明
currency_id	int	はい	グローバルに一意の通貨 ID
amount	string	はい	通貨の基本金額
to_address	string	はい	受取人アドレス
callback_url	string	いいえ	コールバックアドレス (マーチャントの APPID で設定されたデフォルトのコールバックアドレス)
google_code	string	いいえ	Google 認証コード (現在のアプリで認証が有効になっている場合は必須)

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "cost": "0.801502",
    "actual_receipt": "0.001",
    "trade_no": "202603171746187e582d1b789b27ea55",
    "estimated_transfer": "0"
  }
}

📊 7. 転送ステータスのクエリ

インターフェースの説明: ペイアウトの注文ステータスをクエリします。
インターフェースのアドレス: POST /api/payout/detail

リクエストパラメータ

フィールド	タイプ	必須	説明
trade_no	string	はい	トランザクション番号

レスポンスフィールドの説明

フィールド	タイプ	説明
trade_no	string	トランザクション ID
service_charge	string	サービス手数料
gas	string	GAS 料金
token	string	通貨
amount	string	金額
target_address	string	受取人アドレス
start_time	int	開始時間
created_time	int	作成時間
status	string	トランザクションステータス (CONFIRMING-PROGRESS: 確認中, PAID: 成功, FAIL: 失敗, CANCEL: キャンセル済み, PROGRESS: 保留中)

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "service_charge": "0.000002",
    "gas": "0.8015",
    "amount": "0.001",
    "status": "TRANSFER",
    "target_address": "TDYiTL3pke3T9BsoTotbKb922WsXQCmSxv",
    "start_time": 1773740882,
    "created_time": 1773740882,
    "trade_no": "202603171748020a09cbb09b4846bc99",
    "token": "DK7bKg181cC7pBgX3PxSIH2WdklZ5IPT"
  }
}

💰 8. 残高の確認

この API を介して、アプリケーションの単一通貨の残高情報を取得します。

インターフェースのアドレス: POST /api/account/balance

リクエストパラメータ

フィールド	タイプ	必須	説明
currency_id	int	はい	グローバルに一意の通貨 ID

レスポンスフィールドの説明

フィールド	タイプ	説明
currency_id	int	グローバルに一意の通貨 ID
balance	string	残りの数量
balance_usdt	string	USDT に変換された残りの数量の価値
operable_balance	string	操作可能な数量 (ウォレットアドレスのメイン通貨の金額が低すぎて収集できない場合、そのウォレットアドレスは使用できません。パーソナルセンター => ネットワーク設定を参照して、操作可能な最小しきい値を確認してください。)
operable_balance_usdt	string	操作可能な数量の価値
chain	string	チェーン名
network	string	ネットワーク
token	string	トークン
contract	string	コントラクトアドレス (略称トークン名としてのメイントークン)

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "currency_id": 46,
    "balance": "0.785074013",
    "operable_balance": "0.785074013",
    "operable_balance_usdt": "0.043642",
    "balance_usdt": "0.043642",
    "chain": "Tron",
    "network": "Nile",
    "token": "JST",
    "contract": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3"
  }
}

🖼️ 9. 静的支払い QR コード

インターフェースの説明: API を介して独立した静的支払いアドレスを申請します。対応する APPID の CallBack インターフェースアドレスにコールバックされます。
インターフェースのアドレス: POST /api/payment-qr-code/create

リクエストパラメータ

フィールド	タイプ	必須	説明
name	string	はい	QR コード名
currency_id	int	はい	グローバルに一意の通貨 ID
amount	string	いいえ	デフォルトの支払い金額 ("0" にすることができます)

レスポンスフィールドの説明

フィールド	タイプ	説明	例
id	int	一意の QR コード ID	115
address	string	静的支払いアドレス	"TXd8UKLtLqk5V15v7e3W43ZdNw6berp6DP"

成功レスポンスの例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": 115,
    "address": "TXd8UKLtLqk5V15v7e3W43ZdNw5berp6DP"
  }
}

💡

これには、この API にリクエストを行うために QR コードアプリケーションの APPID が必要です。

📌 エラーコードを表示

📦 1. 注文の作成​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

🔍 2. 注文のクエリ​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

💱 3. 価格の為替レート​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

📋 4. アプリ別トークン一覧（残高付き）​

レスポンスフィールドの説明​

成功レスポンスの例​

📋 5. トークンリスト​

レスポンスフィールドの説明​

成功レスポンスの例​

💸 6. ペイアウト (出金)​

リクエストパラメータ​

成功レスポンスの例​

📊 7. 転送ステータスのクエリ​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

💰 8. 残高の確認​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

🖼️ 9. 静的支払い QR コード​

リクエストパラメータ​

レスポンスフィールドの説明​

成功レスポンスの例​

📦 1. 注文の作成

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例

🔍 2. 注文のクエリ

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例

💱 3. 価格の為替レート

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例

📋 4. アプリ別トークン一覧（残高付き）

レスポンスフィールドの説明

成功レスポンスの例

📋 5. トークンリスト

レスポンスフィールドの説明

成功レスポンスの例

💸 6. ペイアウト (出金)

リクエストパラメータ

成功レスポンスの例

📊 7. 転送ステータスのクエリ

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例

💰 8. 残高の確認

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例

🖼️ 9. 静的支払い QR コード

リクエストパラメータ

レスポンスフィールドの説明

成功レスポンスの例