Balance（残高）

Balance（残高）APIは、ご利用のOpn Paymentsアカウントで利用可能な残高情報を取得するためのAPIです。

Attributes

Name	Type	Description
object	string	固定値`balance`。
livemode	boolean	本番モード(`true`)あるいはテストモード(`false`)口座か。
location	string	現在の`balance`オブジェクトを取得するためのAPIパス。
at	string	特定の時点でのアカウントの残高です。たとえば、残高が1000で、`at` フィールドが12PMの場合、12PMでの残高が1000であることを示しています。
created_at	string	ISO 8601 形式 (`YYYY-MM-DDThh:mm:ssZ`)で口座が作成されたUTC日時。
currency	string	3文字のISO 4217コードで示される通貨残高。
reserve	integer	[reserved]（保管）(/what-is-the-reserve-balance)されている資金 (注:リザーブ機能を有効にする必要があります)
total	integer	控除後の手数料の合計残高。
transferable	integer	振込可能金額。

Example

JSON Response

{
  "object": "balance",
  "livemode": false,
  "location": "/balance",
  "currency": "THB",
  "total": 0,
  "transferable": 0,
  "reserve": 0,
  "created_at": "2019-12-31T12:59:59Z"
}

残高情報の取得

- GET https://api.omise.co/balance

APIキーに関連するOmiseアカウントの残高オブジェクトを返します。

Example

残高情報の取得

curl
php
node.js
ruby
C#
java
python
go
elixir

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

<?php
$balance = OmiseBalance::retrieve();
// After retrieving it, the balance can be refreshed:
$balance->reload();

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

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

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

balance = Omise::Balance.retrieve

# After retrieving it, the balance can be refreshed:
balance.reload

var balance = await Client.Balance.Get();
Console.WriteLine($"available balance: {balance.Available}");
Console.WriteLine($"total balance: {balance.Total}");

Request<Balance> request = new Balance.GetRequestBuilder().build();
Balance balance = client().sendRequest(request);

System.out.printf("Transferable balance: %d", balance.getTransferable());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

balance = omise.Balance.retrieve()
balance.total

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Balance{}
err := client.Do(result, &operations.RetrieveBalance{})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Balance.retrieve