omise
v0.10.0

Omise.Balance (omise v0.10.0)

Provides Balance API interfaces.

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

Summary

Types

t()

Functions

retrieve(opts \\ [])

Retrieve the balance.

Types

Link to this type

t()

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

Functions

Link to this function

retrieve(opts \\ [])

@spec 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")