List all Cards

Retrieves list of all cards that belong to the account ID
Cards
List all Cards
 last updated: 
November 30, 2023

ENDPOINT

  1. GET /v1/card

FILTERS

The table below describes various filters that can be passed as query parameters to narrow the response.

Filter Type Description
offset int start index (default = 0)
limit int number of records to return (default = 25, max = 100)
orderBy enum sort the list of card by createdAt, for example:
?orderBy=createdAt → order by createdAt ascending order
?orderBy=-createdAt → order by createdAt descending order (default if not passed)
accountId string account ID (required)
walletId string crypto wallet ID (crypto card alternative to account ID)
cardType enum virtual, physical
query string last 4 digits of card number
theme string card theme
status enum active, inactive, canceled, pendingActivation
externalId string Matches the externalId key if set in the object's metadata
availableLimit int filters by a range on the limitAmount field
(eg. ?minAvailableLimit=0.00&maxAvailableLimit=1000.09)


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "crd-290d30c2-8284-490f-b2ab-6186a4275624",
  6.             "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  7.             "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  8.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  9.             "cardholder": {
  10.                 "id": "chd-7ce49193-018b-4a82-8f6d-867275526a4f",
  11.                 "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  12.                 "billingAddress": {
  13.                     "addressType": "billing",
  14.                     "line1": "164 Sugarloaf Drive",
  15.                     "line2": "",
  16.                     "city": "San Mateo",
  17.                     "state": "CA",
  18.                     "country": "US",
  19.                     "postalCode": "94403"
  20.                 },
  21.                 "createdAt": "2021-12-17T05:21:56Z",
  22.                 "modifiedAt": "2021-12-17T07:03:36Z",
  23.                 "name": "John Doe"
  24.             },
  25.             "cardType": "physical",
  26.             "label": "Travel",
  27.             "limitAmount": "100.00",
  28.             "limitInterval": "daily",
  29.             "shipping": {
  30.                 "id": "shp-2451bcba-603d-4ded-990d-0fc3c932cb61",
  31.                 "shippingAddress": {
  32.                     "addressType": "shipping",
  33.                     "line1": "164 Sugarloaf Dr",
  34.                     "line2": "",
  35.                     "city": "San Mateo",
  36.                     "state": "CA",
  37.                     "country": "US",
  38.                     "postalCode": "94403"
  39.                 },
  40.                 "eta": "2021-12-17T07:03:36Z",
  41.                 "deliveryStatus": "pending",
  42.                 "createdAt": "2021-12-17T07:03:36Z",
  43.                 "modifiedAt": "2021-12-17T07:03:36Z"
  44.             },
  45.             "currency": "USD",
  46.             "expiryMonth": "12",
  47.             "expiryYear": "2022",
  48.             "last4": "0387",
  49.             "cardStatus": "active",
  50.             "activatedAt": "2021-12-17T07:04:05Z",
  51.             "createdAt": "2021-12-17T07:03:36Z",
  52.             "modifiedAt": "2021-12-17T07:33:27Z",
  53.             "createdPersonId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  54.             "metadata": null,
  55.             "bin": "credit",
  56.             "allowedCategories": [
  57.                 "1234",
  58.                 "9878"
  59.             ],
  60.             "availableLimit": "",
  61.             "blockedCategories": null,
  62.             "embossingPerson": "John Doe",
  63.             "embossingBusiness": "Acme LLC",
  64.             "theme": ""
  65.         },
  66.         {
  67.             "id": "crd-8df1a028-447d-479f-8b85-8187d3eb9582",
  68.             "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  69.             "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  70.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  71.             "cardholder": {
  72.                 "id": "chd-7ce49193-018b-4a82-8f6d-867275526a4f",
  73.                 "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  74.                 "billingAddress": {
  75.                     "addressType": "billing",
  76.                     "line1": "164 Sugarloaf Drive",
  77.                     "line2": "",
  78.                     "city": "San Mateo",
  79.                     "state": "CA",
  80.                     "country": "US",
  81.                     "postalCode": "94403"
  82.                 },
  83.                 "createdAt": "2021-12-17T05:21:56Z",
  84.                 "modifiedAt": "2021-12-17T07:03:36Z",
  85.                 "name": "John Doe"
  86.             },
  87.             "cardType": "physical",
  88.             "label": "Meal Card",
  89.             "limitAmount": "120.00",
  90.             "limitInterval": "allTime",
  91.             "shipping": {
  92.                 "id": "shp-5bc9fb5f-c70d-424f-aaca-8c5daeb377fe",
  93.                 "shippingAddress": {
  94.                     "addressType": "shipping",
  95.                     "line1": "164 Sugarloaf Drive",
  96.                     "line2": "",
  97.                     "city": "San Mateo",
  98.                     "state": "CA",
  99.                     "country": "US",
  100.                     "postalCode": "94403"
  101.                 },
  102.                 "eta": "2021-12-17T05:21:56Z",
  103.                 "deliveryStatus": "pending",
  104.                 "createdAt": "2021-12-17T05:21:56Z",
  105.                 "modifiedAt": "2021-12-17T05:21:56Z"
  106.             },
  107.             "currency": "USD",
  108.             "expiryMonth": "12",
  109.             "expiryYear": "2022",
  110.             "last4": "5275",
  111.             "cardStatus": "active",
  112.             "activatedAt": "2021-12-17T06:37:16Z",
  113.             "createdAt": "2021-12-17T05:21:57Z",
  114.             "modifiedAt": "2021-12-17T06:40:08Z",
  115.             "createdPersonId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  116.             "metadata": null,
  117.             "bin": "credit",
  118.             "allowedCategories": [
  119.                 "1234",
  120.                 "9878"
  121.             ],
  122.             "availableLimit": "120.00",
  123.             "blockedCategories": null,
  124.             "embossingPerson": "John Doe",
  125.             "embossingBusiness": "Acme LLC",
  126.             "theme": ""
  127.         }
  128.     ]
  129. }