omise v0.4.2 Omise.Balance

Provides Balance API interfaces.

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

Summary

Functions

Retrieve the balance

Types

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

Functions

retrieve(opts \\ [])
retrieve(Keyword.t) :: {:ok, t} | {:error, Omise.Error.t}

Retrieve the balance.

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

Examples

Omise.Balance.retrieve

Omise.Balance.retrieve(key: "skey_56ia27lqtvg32u7iww8")