Skip to content

Get Card by Card ID (GET /v1/cards/card/{cardId})

Retrieves the complete details of a Card identified by its cardId.

URL test:

https://test.lightcms.io/loyalty/v1/cards/card/{cardId}

Method:

GET

Path Items

/v1/cards/card/{cardId}

Parameters

Name Location Type Required Description
cardId path integer (int64) Yes Identifier of the Card (must be > 0).
accept header string Yes Media types that are acceptable for the response (e.g., */*).

Example cURL

    curl -X GET "https://test.lightcms.io/loyalty/v1/cards/card/123456" \
         -H "accept: */*"

Responses:

200 - OK

Status Code: 200 OK

{
  "id": 1,
  "cardId": 123456,
  "holderExternalId": "holder-abc-123",
  "extStatus": "ACTIVE",
  "association": "VISA",
  "cardProductDefinitionCode": "CPD001",
  "createdAt": "2024-05-10T14:30:00Z",
  "updatedAt": "2025-01-22T09:15:00Z"
}

Parameter Location Type Description
id body integer (int64) Unique identifier of the Card record.
cardId body integer (int64) Identifier of the Card as known in the card system.
holderExternalId body string External identifier of the Card holder (from CMS).
extStatus body string Current status of the Card (e.g., ACTIVE, BLOCKED).
association body string Card association/brand (e.g., VISA, MC).
cardProductDefinitionCode body string Card Product Definition (CPD) code.
createdAt body string (date‑time) Timestamp when the Card record was created.
updatedAt body string (date‑time) Timestamp of the last update to the Card record.
404 - Not Found

Status Code: 404 Not Found

{
"timestamp": "2026-02-04T11:13:30.42463459",
"status": 404,
"error": "Resource Not Found",
"message": "Card not found with cardId: 1212121212121"
}

Parameter Location Type Description
timestamp body string (date‑time) Time when the error response was generated.
status body integer HTTP status code (404).
error body string Short error label (“Resource Not Found”).
message body string Detailed error message indicating the missing ID.