Retrieve balance

GEThttps://api.omise.co/balance

Retrieves the current balance information for your account. Shows total balance, transferable amount, and reserve amounts in the account's primary currency.

Request Parameters

No parameters required for this endpoint.

---

Responses

200

Successful request

Returns the balance object with current account balance information.

Balance object contains:

• object - String value "balance"
• livemode - Boolean indicating live or test mode
• location - API endpoint path "/balance"
• currency - Three-letter ISO 4217 currency code
• total - Total balance after deducted fees (in smallest currency unit)
• transferable - Amount available for transfer to bank accounts
• reserve - Amount reserved (not yet available)
• on_hold - Amount currently on hold
• created_at - ISO 8601 timestamp

Note on amounts:

• All amounts in smallest currency unit (satangs for THB, cents for USD, yen for JPY)
• Total = Transferable + Reserve + On Hold
• Transferable amount can be used for creating transfers

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

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

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...