Giftcard

Giftcard

Get Giftcard details

get

/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber}

Get details for a giftcard

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

giftcardNumberstringRequired

Reference to a giftcard number.

Query parameters

extensionCodestring · enumOptional

Reference to an extension

Possible values:

cvcstringOptional

Reference to a giftcard CVC number.

Responses

200

Example response

application/json

activebooleanOptionalDeprecated

balanceintegerRequired

cardIdintegerRequired

cardNumberstringRequired

validTostring · date-time · nullableRequired

brandIdintegerRequired

brandNamestringRequired

issuerNamestringRequired

notestringRequired

statusstring · enumRequired

CLEARED means the card balance is emptied, the card is deactivated and can not be used anymore.

Possible values:

cvcRequiredbooleanRequired

legacyCardNumberstringRequired

get/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "balance": 1,
  "cardId": 1,
  "cardNumber": "text",
  "validTo": "2026-01-01T00:00:00.000Z",
  "brandId": 1,
  "brandName": "text",
  "issuerName": "text",
  "note": "text",
  "status": "ACTIVE",
  "cvcRequired": true,
  "legacyCardNumber": "text"
}

Update giftcard details

put

/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber}

Change expiry date or active status.

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

giftcardNumberstringRequired

Reference to a giftcard number.

Body

validTostring · date-timeOptional

activebooleanOptionalDeprecated

notestringOptional

extensionCodestring · enumOptionalPossible values:

statusstring · enumOptional

CLEARED means the card balance is emptied, the card is deactivated and can not be used anymore.

Possible values:

Responses

200

Example response

application/json

activebooleanOptionalDeprecated

balanceintegerRequired

cardIdintegerRequired

cardNumberstringRequired

validTostring · date-time · nullableRequired

brandIdintegerRequired

brandNamestringRequired

issuerNamestringRequired

notestringRequired

statusstring · enumRequired

CLEARED means the card balance is emptied, the card is deactivated and can not be used anymore.

Possible values:

cvcRequiredbooleanRequired

legacyCardNumberstringRequired

put/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/giftcards/{giftcardNumber} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "validTo": "2026-01-01T00:00:00.000Z",
  "note": "text",
  "extensionCode": "FLOWGIFTCARD",
  "status": "ACTIVE"
}

200

Example response

{
  "balance": 1,
  "cardId": 1,
  "cardNumber": "text",
  "validTo": "2026-01-01T00:00:00.000Z",
  "brandId": 1,
  "brandName": "text",
  "issuerName": "text",
  "note": "text",
  "status": "ACTIVE",
  "cvcRequired": true,
  "legacyCardNumber": "text"
}