Skip to content

Get list of Active Card Product Definitions

The method retrieves active versions of the all Card Product Definition. This allows administrators to review CPDs active version and properly manage CPDs development.

URL test:

https://dev.lightcms.io/cms/v1/cpds

URL live:

https://fat.lightcms.io/cms/v1/cpds

Method:

GET

Path items:

/cpds (Card Product Definition Service)

Parameters:

No parameters

Example:

curl -X 'GET' \
  'https://dev.lightcms.io/cms/v1/cpds' \
  -H 'accept: */*'

Responses:

200 - OK

Status Code: 200 OK

{
  "cpds": [
    {
      "id": 1,
      "code": "VISA_VIRT_2",
      "name": "VISA Virtual Retail",
      "image": [
        "virtual.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    },
    {
      "id": 2,
      "code": "VISA_PHYS_1",
      "name": "VISA Physical Retail",
      "image": [
        "phys_standard.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    },
    {
      "id": 3,
      "code": "VISA_DEV_TEST",
      "name": "VISA Dev Test",
      "image": [
        "phys_standard.png"
      ],
      "segment": [
        "RETAIL"
      ],
      "status": "ACTIVE",
      "validFrom": "2023-05-29T00:00:00Z",
      "validTo": "2999-12-31T23:59:59.999Z"
    }
  ]
}

Parameter Type Example Description
cpds object[]
id int 4 ID
code string VISA_VIRT_2 CPD code
image string[] virtual.png Image name array
segment string[] REATAIL Marketing segment
status string NEW CPD status
validFrom cpds string "2023-05-29T00:00:00Z"
validTo cpds string "2030-05-29T00:00:00Z"
500 - Internal error

Status Code: 500 Internal error