Balance

Retrieve Balance

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Balance

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/balance"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BalanceApi;

import java.io.File;
import java.util.*;

public class BalanceApiExample {

    public static void main(String[] args) {
        
        BalanceApi apiInstance = new BalanceApi();
        try {
            balance result = apiInstance.balanceGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalanceApi#balanceGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BalanceApi;

public class BalanceApiExample {

    public static void main(String[] args) {
        BalanceApi apiInstance = new BalanceApi();
        try {
            balance result = apiInstance.balanceGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BalanceApi#balanceGet");
            e.printStackTrace();
        }
    }
}

BalanceApi *apiInstance = [[BalanceApi alloc] init];

[apiInstance balanceGetWithCompletionHandler: 
              ^(balance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.BalanceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.balanceGet(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class balanceGetExample
    {
        public void main()
        {

            var apiInstance = new BalanceApi();

            try
            {
                balance result = apiInstance.balanceGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BalanceApi.balanceGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBalanceApi();

try {
    $result = $api_instance->balanceGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BalanceApi->balanceGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BalanceApi;

my $api_instance = WWW::SwaggerClient::BalanceApi->new();

eval { 
    my $result = $api_instance->balanceGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BalanceApi->balanceGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BalanceApi()

try: 
    api_response = api_instance.balance_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->balanceGet: %s\n" % e)

Responses

Status: 200

 {
  "object": {
    "pattern": "balance",
    "type": "string",
    "default": "balance"
  },
  "livemode": {
    "type": "boolean",
    "enum": [
      true,
      false
    ]
  },
  "location": {
    "type": "string"
  },
  "currency": {
    "type": "string",
    "format": "currency"
  },
  "total": {
    "type": "integer"
  },
  "transferable": {
    "type": "integer"
  },
  "reserve": {
    "type": "integer"
  },
  "on_hold": {
    "type": "integer"
  },
  "created_at": {
    "type": "string",
    "format": "date-time"
  },
  "at": {
    "type": "string",
    "format": "date-time"
  }
}