View Source Stripe.Issuing.Token (stripity_stripe v3.2.0)

An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens through Stripe.

Summary

Types

created()

t()

The issuing.token type.

Functions

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

Lists all Issuing Token objects for a given card.

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

Retrieves an Issuing Token object.

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

Attempts to update the specified Issuing Token object to the status specified.

Types

created()

@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}

t()

@type t() :: %Stripe.Issuing.Token{
  card: binary() | Stripe.Issuing.Card.t(),
  created: integer(),
  device_fingerprint: binary() | nil,
  id: binary(),
  last4: binary(),
  livemode: boolean(),
  network: binary(),
  network_data: term(),
  network_updated_at: integer(),
  object: binary(),
  status: binary(),
  wallet_provider: binary()
}

The issuing.token type.

card Card associated with this token.
created Time at which the object was created. Measured in seconds since the Unix epoch.
device_fingerprint The hashed ID derived from the device ID from the card network associated with the token
id Unique identifier for the object.
last4 The last four digits of the token.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
network The token service provider / card network associated with the token.
network_data
network_updated_at Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
object String representing the object's type. Objects of the same type share the same value.
status The usage state of the token.
wallet_provider The digital wallet for this token, if one was used.

Functions

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

@spec list(
  params :: %{
    optional(:card) => binary(),
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:status) => :active | :deleted | :requested | :suspended
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Lists all Issuing Token objects for a given card.

Details

Method: get
Path: /v1/issuing/tokens

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

@spec retrieve(
  token :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves an Issuing Token object.

Details

Method: get
Path: /v1/issuing/tokens/{token}

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

@spec update(
  token :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:status) => :active | :deleted | :suspended
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Attempts to update the specified Issuing Token object to the status specified.

Details

Method: post
Path: /v1/issuing/tokens/{token}