Skip to main content
GET
Public card lookup

GET /card/{cardId}

Retrieve public card history without an API key. This endpoint is public. You do not need an API key or employee token. The response is an array of card instances, including archived history. Account and employee information is sanitized. Use id to identify a particular instance and inspect archived, canceledAt, and activated before showing its state. This endpoint allows 10 requests per minute per IP.

Example request

Path Parameters

cardId
string
required

Printed or digital identifier.

Response

Success

cardType
enum<string>
required
Available options:
blankCard
id
string

MongoDB object id.

Pattern: ^[a-fA-F0-9]{24}$
cardId
string

Reusable printed or digital card identifier.

serialNumber
integer
pocketId
string
createdAt
string<date-time>
updatedAt
string<date-time>
activatedAt
string<date-time>
canceledAt
string<date-time>
activated
boolean
lifetime
integer

Lifetime in hours, measured from createdAt; 0 means unlimited.

Required range: x >= 0
description
string
amount
integer

Original coupon value in cents, or template amount for other types.

location
object
createdByEmployeeId
string

MongoDB object id.

Pattern: ^[a-fA-F0-9]{24}$
archived
boolean
testCard
boolean
isLocationBound
boolean

When true, use is restricted to the issuing location.

customerEmail
string
templateId
string

MongoDB object id.

Pattern: ^[a-fA-F0-9]{24}$
logs
object[]