omise v0.3.0 Omise.Balance

Provides Balance API interfaces.

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

Summary

Types

t()

Functions

retrieve()

Retrieve the balance

Types

t :: %Omise.Balance{available: Integer.t, currency: String.t, livemode: boolean, location: String.t, object: String.t, total: Integer.t}

Functions

retrieve()

Specs

retrieve ::
  {:ok, Omise.Balance.t} |
  {:error, Omise.Error.t}

Retrieve the balance.

Returns {:ok, balance} if the request is successful, {:error, error} otherwise.

Examples

Omise.Balance.retrieve