Create a Card

Creates a card by passing the required card information
Cards
Create a Card
 last updated: 
November 30, 2023

ENDPOINT

  1. POST /v1/card

REQUEST

  1. {
  2.     "cardType": "physical",
  3.     "label": "Meal Card",
  4.     "accountId": "{{accountId}}",
  5.     "currency": "USD",
  6.     "limitAmount": "120.00",
  7.     "limitInterval": "allTime",
  8.     "billingAddress": {
  9.         "addressType": "billing",
  10.         "line1": "164 Sugarloaf Drive",
  11.         "line2": "",
  12.         "city": "San Mateo",
  13.         "state": "CA",
  14.         "country": "US",
  15.         "postalCode": "94403"
  16.     },
  17.     "shipping": {
  18.         "shippingAddress": {
  19.             "addressType": "shipping",
  20.             "line1": "164 Sugarloaf Drive",
  21.             "line2": "",
  22.             "city": "San Mateo",
  23.             "state": "CA",
  24.             "country": "US",
  25.             "postalCode": "94403"
  26.         }
  27.     },
  28.     "allowedCategories": [
  29.         "1234",
  30.         "9878"
  31.     ],
  32.     "bin": "credit",
  33.     "embossingPerson": "John Doe",
  34.     "embossingBusiness": "Acme LLC"
  35. }

Notes: 
- Leave the allowedCategories field blank if you want to allow all categories. The above codes are provided just as an example.
- To create a card for a business or family member who is not the account owner, pass their personId in the sd-person-id header.

RESPONSE

  1. {
  2.     "id": "crd-8df1a028-447d-479f-8b85-8187d3eb9582",
  3.     "accountId": "acc-63d656eb-fedc-4250-8111-48a5ff0faed9",
  4.     "businessId": "bus-0fc3d3cb-f2bf-407b-8377-77acc57f5ea6",
  5.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  6.     "cardholder": {
  7.         "id": "chd-7ce49193-018b-4a82-8f6d-867275526a4f",
  8.         "personId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  9.         "billingAddress": {
  10.             "addressType": "billing",
  11.             "line1": "164 Sugarloaf Drive",
  12.             "line2": "",
  13.             "city": "San Mateo",
  14.             "state": "CA",
  15.             "country": "US",
  16.             "postalCode": "94403"
  17.         },
  18.         "createdAt": "2021-12-17T05:21:56Z",
  19.         "modifiedAt": "2021-12-17T05:21:56Z",
  20.         "name": "John Doe"
  21.     },
  22.     "cardType": "physical",
  23.     "label": "Meal Card",
  24.     "limitAmount": "120.00",
  25.     "limitInterval": "allTime",
  26.     "shipping": {
  27.         "id": "shp-5bc9fb5f-c70d-424f-aaca-8c5daeb377fe",
  28.         "shippingAddress": {
  29.             "addressType": "shipping",
  30.             "line1": "164 Sugarloaf Drive",
  31.             "line2": "",
  32.             "city": "San Mateo",
  33.             "state": "CA",
  34.             "country": "US",
  35.             "postalCode": "94403"
  36.         },
  37.         "eta": "2021-12-17T05:21:56Z",
  38.         "deliveryStatus": "pending",
  39.         "createdAt": "2021-12-17T05:21:56Z",
  40.         "modifiedAt": "2021-12-17T05:21:56Z"
  41.     },
  42.     "currency": "USD",
  43.     "expiryMonth": "12",
  44.     "expiryYear": "2022",
  45.     "last4": "5275",
  46.     "cardStatus": "pendingActivation",
  47.     "activatedAt": "",
  48.     "createdAt": "2021-12-17T05:21:57Z",
  49.     "modifiedAt": "2021-12-17T05:21:57Z",
  50.     "createdPersonId": "per-3ebfa3d2-5d36-411d-984a-9e3a328011c5",
  51.     "metadata": null,
  52.     "bin": "credit",
  53.     "allowedCategories": [
  54.         "1234",
  55.         "9878"
  56.     ],
  57.     "availableLimit": "120.00",
  58.     "blockedCategories": null,
  59.     "embossingPerson": "John Doe",
  60.     "embossingBusiness": "Acme LLC",
  61.     "theme": ""
  62. }