Skip to main content
GET
/
cards
List Cards
curl --request GET \
  --url https://api.synctera.com/v2/cards
{
  "cards": [
    {
      "form": "PHYSICAL",
      "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": "<any>",
        "line_2": "<any>"
      },
      "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",
      "metadata": {},
      "reissue_reason": "EXPIRATION",
      "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",
      "type": "DEBIT",
      "card_image_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "shipping": {
        "address": {
          "address_line_1": "100 Main St.",
          "address_line_2": "Suite 99",
          "address_type": "SHIPPING",
          "city": "New York",
          "country_code": "US",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "is_registered_agent": true,
          "nickname": "Home",
          "postal_code": "28620",
          "state": "NY"
        },
        "care_of_line": "<string>",
        "is_expedited_fulfillment": false,
        "method": "LOCAL_MAIL",
        "phone_number": "+14374570680",
        "recipient_name": {
          "first_name": "Jane",
          "last_name": "Smith",
          "middle_name": "Anne"
        }
      },
      "card_status": "ACTIVE",
      "memo": "<string>",
      "pending_reasons": {
        "is_waiting_for_bulk_shipment": true,
        "is_waiting_for_image": true,
        "is_waiting_for_pin": true
      },
      "status_reason": "NEW",
      "card_fulfillment_status": "ISSUED",
      "fulfillment_details": {
        "ship_date": "2022-07-19",
        "shipping_method": "UPS Next Day Air Saver",
        "tracking_number": "1ZW3268W1319325382"
      },
      "tracking_number": "Ship Date [2022-07-19], Shipping Method [UPS Next Day Air Saver]; Tracking Number [1ZW3268W1319325382]",
      "bin": "<string>",
      "card_brand": "MASTERCARD",
      "physical_card_format": "MAGNETIC_STRIPE",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
customer_id
string<uuid>[]

The IDs of customers who created the payment schedules. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
account_id
string<uuid>[]

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

The unique identifier of an account

​
emboss_name
string

emboss name

​
last_four
string

The last 4 digits of the card PAN

Example:

"1234"

​
expiration_date
string<date>

The date representing when the card would expire at

Example:

"2006-01-02"

​
expires_before
string<date>

The date representing when the card will expire or become invalid before.

Example:

"2006-01-02"

​
card_type
enum<string>

Indicates the type of card

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

The brand of a card product

Available options:
MASTERCARD,
VISA
​
form
enum<string>

The format of the card

Available options:
PHYSICAL,
VIRTUAL
​
card_product_id
string<uuid>

The unique identifier of a cards product

Example:

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

​
card_status
enum<string>

The status of a card

Available options:
ACTIVE,
UNACTIVATED,
SUSPENDED,
TERMINATED,
IMAGE_PENDING,
IMAGE_REJECTED,
PENDING,
REJECTED
​
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

​
page_token
string

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

Example:

"a8937a0d"

​
sort_by
enum<string>[]

Specifies the sort order for the returned cards.

​
barcode
string

The barcode associated with a card

Example:

10044461864615598000

​
bulk_order_config_id
string<uuid>

The unique identifier of a bulk order configuration

Example:

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

​
bulk_order_id
string<uuid>

The unique identifier of a bulk order in which the card was fulfilled

Example:

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

​
bin_prefix
string

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

Example:

123456

Response

Cards

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

Array of Cards

  • Physical Card
  • 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"