---
title: "ListCards"
method: GET
path: "/v2/cards"
tags: ["Cards"]
---

# ListCards

`GET /v2/cards`

Retrieves a list of cards owned by the account making the request.
A max of 25 cards will be returned.

## Query parameters

- `cursor` string
- `customer_id` string
- `include_disabled` boolean
- `reference_id` string
- `sort_order` string

## Response `200`

Success

- ListCardsResponse — Defines the fields that are included in the response body of a request to the [ListCards](#endpoint-cards-listcards) endpoint. Note: if there are errors processing the request, the card field will not be present.
  - `cards` Card[] — The requested list of `Card`s.
    - `billing_address` Address — Represents a postal address in a country. The address format is based on an [open-source library from Google](https://github.com/google/libaddressinput). For more information, see [AddressValidationMetadata](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata). This format has dedicated fields for four address components: postal code, locality (city), administrative district (state, prefecture, or province), and sublocality (town or village). These components have dedicated fields in the `Address` object because software sometimes behaves differently based on them. For example, sales tax software may charge different amounts of sales tax based on the postal code, and some software is only available in certain states due to compliance reasons. For the remaining address components, the `Address` type provides the `address_line_1` and `address_line_2` fields for free-form data entry. These fields are free-form because the remaining address components have too many variations around the world and typical software does not parse these components. These fields enable users to enter anything they want. Note that, in the current implementation, all other `Address` type fields are blank. These include `address_line_3`, `sublocality_2`, `sublocality_3`, `administrative_district_level_2`, `administrative_district_level_3`, `first_name`, `last_name`, and `organization`. When it comes to localization, the seller's language preferences (see [Language preferences](https://developer.squareup.com/docs/locations-api#location-specific-and-seller-level-language-preferences)) are ignored for addresses. Even though Square products (such as Square Point of Sale and the Seller Dashboard) mostly use a seller's language preference in communication, when it comes to addresses, they will use English for a US address, Japanese for an address in Japan, and so on.
      - `address_line_1` string — The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).
      - `address_line_2` string — The second line of the address, if any.
      - `address_line_3` string — The third line of the address, if any.
      - `administrative_district_level_1` string — A civil entity within the address's country. In the US, this is the state.
      - `administrative_district_level_2` string — A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.
      - `administrative_district_level_3` string — A civil entity within the address's `administrative_district_level_2`, if any.
      - `country` string — The address's country, in ISO 3166-1-alpha-2 format.
      - `first_name` string — Optional first name when it's representing recipient.
      - `last_name` string — Optional last name when it's representing recipient.
      - `locality` string — The city or town of the address.
      - `organization` string — Optional organization name when it's representing recipient.
      - `postal_code` string — The address's postal code.
      - `sublocality` string — A civil region within the address's `locality`, if any.
      - `sublocality_2` string — A civil region within the address's `sublocality`, if any.
      - `sublocality_3` string — A civil region within the address's `sublocality_2`, if any.
    - `bin` string — The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
    - `card_brand` string — The card's brand.
    - `card_type` string — The type of the card. The Card object includes this field only in response to Payments API calls.
    - `cardholder_name` string — The name of the cardholder.
    - `customer_id` string — The ID of a customer created using the Customers API to be associated with the card.
    - `enabled` boolean — Indicates whether or not a card can be used for payments.
    - `exp_month` integer — The expiration month of the associated card as an integer between 1 and 12.
    - `exp_year` integer — The four-digit year of the card's expiration date.
    - `fingerprint` string — __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
    - `id` string — Unique ID for this card. Generated by Square.
    - `last_4` string — The last 4 digits of the card number.
    - `prepaid_type` string — Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls.
    - `reference_id` string — An optional user-defined reference ID that associates this card with another entity in an external system. For example, a customer ID from an external customer management system.
    - `version` integer — Current version number of the card. Increments with each card update. Requests to update an existing Card object will be rejected unless the version in the request matches the current version for the Card.
  - `cursor` string — The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
  - `errors` Error[] — Information on errors encountered during the request.
    - `category` string, required — The high-level category for the error.
    - `code` string, required — The specific code of the error.
    - `detail` string — A human-readable description of the error for debugging purposes.
    - `field` string — The name of the field provided in the original request (if any) that the error pertains to.

---

[API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/revisions/8d95e3639487/schema)