Card Products

Overview

The Card Products endpoints allow you to retrieve information about card products available in your company. Card products define the types of cards that can be ordered for users, including physical cards, virtual cards, and their associated configurations.

List Card Products

Retrieves a list of card products. You can filter, sort, and paginate the results using query parameters.

Query Parameters

Use the filter query parameter to filter, sort, and paginate results. The filter should be a JSON object passed as a URL-encoded string.

Filter Options

The filter object supports the following properties:

Where Clause Examples

Common filter conditions for the where clause:

Example Requests

Get all active card products for a company:

curl -X GET "https://sandbox.custodia-tech.com/md/api/CardProduct?filter=%7B%22where%22%3A%7B%22companyId%22%3A%22your-company-id%22%2C%22status%22%3A%22active%22%7D%7D" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "x-appid: YOUR_CLIENT_ID"

Using JavaScript (fetch) - Get active card products:

const filter = {
  where: {
    companyId: 'your-company-id',
    status: 'active'
  },
  order: 'name ASC'
};

const filterParam = encodeURIComponent(JSON.stringify(filter));
const response = await fetch(`https://sandbox.custodia-tech.com/md/api/CardProduct?filter=${filterParam}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'x-appid': clientId
  }
});

const cardProducts = await response.json();

Get only virtual card products:

const filter = {
  where: {
    companyId: 'your-company-id',
    status: 'active',
    isVirtual: true
  }
};

const filterParam = encodeURIComponent(JSON.stringify(filter));
const response = await fetch(`https://sandbox.custodia-tech.com/md/api/CardProduct?filter=${filterParam}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'x-appid': clientId
  }
});

const virtualCardProducts = await response.json();

Get default card product:

const filter = {
  where: {
    companyId: 'your-company-id',
    status: 'active',
    default: true
  },
  limit: 1
};

const filterParam = encodeURIComponent(JSON.stringify(filter));
const response = await fetch(`https://sandbox.custodia-tech.com/md/api/CardProduct?filter=${filterParam}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'x-appid': clientId
  }
});

const defaultProduct = await response.json();

Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Corporate Physical Card",
    "status": "active",
    "companyId": "your-company-id",
    "vendor": "marqeta",
    "productType": "physical",
    "isVirtual": false,
    "default": true,
    "supportsDigitalWallet": true,
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": null,
    "description": "Standard corporate physical card",
    "orderInstructions": {
      "preferredOrderMethod": "direct",
      "address2use": "user"
    },
    "supportedOperations": ["activate", "terminate", "suspend"],
    "paymentNetwork": "visa",
    "created": "2024-01-01T00:00:00.000Z",
    "modified": "2024-01-01T00:00:00.000Z"
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Virtual Card",
    "status": "active",
    "companyId": "your-company-id",
    "vendor": "marqeta",
    "productType": "virtual",
    "isVirtual": true,
    "default": false,
    "supportsDigitalWallet": true,
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": null,
    "description": "Virtual card for online transactions",
    "orderInstructions": {
      "preferredOrderMethod": "direct"
    },
    "supportedOperations": ["activate", "terminate"],
    "paymentNetwork": "visa",
    "created": "2024-01-01T00:00:00.000Z",
    "modified": "2024-01-01T00:00:00.000Z"
  }
]

Get Card Product by ID

Retrieves detailed information about a specific card product by its ID.

Path Parameters

Query Parameters

Example Request

Using cURL:

curl -X GET https://sandbox.custodia-tech.com/md/api/CardProduct/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "x-appid: YOUR_CLIENT_ID"

Using JavaScript (fetch):

const cardProductId = '550e8400-e29b-41d4-a716-446655440000';

const response = await fetch(`https://sandbox.custodia-tech.com/md/api/CardProduct/${cardProductId}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'x-appid': clientId
  }
});

const cardProduct = await response.json();

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Corporate Physical Card",
  "status": "active",
  "companyId": "your-company-id",
  "vendor": "marqeta",
  "vendorRecordId": "vendor-product-id",
  "productType": "physical",
  "isVirtual": false,
  "default": true,
  "supportsDigitalWallet": true,
  "startDate": "2024-01-01T00:00:00.000Z",
  "endDate": null,
  "description": "Standard corporate physical card",
  "orderInstructions": {
    "preferredOrderMethod": "direct",
    "address2use": "user",
    "expedite": false
  },
  "supportedOperations": ["activate", "terminate", "suspend", "disassociate"],
  "paymentNetwork": "visa",
  "businessPartnerCode": null,
  "paymentManagerCode": null,
  "availableToTeamsIds": [],
  "created": "2024-01-01T00:00:00.000Z",
  "modified": "2024-01-01T00:00:00.000Z"
}

Card Product Fields

The following fields are available in card product responses:

Order Instructions Object

The orderInstructions object contains information about how cards from this product can be ordered:

Error Responses

All endpoints may return the following error responses: