Increase.CardTokens (Increase v1.0.0)

Copy Markdown View Source

Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.

See https://increase.com/documentation/api/card-tokens for the full API reference for this resource.

Summary

Functions

The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range.

Functions

capabilities(client, card_token_id, opts \\ [])

@spec capabilities(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardTokens.CardTokenCapabilities.t()}
  | {:error, Increase.Error.t()}

The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range.

GET /card_tokens/{card_token_id}/capabilities

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

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Card Tokens

Returns a %Increase.Page{} whose data is a list of %__MODULE__. CardToken{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /card_tokens

retrieve(client, card_token_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardTokens.CardToken.t()} | {:error, Increase.Error.t()}

Retrieve a Card Token

GET /card_tokens/{card_token_id}