バージョン: 最新版

残高API

概要

残高APIを使用すると、すべてのサポートされている通貨で、利用可能な資金、保留中の金額、振込可能な残高を含む現在のアカウント残高を取得できます。

利用可能なエンドポイント

残高を取得 - GET /balance

できること

利用可能残高を確認 - 振込に利用可能な金額を確認
保留中の金額を表示 - 決済待ちの資金を監視
複数通貨対応 - THB、JPY、SGD、MYR、USDなどの残高を表示
リアルタイムデータ - 最新の残高情報を取得
振込可能金額 - 銀行口座に振込可能な金額を確認

残高の仕組み

残高タイプ

Omiseアカウントには3種類の残高があります:

総残高 - アカウント内のすべての資金（利用可能 + 保留中）
利用可能残高 - 即座に振込可能な資金
振込可能残高 - 銀行口座に振込可能な資金

残高が更新されるタイミング

残高は以下の場合に更新されます:

✅ 課金が正常に完了した
✅ 返金が処理された
✅ 振込が作成された
✅ 手数料が差し引かれた
✅ 異議申し立てが勝訴または敗訴した
✅ チャージバックが処理された

決済期間

決済方法によって決済期間が異なります:

クレジットカード: 通常2-3営業日
PromptPay: 即時
モバイルバンキング: 1-2営業日
分割払い: 分割スケジュールに従う

ユースケース

キャッシュフローの監視

振込を開始する前に、十分な資金があることを確認するために利用可能残高を確認します。

複数通貨の管理

複数の通貨で決済を受け付けている場合、異なる通貨の残高を表示します。

照合

会計目的でAPI残高と銀行明細書およびダッシュボードを比較します。

自動振込

自動振込スケジュールを作成する前に振込可能残高を確認します。

残高オブジェクトの構造

{
  "object": "balance",
  "livemode": true,
  "available": 1250000,
  "total": 1500000,
  "currency": "thb",
  "transferable": 1200000,
  "reserve": {
    "amount": 50000,
    "percentage": 10.0
  }
}

ベストプラクティス

すべきこと

振込前に確認 - 振込を作成する前に利用可能残高を確認
定期的に監視 - 自動残高監視を設定
複数通貨を処理 - 異なる通貨残高を考慮
適切にキャッシュ - 残高データは1-5分キャッシュ可能
Webhookを使用 - charge.completeとtransfer.createイベントをリッスン

すべきでないこと

過度なポーリングをしない - 1分間に1回以上の残高確認を避ける
即座の利用可能性を想定しない - 決済期間を考慮
リザーブを無視しない - アカウントのリザーブ要件を考慮
保留中の金額を忘れない - 合計には保留中の資金が含まれることを記憶

参照

お困りですか？ support@omise.co にお問い合わせください

概要​

利用可能なエンドポイント​

できること​

残高の仕組み​

残高タイプ​

残高が更新されるタイミング​

決済期間​

ユースケース​

キャッシュフローの監視​

複数通貨の管理​

照合​

自動振込​

残高オブジェクトの構造​

ベストプラクティス​

すべきこと​

すべきでないこと​

関連リソース​

参照​

概要