---
title: "Get a gift card"
method: GET
path: "/v1/locations/{locationId}/gift-cards/{giftCardId}"
tags: ["Gift cards"]
---

# Get a gift card

`GET /v1/locations/{locationId}/gift-cards/{giftCardId}`

## Request

- Base URL: `https://api.cliento.com`
- URL: `https://api.cliento.com/v1/locations/{locationId}/gift-cards/{giftCardId}`
- Auth: HTTP bearer

## Path parameters

- `locationId` string, required
- `giftCardId` string, required

## Response `200`

OK

- GiftCard: A gift card. It belongs to one merchant and is redeemed at that merchant's point of sale, or at another merchant's when the location allows it. Amounts are decimal strings in the location's currency.
  - `accountingType` string: How VAT is handled. `single_purpose`: VAT is charged when the card is sold. `multi_purpose`: VAT is charged when the card is redeemed.
  - `beneficiary` string: Who the card is for, as free text.
  - `code` string, required: What the holder shows or types when paying.
  - `createdAt` string, date-time, required
  - `currency` string, required: ISO 4217 currency code.
  - `customerId` string: The person, company or vehicle the card is linked to, when it is linked to one. The id's prefix says which.
  - `description` string
  - `externalReference` string: Your own id for the card, as sent when it was imported.
  - `id` string, required: Gift card id.
  - `locationId` string, required
  - `merchantId` string: The merchant the card belongs to.
  - `note` string: A note for staff, shown on the card in Cliento.
  - `remainingValue` string, required: What is left to spend.
  - `soldDate` string, date: The day the card was sold, in the location's time zone.
  - `status` string, required: `active`: usable, nothing spent. `partially_redeemed`: usable, some spent. `redeemed`: nothing left. `expired`: past `validUntil`. `void`: cancelled. More values may be added.
  - `updatedAt` string, date-time, required: When it last changed, in UTC.
  - `validUntil` string, date: The last day the card can be used.
  - `value` string, required: The card's full value.
  - `vatPercent` string: The VAT rate of a single-purpose card.

## Other responses

- `default`: Any failure. See the Errors section.

---

[API](https://skmtc.dev/cliento/apis/cliento-api.md) · [All operations](https://skmtc.dev/cliento/apis/cliento-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cliento/apis/cliento-api/revisions/29ca811bc061?raw)