Increase.Simulations.PhysicalCards (Increase v1.0.0)

Copy Markdown View Source

Sandbox-only simulations related to Physical Card.

These endpoints only work against the sandbox environment and let you fast-forward events that would otherwise take hours or days in production (settlement, acknowledgement, returns, and so on). See https://increase.com/documentation/api/overview#sandbox for details.

Summary

Functions

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

This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.

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

This endpoint allows you to simulate receiving a tracking update for a Physical Card, to simulate the progress of a shipment.

Functions

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

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

This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.

POST /simulations/physical_cards/{physical_card_id}/advance_shipment

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

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

This endpoint allows you to simulate receiving a tracking update for a Physical Card, to simulate the progress of a shipment.

POST /simulations/physical_cards/{physical_card_id}/tracking_updates