List cards for user - Marqeta Docs

GET///

Retrieves a list of the cards associated with a specific user. This endpoint supports field filtering, pagination, and object expansion.

URL path parameters

Fields	Description
token string Required	Unique identifier of the user whose cards you want to list. Send a `GET` request to `/users` to retrieve user tokens. Allowable Values: Existing user token

URL query parameters

Fields	Description
count integer Optional	Number of resources to retrieve. Allowable Values: 1-10 Default value: 5
start_index integer Optional	Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0
fields string Optional	Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. Allowable Values: Comma-delimited list of fields, or blank
sort_by string Optional	Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`, or any field in the resource model Default value: `-lastModifiedTime`

Response body

Fields	Description
count integer Conditionally returned	The number of resources retrieved. This field is returned if there are resources in your returned array. Allowable Values: 1-10
data array of objects Conditionally returned	Array of card objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more card objects
data[].activation_actions object Conditionally returned	Defines actions to execute when the card is activated. The fields in this object are mutually exclusive. Allowable Values: `swap_digital_wallet_tokens_from_card_token`, `terminate_reissued_source_card`
data[].activation_actions.swap_digital_wallet_tokens_from_card_token string Conditionally returned	Moves all digital wallet tokens from the specified card to the new card. Not relevant when `reissue_pan_from_card_token` is set. Send a `GET` request to `/cards/user/{token}` to retrieve card tokens for a particular user. Allowable Values: 1–36 chars Existing card token
data[].activation_actions.terminate_reissued_source_card boolean Conditionally returned	If you are reissuing a card, the source card is terminated by default. To prevent the source card from being terminated, set this field to `false`. Only relevant when `reissue_pan_from_card_token` is set. Allowable Values: `true`, `false` Default value: `true`
data[].barcode string Returned	Barcode printed on the card, expressed as numerals. Allowable Values: 10-20 chars
data[].bulk_issuance_token string Conditionally returned	Unique identifier of the bulk card order. Allowable Values: 1-36 chars
data[].card_product_token string Returned	Unique identifier of the card product. Allowable Values: 1-36 chars
data[].chip_cvv_number string Conditionally returned	Three-digit card verification value (ICVV) stored on the chip of the card. Allowable Values: 3 chars
data[].contactless_exemption_counter integer Conditionally returned	Running count of the contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the number of contactless transactions that can be performed without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see Card Products. Allowable Values: Any integer
data[].contactless_exemption_total_amount decimal Conditionally returned	Running total of the money spent in contactless transactions successfully completed since the last strong customer authentication (SCA) challenge was issued. You can limit the total amount that can be spent in contactless transactions without issuing an SCA challenge at the card product level. For more information about strong customer authentication, see Card Products. Allowable Values: Any integer
data[].contactless_exemption_transaction_currency string Conditionally returned	Indicates the currency type of the transaction. Allowable Values: Valid three-character ISO 4217 currency code
data[].created_time datetime Returned	Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].cvv_number string Conditionally returned	Three-digit card verification value (CVV2 or CVC2) printed on the card. Allowable Values: 3 chars
data[].expedite boolean Conditionally returned	A value of `true` indicates that you requested expedited processing of the card from your card fulfillment provider. Allowable Values: `true`, `false`
data[].expiration string Returned	Expiration date in `MMyy` format. Allowable Values: Format: MMyy
data[].expiration_time datetime Returned	Expiration date and time, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].fulfillment object Conditionally returned	Determines physical characteristics of a card and shipment information. Allowable Values: `card_fulfillment_reason`, `card_personalization`, `shipping`
data[].fulfillment.card_fulfillment_reason string Conditionally returned	Descriptive reason for the card fulfillment. Allowable Values: `NEW`, `LOST_STOLEN`, `EXPIRED`
data[].fulfillment.card_personalization object Returned	Specifies personalized attributes to be added to the card. Allowable Values: `carrier`, `images`, `perso_type`, `text`
data[].fulfillment.card_personalization.carrier object Conditionally returned	Specifies attributes of the card carrier. Allowable Values: `logo_file`, `logo_thumbnail_file`, `message_file`, `message_line`, `template_id`
data[].fulfillment.card_personalization.carrier.logo_file string Conditionally returned	Specifies an image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.carrier.logo_thumbnail_file string Conditionally returned	Specifies a thumbnail-sized rendering of the image specified in the `logo_file` field. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.carrier.message_file string Conditionally returned	Specifies a text file containing a custom message to print on the card carrier. Allowable Values: Contains the name of the text file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.carrier.message_line string Conditionally returned	Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max
data[].fulfillment.card_personalization.carrier.message_line_2 string Conditionally returned	Specifies the second line of a custom message that appears on the card carrier. Allowable Values: 60 char max
data[].fulfillment.card_personalization.carrier.template_id string Conditionally returned	Specifies the card carrier template to use. Allowable Values: Card carrier template ID
data[].fulfillment.card_personalization.images object Conditionally returned	Specifies personalized images that appear on the card. Allowable Values: `card`, `carrier`, `carrier_return_window`, `signature`
data[].fulfillment.card_personalization.images.card object Conditionally returned	Specifies personalized images that appear on the card. Allowable Values: `name`, `thermal_color`
data[].fulfillment.card_personalization.images.card.name string Conditionally returned	Specifies a PNG image to display on the card. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.images.card.thermal_color string Conditionally returned	Specifies the color of the image displayed on the card. Allowable Values: Contains the name of the color and must match one of the provider’s predefined colors.
data[].fulfillment.card_personalization.images.carrier object Conditionally returned	Specifies personalized images that appear on the card carrier. Allowable Values: `message_1`, `name`
data[].fulfillment.card_personalization.images.carrier.message_1 string Conditionally returned	Specifies a custom message that appears on the card carrier. Allowable Values: 60 char max
data[].fulfillment.card_personalization.images.carrier.name string Conditionally returned	Specifies a PNG image to display on the card carrier. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.images.carrier_return_window object Conditionally returned	Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: `name`
data[].fulfillment.card_personalization.images.carrier_return_window.name string Conditionally returned	Specifies a PNG image to display in the return address window of envelopes used for sending cards to cardholders. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.images.signature object Conditionally returned	Specifies a PNG image of the cardholder’s signature. Allowable Values: `name`
data[].fulfillment.card_personalization.images.signature.name string Conditionally returned	Specifies a PNG image of the cardholder’s signature. Allowable Values: Contains the name of the image file and must match the name of the file you send to your fulfillment provider.
data[].fulfillment.card_personalization.perso_type string Conditionally returned	Specifies the type of card personalization. Allowable Values: `EMBOSS`, `LASER`, `FLAT`
data[].fulfillment.card_personalization.text object Returned	Specifies personalized text that appears on the card. Allowable Values: `name_line_1`, `name_line_2`, `name_line_3`
data[].fulfillment.card_personalization.text.name_line_1 object Returned	Specifies the first line of personalized text that appears on the card. Allowable Values: `name_line_1.value` 21 char max; if `name_line_1_numeric_postfix` is `true`, 14 char max. Strings longer than the character limit are truncated.
data[].fulfillment.card_personalization.text.name_line_1.value string Conditionally returned	Line of personalized text printed on the card. Allowable Values: 21 char max
data[].fulfillment.card_personalization.text.name_line_2 object Conditionally returned	Specifies the second line of personalized text that appears on the card. Allowable Values: `name_line_2.value`
data[].fulfillment.card_personalization.text.name_line_2.value string Conditionally returned	Line of personalized text printed on the card. Allowable Values: 21 char max
data[].fulfillment.card_personalization.text.name_line_3 object Conditionally returned	Specifies the third line of personalized text that appears on the card. Allowable Values: `name_line_3.value`
data[].fulfillment.card_personalization.text.name_line_3.value string Conditionally returned	Line of personalized text printed on the card. Allowable Values: 21 char max
data[].fulfillment.shipping object Conditionally returned	Specifies shipping details for the order. This object is returned if it exists in the resource. Allowable Values: `care_of_line`, `method`, `recipient_address`, `return_address`
data[].fulfillment.shipping.care_of_line string Conditionally returned	Specifies the value of the care of (C/O) line on the mailing carrier. This field is returned if it exists in the resource. Allowable Values: 255 char max
data[].fulfillment.shipping.method string Conditionally returned	Specifies the shipping service. This field is returned if it exists in the resource. Allowable Values: `LOCAL_MAIL`, `LOCAL_MAIL_PACKAGE`, `GROUND`, `TWO_DAY`, `OVERNIGHT`, `INTERNATIONAL`, `INTERNATIONAL_PRIORITY`, `LOCAL_PRIORITY`, `FEDEX_EXPEDITED`, `FEDEX_REGULAR`, `UPS_EXPEDITED`, `UPS_REGULAR`, `USPS_EXPEDITED`, `USPS_REGULAR`
data[].fulfillment.shipping.recipient_address object Conditionally returned	Address to which the order will be shipped. This field is returned if it exists in the resource. Allowable Values: Existing `recipient_address` object
data[].fulfillment.shipping.recipient_address.address1 string Conditionally returned	Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters.
data[].fulfillment.shipping.recipient_address.address2 string Conditionally returned	Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters.
data[].fulfillment.shipping.recipient_address.city string Conditionally returned	City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.recipient_address.country string Conditionally returned	Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name “Spain”. The ISO maintains the full list of country codes.
data[].fulfillment.shipping.recipient_address.first_name string Conditionally returned	First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.recipient_address.last_name string Conditionally returned	Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.recipient_address.middle_name string Conditionally returned	Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.recipient_address.phone string Conditionally returned	Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max
data[].fulfillment.shipping.recipient_address.postal_code string Conditionally returned	Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max
data[].fulfillment.shipping.recipient_address.state string Conditionally returned	State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max
data[].fulfillment.shipping.recipient_address.zip string Conditionally returned	United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max
data[].fulfillment.shipping.return_address object Conditionally returned	Address to which the order will be returned if shipping fails. This object is returned if it exists in the resource. Allowable Values: Existing `return_address` object
data[].fulfillment.shipping.return_address.address1 string Conditionally returned	Number and street of the address. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters.
data[].fulfillment.shipping.return_address.address2 string Conditionally returned	Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max Limits lower than 255 characters may be imposed by providers. Perfect Plastic Printing and IDEMIA have a limit of 100 characters, and Arroweye Solutions has a limit of 50 characters.
data[].fulfillment.shipping.return_address.city string Conditionally returned	City of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.return_address.country string Conditionally returned	Country of the address. This field is returned if it exists in the resource. Allowable Values: 40 char max English short name. For example, for the Kingdom of Spain, use the English short name “Spain”. The ISO maintains the full list of country codes.
data[].fulfillment.shipping.return_address.first_name string Conditionally returned	First name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.return_address.last_name string Conditionally returned	Last name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.return_address.middle_name string Conditionally returned	Middle name of the addressee. This field is returned if it exists in the resource. Allowable Values: 40 char max
data[].fulfillment.shipping.return_address.phone string Conditionally returned	Telephone number of the addressee. This field is returned if it exists in the resource. Allowable Values: 20 char max
data[].fulfillment.shipping.return_address.postal_code string Conditionally returned	Postal code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max
data[].fulfillment.shipping.return_address.state string Conditionally returned	State or province of the address. This field is returned if it exists in the resource. Allowable Values: 32 char max
data[].fulfillment.shipping.return_address.zip string Conditionally returned	United States ZIP code of the address. This field is returned if it exists in the resource. Allowable Values: 10 char max
data[].fulfillment_status string Returned	Card fulfillment status: - ISSUED: Initial state of all newly created/issued cards. - ORDERED: Card ordered through the card fulfillment provider. - REORDERED: Card reordered through the card fulfillment provider. - REJECTED: Card rejected by the card fulfillment provider. - SHIPPED: Card shipped by the card fulfillment provider. - DELIVERED: Card delivered by the card fulfillment provider. - DIGITALLY_PRESENTED: Card digitally presented using the `/cards/{token}/showpan` endpoint; does not affect the delivery of physical cards. Allowable Values: `ISSUED`, `ORDERED`, `REORDERED`, `REJECTED`, `SHIPPED`, `DELIVERED`, `DIGITALLY_PRESENTED`
data[].instrument_type string Conditionally returned	Instrument type of the card: - PHYSICAL_MSR: A physical card with a magnetic stripe. This is the default physical card type. - PHYSICAL_ICC: A physical card with an integrated circuit, or “chip.” - PHYSICAL_CONTACTLESS: A physical card that uses radio frequency identification (RFID) or near-field communication (NFC) to enable payment over a secure radio interface. - PHYSICAL_COMBO: A physical card with a chip that also supports contactless payments. - VIRTUAL_PAN: A virtual card with a primary account number (PAN). Allowable Values: `PHYSICAL_MSR`, `PHYSICAL_ICC`, `PHYSICAL_CONTACTLESS`, `PHYSICAL_COMBO`, `VIRTUAL_PAN`
data[].last_four string Returned	Last four digits of the card primary account number (PAN). Allowable Values: 4 chars
data[].last_modified_time datetime Returned	Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].metadata object Conditionally returned	Associates customer-provided metadata with the card. Allowable Values: Contains the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`
data[].pan string Returned	Primary account number (PAN) of the card. Allowable Values: 16 char max
data[].pin_is_set boolean Returned	Specifies if the personal identification number (PIN) has been set for the card. Allowable Values: 4 chars
data[].reissue_pan_from_card_token string Conditionally returned	Reissues the specified card (known as the “source” card). Allowable Values: Existing card token
data[].new_pan_from_card_token string Conditionally returned	Reissues the specified card (known as the “source” card) with a new primary account number (PAN). Allowable Values: Existing card token
data[].state string Returned	Indicates the state of the card. Allowable Values: `ACTIVE`, `SUSPENDED`, `TERMINATED`, `UNSUPPORTED`, `UNACTIVATED`, `LIMITED`
data[].state_reason string Returned	Descriptive reason for why the card is in its current state. For example, “Card activated by cardholder”. Allowable Values: 255 char max
data[].token string Returned	Unique identifier of the card. Allowable Values: Existing card token
data[].translate_pin_from_card_token string Conditionally returned	Copies the personal identification number (PIN) from the specified source card to the newly created card. Allowable Values: Existing card token
data[].user_token string Returned	Unique identifier of the cardholder. Allowable Values: Existing user token
end_index integer Conditionally returned	Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer

Sample response body

JSON

{
  "count": 3,
  "start_index": 0,
  "end_index": 2,
  "is_more": false,
  "data": [
    {
      "created_time": "2022-02-24T21:23:31Z",
      "last_modified_time": "2022-02-26T19:55:09Z",
      "token": "my_user_01_card_01",
      "user_token": "my_user_01",
      "card_product_token": "my_cardproduct_01",
      "last_four": "2160",
      "pan": "1111115454542160",
      "expiration": "1026",
      "expiration_time": "2027-10-31T23:59:59Z",
      "barcode": "11379418395311581864",
      "pin_is_set": false,
      "state": "SUSPENDED",
      "state_reason": "I do not want to use this card, so suspend it.",
      "expedite": false,
      "fulfillment_status": "ISSUED",
      "instrument_type": "PHYSICAL_MSR"
    },
    {
      "created_time": "2021-12-28T18:31:23Z",
      "last_modified_time": "2021-12-28T18:36:23Z",
      "token": "my_user_01_card_02",
      "user_token": "my_user_01",
      "card_product_token": "my_cardproduct_01",
      "last_four": "1865",
      "pan": "1111111824981865",
      "expiration": "1220",
      "expiration_time": "2026-12-31T23:59:59Z",
      "barcode": "25815105237561780909",
      "pin_is_set": false,
      "state": "UNACTIVATED",
      "state_reason": "New card",
      "expedite": false,
      "fulfillment_status": "ISSUED",
      "fulfillment": {
        "shipping": {
          "method": "FEDEX_REGULAR",
          "care_of_line": "my_care_of_value"
        },
        "card_personalization": {
          "text": {
            "name_line_1": {
              "value": "My card personalization line 1"
            },
            "name_line_2": {
              "value": "My card personalization line 2"
            }
          },
          "images": {
            "card": {
              "name": "my_card_logo.png",
              "thermal_color": "Black"
            },
            "signature": {
              "name": "my_signature.png"
            },
            "carrier_return_window": {
              "name": "my_return_address_image.png"
            }
          }
        }
      },
      "instrument_type": "PHYSICAL_MSR"
    },
    {
      "created_time": "2021-11-03T21:55:08Z",
      "last_modified_time": "2021-11-03T21:55:08Z",
      "token": "my_user-01-child_01_card_01",
      "user_token": "my_user-01-child_01",
      "card_product_token": "my_cardproduct_01",
      "last_four": "2810",
      "pan": "1111115454542810",
      "expiration": "1126",
      "expiration_time": "2026-11-30T23:59:59Z",
      "barcode": "63143403984499099324",
      "pin_is_set": false,
      "state": "UNACTIVATED",
      "state_reason": "New card",
      "expedite": false,
      "fulfillment_status": "ISSUED",
      "instrument_type": "PHYSICAL_MSR"
    }
  ]
}