Gift cards

Get a gift card by id

The same gift card as under its location, found from its id. For a caller that holds an id and not the location it belongs to. The answer carries locationId.

get/v1/gift-cards/{giftCardId}

Request

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

Path parameters

giftCardIdstring required

Response

OK

accountingTypestring

How VAT is handled. single_purpose: VAT is charged when the card is sold. multi_purpose: VAT is charged when the card is redeemed.

beneficiarystring

Who the card is for, as free text.

codestring required

What the holder shows or types when paying.

createdAtstring date-time required
currencystring required

ISO 4217 currency code.

customerIdstring

The person, company or vehicle the card is linked to, when it is linked to one. The id's prefix says which.

descriptionstring
externalReferencestring

Your own id for the card, as sent when it was imported.

idstring required

Gift card id.

locationIdstring required
merchantIdstring

The merchant the card belongs to.

notestring

A note for staff, shown on the card in Cliento.

remainingValuestring required

What is left to spend.

soldDatestring date

The day the card was sold, in the location's time zone.

statusstring required

active: usable, nothing spent. partially_redeemed: usable, some spent. redeemed: nothing left. expired: past validUntil. void: cancelled. More values may be added.

updatedAtstring date-time required

When it last changed, in UTC.

validUntilstring date

The last day the card can be used.

valuestring required

The card's full value.

vatPercentstring

The VAT rate of a single-purpose card.

Example response

{
  "accountingType": "single_purpose",
  "beneficiary": "Anna Andersson",
  "code": "K7QX9M2D",
  "createdAt": "2026-11-17T09:14:03Z",
  "currency": "SEK",
  "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
  "description": "Presentkort",
  "externalReference": "shopify-5512340001-1",
  "id": "gft_7Qm2xN0cT1kPz4Wb9LrEaD",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "merchantId": "mer_2Rk8sVh3Yq6Nf1Tz0JwUcM",
  "note": "Web shop order 10042",
  "remainingValue": "500.00",
  "soldDate": "2026-11-17",
  "status": "active",
  "updatedAt": "2026-10-12T09:24:31.512Z",
  "validUntil": "2027-11-17",
  "value": "500.00",
  "vatPercent": "25"
}

Changes

No recorded changes to this operation across all 1 revision of this API.