v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Physical Cards

get/physical_cards

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

card_idstring

Filter Physical Cards to ones belonging to the specified Card.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

idempotency_keystring

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.

Response

Physical Card List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}