Omise.Balance (omise v0.9.0)

Provides Balance API interfaces.

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

Link to this section Summary

Types

t()

Functions

retrieve(opts \\ [])

Retrieve the balance.

Link to this section Types

t()

Specs

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

Link to this section Functions

retrieve(opts \\ [])

Specs

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