Increase.PhysicalCards (Increase v1.0.0)

Copy Markdown View Source

Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile]. The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact support@increase.com for pricing!

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

Summary

Functions

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

Create a Physical Card

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

List Physical Cards

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

Retrieve a Physical Card

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

Update a Physical Card

Functions

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.PhysicalCards.PhysicalCard.t()} | {:error, Increase.Error.t()}

Create a Physical Card

POST /physical_cards

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

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

List Physical Cards

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

GET /physical_cards

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

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

Retrieve a Physical Card

GET /physical_cards/{physical_card_id}

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

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.PhysicalCards.PhysicalCard.t()} | {:error, Increase.Error.t()}

Update a Physical Card

PATCH /physical_cards/{physical_card_id}