Get Saved Gift Cards

Retrieves all saved gift cards for a specific user, including card details and preferred status.

Headers

x-applicationSource
Type: string
required

A custom HTTP header that accepts a free-form string value. It is used to identify the application making the API request. For example, if Punchh invokes the API, the value could be "punchh".
X-LocationId
Type: string
required

The unique location identifier for the store or business location processing the transaction.
Content-Type
Type: string
required

The media type of the request body. Must be set to application/json.
Authorization
Type: string
required

Bearer token for API authorization. Send in the format: Bearer ACCESS_TOKEN_GOES_HERE.

Body

application/json

Request body containing the userId.

userId
Type: string

The unique identifier of the user in your system whose saved gift cards are to be retrieved.

Responses

application/json
application/json
application/json

get/giftcard/v1/giftcards

curl https://SERVER_NAME_GOES_HERE.partech.com/giftcard/v1/giftcards \
  --header 'x-applicationSource: ' \
  --header 'X-LocationId: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN_GOES_HERE' \
  --data '{
  "userId": "user-9876"
}'

Show Schema

{
  "recordCount": 2,
  "data": [
    {
      "id": "gc-1a2b3c4d",
      "cardNumber": "GIFT_CARD_NUMBER_GOES_HERE",
      "passcode": "GIFT_CARD_PASSCODE_GOES_HERE",
      "isActive": true,
      "isPreferred": true,
      "sharedByUserId": null,
      "isShared": false
    },
    {
      "id": "gc-5e6f7g8h",
      "cardNumber": "GIFT_CARD_NUMBER_GOES_HERE",
      "passcode": "GIFT_CARD_PASSCODE_GOES_HERE",
      "isActive": true,
      "isPreferred": false,
      "sharedByUserId": "gc-555555",
      "isShared": true
    }
  ],
  "errors": null,
  "traceId": "00-abcdef1234567890-abcdef12-01",
  "statusCode": 200
}

Saved gift cards retrieved successfully