exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Bitcoin (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_bitcoin_receivers_id_opts()
get_bitcoin_receivers_opts()
get_bitcoin_receivers_receiver_transactions_opts()
get_bitcoin_transactions_opts()

Functions

get_bitcoin_receivers(client, opts \\ [])

description: <p>Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.</p>

get_bitcoin_receivers_id(client, id, opts \\ [])

description: <p>Retrieves the Bitcoin receiver with the given ID.</p>

get_bitcoin_receivers_receiver_transactions(client, receiver, opts \\ [])

description: <p>List bitcoin transacitons for a given receiver.</p>

get_bitcoin_transactions(client, opts \\ [])

description: <p>List bitcoin transacitons for a given receiver.</p>

Link to this section Types

Link to this type

get_bitcoin_receivers_id_opts()

View Source 
@type get_bitcoin_receivers_id_opts() :: {:expand, String.t()}
Link to this type

get_bitcoin_receivers_opts()

View Source 
@type get_bitcoin_receivers_opts() ::
  {:uncaptured_funds, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:filled, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:active, String.t()}
Link to this type

get_bitcoin_receivers_receiver_transactions_opts()

View Source 
@type get_bitcoin_receivers_receiver_transactions_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:customer, String.t()}
Link to this type

get_bitcoin_transactions_opts()

View Source 
@type get_bitcoin_transactions_opts() ::
  {:starting_after, String.t()}
  | {:receiver, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:customer, String.t()}

Link to this section Functions

Link to this function

get_bitcoin_receivers(client, opts \\ [])

View Source 
@spec get_bitcoin_receivers(client :: ExOAPI.Client.t(), [
  get_bitcoin_receivers_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.BitcoinReceiver.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.</p>

deprecated: true

Link to this function

get_bitcoin_receivers_id(client, id, opts \\ [])

View Source 
@spec get_bitcoin_receivers_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_bitcoin_receivers_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.BitcoinReceiver.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the Bitcoin receiver with the given ID.</p>

deprecated: true

Link to this function

get_bitcoin_receivers_receiver_transactions(client, receiver, opts \\ [])

View Source 
@spec get_bitcoin_receivers_receiver_transactions(
  client :: ExOAPI.Client.t(),
  receiver :: String.t(),
  [get_bitcoin_receivers_receiver_transactions_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.BitcoinTransaction.t()]
     }
   | map()}
  | {:error, any()}

description: <p>List bitcoin transacitons for a given receiver.</p>

deprecated: true

Link to this function

get_bitcoin_transactions(client, opts \\ [])

View Source 
@spec get_bitcoin_transactions(client :: ExOAPI.Client.t(), [
  get_bitcoin_transactions_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.BitcoinTransaction.t()]
     }
   | map()}
  | {:error, any()}

description: <p>List bitcoin transacitons for a given receiver.</p>

deprecated: true