Get client gift cards

Request

Returns a list of client gift cards by phone

Attribute	Type	Description
id	int	Gift card ID
number	string	Gift card code
balance	decimal	Current balance
default_balance	decimal	Initial balance
type_id	int	Gift card type identifier
status_id	int	Status ID
created_date	timestamp	Date of sale
expiration_date	datetime	Burn date
type	object	Object with gift card type information
status	object	An object with information about the current gift card status

The type array contains the following objects:

Attribute	Type	Description
id	int	Gift card type identifier
title	string	Type name
balance	decimal	Gift card denomination
is_multi	boolean	Is it available for multiple debits
company_group_id	int	ID of the chain where the certificate type was created
item_type_id	int	Restriction on the use of redemption points. 0 - no limit, 1 - services only, 2 - some services + all products, 3 - some services, 4 - products only
expiration_type_id	int	The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed term
expiration_date	timestamp	Burn date of all gift cards. Populated with expiration_type_id = 1
expiration_timeout	int	Validity period of gift card. Populated with expiration_type_id = 2
expiration_timeout_unit_id	int	Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year
is_allow_empty_code	boolean	Sale without code
item_type	object	Object with item_type_id and its name

Security

BearerPartner

Query

location_idnumberrequired

Location ID

phonenumberrequired

Customer phone number

Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/certificates?location_id=0&phone=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataArray of objects

Array of objects with data

Example:

[
  {
    "id": 409726,
    "number": 888,
    "balance": 9000,
    "default_balance": 9000,
    "type_id": 27841,
    "status_id": 2,
    "created_date": "2026-09-21T23:00:00.000-05:00",
    "expiration_date": "2026-09-21T23:00:00.000-05:00",
    "type": { … },
    "status": { … }
  }
]

metaobject

Metadata (contains the number of certificates found)

Example:

{
  "count": 1
}

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}