Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Cards

List Cards

List of cards matching query parameters

get/cards

Query parameters

last_fourstring
Example:1234

The last 4 digits of the card PAN

postal_codestring
Example:49633

The postal code of a card user

customer_idstring uuid

The unique identifier of a customer

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7
card_brand'MASTERCARD' | 'VISA'

The brand of a card product

The brand of a card product

bin_prefixstring

The BIN number that prefixes a card PAN (first 6 or 8 digits)

emboss_namestring

emboss name

card_type'DEBIT' | 'PREPAID'

The type of the card program and BIN

Indicates the type of card

form'PHYSICAL' | 'VIRTUAL'

PHYSICAL or VIRTUAL.

The format of the card

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
card_status'ACTIVE' | 'IMAGE_PENDING' | 'IMAGE_REJECTED' | 'PENDING' | 'REJECTED' | 'SUSPENDED' | 'TERMINATED' | 'UNACTIVATED'

The status indicating the card lifecycle state

The status of a card

card_product_idstring uuid

The unique identifier of a cards product

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7
account_idAccountId[]

Account ID(s). Multiple IDs can be provided as a comma-separated list.

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
barcodestring

The barcode associated with a card

expiration_datestring date
Example:2006-01-02

The date representing when the card would expire at

sort_bystring[]

Specifies the sort order for the returned cards.

Response

Cards

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "next_page_token": "a8937a0d",
  "cards": [
    {
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "emboss_name": {
        "line_1": "Jane Smith",
        "line_2": "Acme Inc."
      },
      "expiration_month": "06",
      "expiration_time": "2010-05-06T12:23:34.321Z",
      "expiration_year": "25",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_pin_set": true,
      "last_four": "1234",
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "reissued_from_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "reissued_to_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "timestamp_pin_set": "2010-05-06T12:23:34.321Z",
      "tenant": "abcdef_ghijkl"
    }
  ]
}