Create a Physical Card

Changed on

Physical Cards start in the status disabled. Activate the card once it arrives at the destination and the recipient confirms receipt.

post/physical_cards

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/physical_cards
  • Auth
    HTTP bearer

Request body

card_idstring required

The underlying card representing this physical card.

physical_card_profile_idstring

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

Example request

{
  "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"
  }
}

Response

Physical Card

account_idstring required

The identifier for the Account this Physical Card belongs to.

card_idstring required

The identifier for the Card this Physical Card represents.

created_atstring date-time required

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

expiration_monthinteger required

The month printed on the Physical Card as its expiration, in M format (e.g., August is 8). This stays the same when the Card is renewed.

expiration_yearinteger required

The year printed on the Physical Card as its expiration, in YYYY format (e.g., 2025). This stays the same when the Card is renewed.

idstring required

The physical card identifier.

idempotency_keystring nullable required

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_idstring nullable required

The Physical Card Profile used for this Physical Card.

status'active' | 'disabled' | 'canceled' required

The status of the Physical Card. The initial status is disabled.

type'physical_card' required

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

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "cardholder": {
    "first_name": "Ian",
    "last_name": "Crease"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "expiration_month": 11,
  "expiration_year": 2028,
  "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",
      "phone_number": null,
      "postal_code": "10045",
      "state": "NY"
    },
    "method": "usps",
    "schedule": "next_day",
    "status": "shipped",
    "tracking": {
      "number": null,
      "return_number": null,
      "return_reason": null,
      "shipped_at": "2020-01-31T23:59:59Z",
      "updates": [
        {
          "carrier_estimated_delivery_at": null,
          "category": "in_transit",
          "city": null,
          "created_at": "2020-01-31T23:59:59Z",
          "postal_code": "10001",
          "state": null
        }
      ]
    }
  },
  "status": "active",
  "type": "physical_card"
}

Changes

  • d410a6abb15dRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 238a042d03cdRevision changes
    • info

      added the required property // to the response with the status