Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Getgiftcardbypasssid

Get Gift Card Info by Pass SID

Returns lightweight gift card information for the pass linked to the given passSid. This endpoint is used by the public pass page to determine if a pass is linked to a gift card and what state the card is in, so the appropriate UI screen can be shown.

No customer session is required — only HMAC authentication from the ambassador.

Path Parameters:

  • passSid: The SID of the wallet pass

Returns:

  • id: Gift card MongoDB ObjectId
  • programId: The gift card program ID (required to call activate endpoint)
  • status: Current card status (pending / active / expired / etc.)
  • lastFourDigits: Last 4 digits of the card number
  • initialValue: Face value of the card
  • balance: Current balance
  • expiresAt: Card expiry datetime
  • merchantName: Name of the issuing merchant

Status Codes:

  • 200: Gift card found
  • 404: No gift card linked to this pass SID
get/v2/giftcards/passes/{passSid}

Path parameters

passSidstring required

Response

Successful Response

{"stackTrail":"paths:/v2/giftcards/passes/{passSid}:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}