Teya.POSLink.Store (teya v0.4.0)

Copy Markdown View Source

POSLink store and terminal discovery.

Use these endpoints during ePOS registration to identify which store_id and terminal_id to use when creating payment requests.

Required OAuth scopes: poslink/stores/get, poslink/stores/id/terminals/get.

Summary

Functions

Lists all stores associated with the merchant account.

Lists terminals belonging to a store.

Functions

list(opts \\ [])

@spec list(keyword()) :: {:ok, map()} | {:error, Teya.Error.t()}

Lists all stores associated with the merchant account.

Returns {:ok, response} where the body contains a list of store objects, each including store_id, name, and address details.

Options

  • :params — query parameters for filtering (implementation-defined by the API)

Examples

{:ok, %{"stores" => stores}} = Teya.POSLink.Store.list()

list_terminals(store_id, opts \\ [])

@spec list_terminals(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Teya.Error.t()}

Lists terminals belonging to a store.

Returns {:ok, response} where the body contains a list of terminal objects, each including terminal_id, serial_number, and connectivity status.

Parameters

  • store_id — UUID of the store

Examples

{:ok, %{"terminals" => terminals}} = Teya.POSLink.Store.list_terminals(store_id)