API Reference — Increase

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!

The Physical Card object

{
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "cardholder": {
    "first_name": "Ian",
    "last_name": "Crease"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "id": "physical_card_ode8duyq5v2ynhjoharl",
  "idempotency_key": null,
  "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec",
  "shipment": {
    "address": {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "line2": "Unit 2",
      "line3": null,
      "name": "Ian Crease",
      "postal_code": "10045",
      "state": "NY"
    },
    "method": "usps",
    "schedule": "next_day",
    "status": "shipped",
    "tracking": {
      "number": "9400110200881234567890",
      "return_number": null,
      "return_reason": null,
      "shipped_at": "2020-01-31T23:59:59Z",
      "updates": [
        {
          "carrier_estimated_delivery_at": null,
          "category": "delivered",
          "city": null,
          "created_at": "2020-01-31T23:59:59Z",
          "postal_code": "10001",
          "state": null
        }
      ]
    }
  },
  "status": "active",
  "type": "physical_card"
}

Attributes

card_id

string

The identifier for the Card this Physical Card represents.

cardholder

dictionary

Details about the cardholder, as it appears on the printed card.

created_at

string

The ISO 8601 date and time at which the Physical Card was created.

string

The physical card identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

physical_card_profile_id

string

Nullable

The Physical Card Profile used for this Physical Card.

shipment

dictionary

The details used to ship this physical card.

status

enum

The status of the Physical Card.

type

string

A constant representing the object's type. For this resource it will always be physical_card.

List Physical Cards

curl \
  --url "${INCREASE_URL}/physical_cards?card_id=card_oubs0hwk5rn6knuecxg2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_id

string

Filter Physical Cards to ones belonging to the specified Card.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

Create a Physical Card

curl -X "POST" \
  --url "${INCREASE_URL}/physical_cards" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "card_id": "card_oubs0hwk5rn6knuecxg2",
    "cardholder": {
      "first_name": "Ian",
      "last_name": "Crease"
    },
    "shipment": {
      "address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "line2": "Unit 2",
        "name": "Ian Crease",
        "postal_code": "10045",
        "state": "NY"
      },
      "method": "usps"
    }
  }'

Parameters

card_id

string

Required

The underlying card representing this physical card.

cardholder

dictionary

Required

Details about the cardholder, as it will appear on the physical card.

physical_card_profile_id

string

The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.

shipment

dictionary

Required

The details used to ship this physical card.

Retrieve a Physical Card

curl \
  --url "${INCREASE_URL}/physical_cards/physical_card_ode8duyq5v2ynhjoharl" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

physical_card_id

string

Required

The identifier of the Physical Card.

Update a Physical Card

curl -X "PATCH" \
  --url "${INCREASE_URL}/physical_cards/physical_card_ode8duyq5v2ynhjoharl" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "disabled"
  }'

Parameters

physical_card_id

string

Required

The Physical Card identifier.

status

enum

Required

The status to update the Physical Card to.

Sandbox: Advance the shipment status of a Physical Card

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.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/physical_cards/physical_card_ode8duyq5v2ynhjoharl/advance_shipment" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "shipment_status": "shipped"
  }'

Parameters

physical_card_id

string

Required

The Physical Card you would like to action.

shipment_status

enum

Required

The shipment status to move the Physical Card to.

Sandbox: Create a Physical Card Shipment Tracking Update

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

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/physical_cards/physical_card_ode8duyq5v2ynhjoharl/tracking_updates" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "category": "delivered",
    "city": "New York",
    "postal_code": "10045",
    "state": "NY"
  }'

Parameters

physical_card_id

string

Required

The Physical Card you would like to action.

carrier_estimated_delivery_at

string

The ISO 8601 date and time when the carrier expects the card to be delivered.