Current section

Files

Jump to
omise lib omise balances.ex
Raw

lib/omise/balances.ex

defmodule Omise.Balances do
@moduledoc """
Provides Balance API interfaces.
https://www.omise.co/balance-api
"""
@endpoint "balance"
@doc """
Retrieve the balance.
Returns `{:ok, balance}` if the request is successful, `{:error, error}` otherwise.
## Examples
{:ok, balance} = Omise.Balances.retrieve
"""
@spec retrieve :: {:ok, Map.t} | {:error, Map.t}
def retrieve do
Omise.make_request(:get, @endpoint)
end
end