Marqeta.DigitalWalletsManagement (marqeta v1.0.0)

Copy Markdown View Source

Manage digital wallet token provisioning and lifecycle. Supports Apple Pay, Google Pay, and Samsung Pay.

Token States

REQUESTED, ACTIVE, SUSPENDED, TERMINATED

Provisioning Sources

MOBILE_BANKING_APP, WEB, CUSTOMER_SERVICE, ISSUER, TOKEN_SERVICE_PROVIDER

Summary

Functions

Retrieves a digital wallet token by token.

Retrieves a digital wallet token by token. Raises Marqeta.Error on failure.

Retrieves a specific digital wallet token transition.

Lists digital wallet token resources.

Lists digital wallet token resources. Raises Marqeta.Error on failure.

Lists digital wallet tokens for a card.

Lists digital wallet tokens for a user.

Lists all transitions for a digital wallet token.

Provides a provisioning decision for a digital wallet token request.

Returns a lazy Stream that auto-paginates digital wallet token resources.

Transitions a digital wallet token to a new state.

Updates an existing digital wallet token.

Updates an existing digital wallet token. Raises Marqeta.Error on failure.

Functions

get(token, opts \\ [])

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

Retrieves a digital wallet token by token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

get!(token, opts \\ [])

@spec get!(
  String.t(),
  keyword()
) :: map()

Retrieves a digital wallet token by token. Raises Marqeta.Error on failure.

get_transition(token, opts \\ [])

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

Retrieves a specific digital wallet token transition.

list(params \\ %{}, opts \\ [])

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

Lists digital wallet token resources.

Accepts standard Marqeta pagination params: count, start_index, sort_by, sort_order, fields.

Use stream/2 to lazily iterate all pages automatically.

list!(params \\ %{}, opts \\ [])

@spec list!(
  map(),
  keyword()
) :: map()

Lists digital wallet token resources. Raises Marqeta.Error on failure.

list_by_card(card_token, params \\ %{}, opts \\ [])

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

Lists digital wallet tokens for a card.

list_by_user(user_token, params \\ %{}, opts \\ [])

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

Lists digital wallet tokens for a user.

list_transitions(token, params \\ %{}, opts \\ [])

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

Lists all transitions for a digital wallet token.

provision_decision(params, opts \\ [])

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

Provides a provisioning decision for a digital wallet token request.

stream(params \\ %{}, opts \\ [])

@spec stream(
  map(),
  keyword()
) :: Enumerable.t()

Returns a lazy Stream that auto-paginates digital wallet token resources.

transition(params, opts \\ [])

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

Transitions a digital wallet token to a new state.

update(token, params, opts \\ [])

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

Updates an existing digital wallet token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

update!(token, params, opts \\ [])

@spec update!(String.t(), map(), keyword()) :: map()

Updates an existing digital wallet token. Raises Marqeta.Error on failure.