List all Cards (Program)

Retrieves list of all cards that belong to a program
List all Cards (Program)
 last updated: 
August 15, 2022

ENDPOINT

  1. GET /v1/program/:id/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)
id string person ID
businesId string business ID
accountId string account ID
createdPersonId string ID of person who created the business
cardStatus enum active, inactive, canceled, pendingActivation
cardType enum virtual, physical
last4 int last 4 digits of card number
bin enum credit, debit
startTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
endTime string created time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedStartTime string modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
modifiedEndTime string modified time in ISO UTC format (YYYY-MM-DDThh:mm:ssZ)
externalId string Matches the externalId key if set in the object's metadata


RESPONSE

  1. {
  2.     "total": 2,
  3.     "data": [
  4.         {
  5.             "id": "crd-7b176979-9ece-41d3-b9ef-39a696636f45",
  6.             "accountId": "acc-e0d7c248-b7f3-475c-851e-882ed44fb8a6",
  7.             "businessId": "bus-00000000-0000-0000-0000-000000000000",
  8.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  9.             "cardholder": {
  10.                 "id": "chd-18b7bab0-7aa2-48b3-95cd-456ebf4fa525",
  11.                 "personId": "per-865882ac-b9d7-4f02-bf58-96826b57cdd9",
  12.                 "billingAddress": {
  13.                     "addressType": "billing",
  14.                     "line1": "1234 Wilshire Blvd",
  15.                     "line2": "",
  16.                     "city": "Los Angeles",
  17.                     "state": "CA",
  18.                     "country": "US",
  19.                     "postalCode": "90017"
  20.                 },
  21.                 "createdAt": "2021-11-30T09:30:14Z",
  22.                 "modifiedAt": "2021-12-20T06:05:59Z",
  23.                 "name": "Test"
  24.             },
  25.             "cardType": "physical",
  26.             "label": "Test",
  27.             "limitAmount": "1000.00",
  28.             "limitInterval": "monthly",
  29.             "shipping": {
  30.                 "id": "shp-ae9e41f7-0d8c-4299-af61-c9fc4d42f8f8",
  31.                 "shippingAddress": {
  32.                     "addressType": "shipping",
  33.                     "line1": "1234 Wilshire Boulevard",
  34.                     "line2": "",
  35.                     "city": "Los Angeles",
  36.                     "state": "CA",
  37.                     "country": "US",
  38.                     "postalCode": "90017"
  39.                 },
  40.                 "eta": "2021-12-20T06:05:58Z",
  41.                 "deliveryStatus": "pending",
  42.                 "createdAt": "2021-12-20T06:05:59Z",
  43.                 "modifiedAt": "2021-12-20T06:05:59Z"
  44.             },
  45.             "currency": "USD",
  46.             "expiryMonth": "12",
  47.             "expiryYear": "2022",
  48.             "last4": "0434",
  49.             "cardStatus": "active",
  50.             "activatedAt": "2021-12-20T06:06:52Z",
  51.             "createdAt": "2021-12-20T06:05:59Z",
  52.             "modifiedAt": "2021-12-20T06:06:52Z",
  53.             "createdPersonId": "per-865882ac-b9d7-4f02-bf58-96826b57cdd9",
  54.             "metadata": null,
  55.             "bin": "debit",
  56.             "allowedCategories": null,
  57.             "availableLimit": "",
  58.             "blockedCategories": null,
  59.             "embossingPerson": "Test",
  60.             "embossingBusiness": "",
  61.             "theme": ""
  62.         },
  63.         {
  64.             "id": "crd-daa73f31-a946-446e-8d93-39defaa5a9d7",
  65.             "accountId": "acc-bb6335aa-649f-4151-be7d-7387500b53c0",
  66.             "businessId": "bus-301da70b-3e2f-4fb9-a310-fdaca70cc638",
  67.             "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  68.             "cardholder": {
  69.                 "id": "chd-18b7bab0-7aa2-48b3-95cd-456ebf4fa525",
  70.                 "personId": "per-865882ac-b9d7-4f02-bf58-96826b57cdd9",
  71.                 "billingAddress": {
  72.                     "addressType": "billing",
  73.                     "line1": "1234 Wilshire Boulevard",
  74.                     "line2": "",
  75.                     "city": "Los Angeles",
  76.                     "state": "CA",
  77.                     "country": "US",
  78.                     "postalCode": "90017"
  79.                 },
  80.                 "createdAt": "2021-11-30T09:30:14Z",
  81.                 "modifiedAt": "2021-12-20T06:05:59Z",
  82.                 "name": "Test"
  83.             },
  84.             "cardType": "physical",
  85.             "label": "P Card One",
  86.             "limitAmount": "1.00",
  87.             "limitInterval": "yearly",
  88.             "shipping": {
  89.                 "id": "shp-2ca1df51-25c2-4cc4-a27f-bd1641f74fa2",
  90.                 "shippingAddress": {
  91.                     "addressType": "shipping",
  92.                     "line1": "1234 Wilshire Blvd",
  93.                     "line2": "",
  94.                     "city": "Los Angeles",
  95.                     "state": "CA",
  96.                     "country": "US",
  97.                     "postalCode": "90017"
  98.                 },
  99.                 "eta": "2021-12-20T05:37:54Z",
  100.                 "deliveryStatus": "pending",
  101.                 "createdAt": "2021-12-20T05:37:54Z",
  102.                 "modifiedAt": "2021-12-20T05:37:54Z"
  103.             },
  104.             "currency": "USD",
  105.             "expiryMonth": "12",
  106.             "expiryYear": "2022",
  107.             "last4": "9753",
  108.             "cardStatus": "pendingActivation",
  109.             "activatedAt": "",
  110.             "createdAt": "2021-12-20T05:37:55Z",
  111.             "modifiedAt": "2021-12-20T05:37:55Z",
  112.             "createdPersonId": "per-865882ac-b9d7-4f02-bf58-96826b57cdd9",
  113.             "metadata": null,
  114.             "bin": "debit",
  115.             "allowedCategories": null,
  116.             "availableLimit": "",
  117.             "blockedCategories": null,
  118.             "embossingPerson": "One",
  119.             "embossingBusiness": "One",
  120.             "theme": ""
  121.         }
  122.     ]
  123. }