Ramp.Merchants (ramp v1.0.0)

The Merchants resource: read-only access to card-network merchants where Ramp transactions occur.

Summary

list_opt()

get(client, id)

Fetches a single merchant by ID.

Returns a lazily auto-paginating Stream of Ramp.Merchants.Merchants.

Fetches a single page of merchants. See Ramp.Page.

@type list_opt() ::
  {:start, String.t()} | {:page_size, pos_integer()} | {:name, String.t()}

@spec get(Ramp.Client.t(), String.t()) ::
  {:ok, Ramp.Merchants.Merchant.t()} | {:error, Ramp.Error.t()}

Fetches a single merchant by ID.

@spec list(Ramp.Client.t(), [list_opt()]) :: Enumerable.t(Ramp.Merchants.Merchant.t())

Returns a lazily auto-paginating Stream of Ramp.Merchants.Merchants.

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.Merchants.Merchant.t())} | {:error, Ramp.Error.t()}

Fetches a single page of merchants. See Ramp.Page.