Skip to main content
GET
Get card

GET /cards

Retrieve the newest unarchived card instance for your API key’s account. Send Authorization: Bearer YOUR_API_KEY and X-Device-ID: YOUR_DEVICE_ID. See authentication. cardId and timestamp are required query parameters. Send an ISO 8601 timestamp; the current handler checks that it is present. cardType can be blankCard, couponCard, loyaltyCard, statusCard, or pointsCard. A blank card needs a template before use. lifetime is in hours from createdAt; 0 means unlimited. isLocationBound restricts redemption to the issuing location. location contains the current location details when available. Points and status cards include their current program. Status points represent progress within the current tier and may decrease as awards leave the rolling window.

Example request

Example response fields

Authorizations

Authorization
string
header
required

Location API key. Also requires X-Device-ID.

Headers

X-Device-ID
string
required

Stable device identifier. API key binds to this value on first use.

Query Parameters

cardId
string
required

Printed or digital card identifier.

timestamp
string<date-time>
required

Request timestamp.

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[]