v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Cards

get/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.

account_idstring

Filter Cards to ones belonging to the specified Account.

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.

status.instring[]

Filter Cards by status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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

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": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "authorization_controls": {
        "merchant_acceptor_identifier": null,
        "merchant_category_code": {
          "allowed": null,
          "blocked": [
            {
              "code": "5734"
            }
          ]
        },
        "merchant_country": null,
        "usage": {
          "category": "multi_use",
          "multi_use": {
            "spending_limits": [
              {
                "interval": "per_month",
                "merchant_category_codes": null,
                "settlement_amount": 100000
              }
            ]
          },
          "single_use": null
        }
      },
      "billing_address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "line2": null,
        "postal_code": "10045",
        "state": "NY"
      },
      "bin": "42424242",
      "cardholder_name": {
        "first": "Ian",
        "last": "Crease",
        "middle": null
      },
      "created_at": "2020-01-31T23:59:59Z",
      "description": "Office Expenses",
      "digital_wallet": {
        "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga",
        "email": "user@example.com",
        "phone": "+16505046304"
      },
      "entity_id": null,
      "expiration_month": 11,
      "expiration_year": 2028,
      "id": "card_oubs0hwk5rn6knuecxg2",
      "idempotency_key": null,
      "last4": "4242",
      "status": "active",
      "type": "card"
    }
  ],
  "next_cursor": "v57w5d"
}