Moov.TerminalApplications (Moov v1.0.0)

Copy Markdown View Source

Register and manage terminal applications, required for Tap to Pay on iPhone/Android.

See https://docs.moov.io/api/sources/terminal-applications/.

Summary

Functions

Creates a terminal application.

Registers a new version of a terminal application.

Deletes a terminal application.

Retrieves a terminal application.

Gets the configuration a linked terminal application should use.

Retrieves a terminal application as linked to a specific merchant account.

Links a terminal application to a merchant account so it can accept Tap to Pay.

Lists terminal applications.

Lists terminal applications linked to a merchant account.

Functions

create(client, params)

@spec create(Moov.Client.t(), map()) :: {:ok, map()} | {:error, Moov.Error.t()}

Creates a terminal application.

params includes :platform ("ios"/"android") and bundle/package identifiers.

create_version(client, terminal_application_id, params)

@spec create_version(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Registers a new version of a terminal application.

delete(client, terminal_application_id)

@spec delete(Moov.Client.t(), String.t()) :: {:ok, term()} | {:error, Moov.Error.t()}

Deletes a terminal application.

get(client, terminal_application_id)

@spec get(Moov.Client.t(), String.t()) :: {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a terminal application.

get_configuration(client, account_id, terminal_application_id)

@spec get_configuration(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Gets the configuration a linked terminal application should use.

get_linked(client, account_id, terminal_application_id)

@spec get_linked(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a terminal application as linked to a specific merchant account.

link(client, account_id, params)

@spec link(Moov.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Links a terminal application to a merchant account so it can accept Tap to Pay.

list(client, opts \\ [])

@spec list(
  Moov.Client.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Moov.Error.t()}

Lists terminal applications.

list_linked(client, account_id, opts \\ [])

@spec list_linked(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists terminal applications linked to a merchant account.