残高を取得

GEThttps://api.omise.co/balance

アカウントの現在の残高情報を取得します。アカウントの主要通貨での合計残高、振込可能金額、リザーブ金額を表示します。

---

リクエストパラメータ

このエンドポイントにはパラメータは必要ありません。

---

レスポンス

200

リクエスト成功

現在のアカウント残高情報を含む残高オブジェクトを返します。

残高オブジェクトには以下が含まれます:

• object - 文字列値「balance」
• livemode - 本番モードかテストモードかを示すブール値
• location - APIエンドポイントパス「/balance」
• currency - ISO 4217の3文字の通貨コード
• total - 手数料控除後の合計残高（最小通貨単位）
• transferable - 銀行口座への振込に利用可能な金額
• reserve - 予約された金額（まだ利用不可）
• on_hold - 現在保留中の金額
• created_at - ISO 8601タイムスタンプ

金額に関する注意:

• すべての金額は最小通貨単位（THBはサタン、USDはセント、JPYは円）
• 合計 = 振込可能 + リザーブ + 保留中
• 振込可能金額は振込の作成に使用できます

401

認証失敗

認証に失敗しました。無効または欠落したAPIキー。

一般的な原因:

• Authorizationヘッダーがない
• 無効な秘密キー
• 秘密キーの代わりに公開キーを使用
• 不正なHTTP Basic Auth形式

5xx

サーバーエラー

サーバーサイドエラーが発生しました。これらはまれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/balance \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

balance = Omise::Balance.retrieve

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

balance = omise.Balance.retrieve()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const balance = await omise.balance.retrieve();

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$balance = OmiseBalance::retrieve();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Balance balance = client.balance().get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var balance = await client.Balance.Get();

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

balance, _ := client.Balance().Get()

---

🔑API認証情報

▼

試してみる

あなたのIP: ...読み込み中...