Skip to main content
GET
/
cards
List Cards
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/cards \
  --header 'Authorization: Bearer <token>'
{
  "cards": [
    {
      "card_status": "ACTIVE",
      "status_reason": "ACT",
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "card_product_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "emboss_name": {
        "line_1": "Jane Smith",
        "line_2": "Acme Inc."
      },
      "expiration_month": "06",
      "expiration_year": "25",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_four": "1234",
      "type": "DEBIT",
      "form": "PHYSICAL",
      "card_brand": "MASTERCARD",
      "tenant": "abcdef_ghijkl",
      "memo": "<string>",
      "pending_reasons": {
        "is_waiting_for_bulk_shipment": true,
        "is_waiting_for_image": true,
        "is_waiting_for_pin": true
      },
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "expiration_time": "2010-05-06T12:23:34.321Z",
      "is_pin_set": true,
      "last_modified_time": "2010-05-06T12:23:34.321Z",
      "metadata": {},
      "reissue_reason": "APPEARANCE",
      "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",
      "bin": "<string>"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
last_four
string

The last 4 digits of the card PAN

Example:

"1234"

​
postal_code
string

The postal code of a card user

Example:

"49633"

​
customer_id
string<uuid>

The unique identifier of a customer

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
card_brand
enum<string>

The brand of a card product

Available options:
MASTERCARD,
VISA
​
bin_prefix
string

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

Example:

123456

​
emboss_name
string

emboss name

​
card_type
enum<string>

Indicates the type of card The type of the card program and BIN

Available options:
DEBIT,
PREPAID
​
form
enum<string>

The format of the card PHYSICAL or VIRTUAL.

Available options:
PHYSICAL,
VIRTUAL
​
page_token
string

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

Example:

"a8937a0d"

​
card_status
enum<string>

The status of a card The status indicating the card lifecycle state

Available options:
ACTIVE,
IMAGE_PENDING,
IMAGE_REJECTED,
PENDING,
REJECTED,
SUSPENDED,
TERMINATED,
UNACTIVATED
​
card_product_id
string<uuid>

The unique identifier of a cards product

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
account_id
string<uuid>[]

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

The unique identifier of an account

​
limit
integer
default:100

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

Required range: x >= 1
Example:

100

​
barcode
string

The barcode associated with a card

Example:

10044461864615598000

​
expiration_date
string<date>

The date representing when the card would expire at

Example:

"2006-01-02"

​
sort_by
enum<string>[]

Specifies the sort order for the returned cards.

Available options:
account_id:asc,
account_id:desc,
card_brand:asc,
card_brand:desc,
card_product_id:asc,
card_product_id:desc,
card_status:asc,
card_status:desc,
card_type:asc,
card_type:desc,
customer_id:asc,
customer_id:desc,
expiration_date:asc,
expiration_date:desc,
form:asc,
form:desc,
last_four:asc,
last_four:desc

Response

Cards

​
cards
(Virtual Card · object | Physical Card · object)[]
required

Array of Cards

A virtual card

​
next_page_token
string

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

Example:

"a8937a0d"