残高の取得

GEThttps://api.omise.co/balance

アカウントの現在の残高情報を取得します。合計残高、譲渡可能金額、およびアカウントの主要通貨での準備金額が表示されます。

---

🔑API認証情報

▼

---

リクエストパラメータ

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

---

レスポンス

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ヘッダーがない
• 無効なsecret key
• secret keyの代わりにpublic keyを使用している
• HTTP Basic Auth形式が正しくない

---

Code samples

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()

---

Try it out