Skip to main content
GET
/
{locale}
/
shop
/
loyalty-cards
curl -X GET "https://staging-api.loyalty.lt/en/shop/loyalty-cards?per_page=10&is_active=true" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "data": [
    {
      "id": 1,
      "partner_id": 45,
      "title": {
        "lt": "Kavos mėgėjo kortelė",
        "en": "Coffee Lover Card"
      },
      "description": {
        "lt": "Rink taškus už kiekvieną pirkinį ir gauk nemokamą kavą!",
        "en": "Collect points with every purchase and get free coffee!"
      },
      "card_design": {
        "background_color": "#2D1810",
        "text_color": "#FFFFFF",
        "logo_url": "https://staging-api.loyalty.lt/storage/logos/coffee-card.png"
      },
      "is_active": true,
      "shop_ids": [],
      "auto_assign": true,
      "points_enabled": true,
      "initial_bonus_points": 50,
      "points_expiration_days": 365,
      "points_per_currency": 10,
      "currency_amount": 1.00,
      "round_points_up": true,
      "min_points_per_purchase": 1,
      "max_points_per_purchase": 500,
      "points_per_visit": 5,
      "points_redemption_enabled": true,
      "points_per_currency_redemption": 100,
      "currency_amount_redemption": 1.00,
      "min_points_for_redemption": 100,
      "max_points_per_redemption": 1000,
      "terms_conditions": {
        "lt": "Taškai galioja 1 metus nuo gavimo datos.",
        "en": "Points are valid for 1 year from earning date."
      },
      "qr_code": "CARD-001-ABC123",
      "partner": {
        "id": 45,
        "name": "Coffee Paradise",
        "logo": "https://staging-api.loyalty.lt/storage/logos/coffee-paradise.png"
      },
      "created_at": "2024-01-01T10:00:00.000Z",
      "updated_at": "2024-06-15T14:30:00.000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 10,
    "total": 1
  }
}

​
List Loyalty Cards

Retrieve a paginated list of loyalty card templates (partner cards) configured for your partner account. These are the card designs and configurations that users can receive.
This endpoint requires Shop API authentication (X-API-Key and X-API-Secret headers).

​
Path Parameters

​
locale
string
required
Language code for localized content (e.g., en, lt)

​
Query Parameters

​
per_page
integer
default:"15"
Number of items per page (max 50)
​
page
integer
default:"1"
Page number for pagination
​
is_active
boolean
default:"true"
Filter by active status
  • true - Only active cards
  • false - Only inactive cards
​
shop_id
integer
Filter cards applicable to specific shop
​
card_type
string
Filter by card type
  • third_party - External integrated cards
  • loyalty - Standard loyalty cards
​
search
string
Search by card name or card number

​
Authentication

​
X-API-Key
string
required
API key from Partners Portal
​
X-API-Secret
string
required
API secret from Partners Portal

​
Response

​
success
boolean
Indicates if the request was successful
​
data
array
Array of partner card objects
​
meta
object
Pagination metadata
curl -X GET "https://staging-api.loyalty.lt/en/shop/loyalty-cards?per_page=10&is_active=true" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "data": [
    {
      "id": 1,
      "partner_id": 45,
      "title": {
        "lt": "Kavos mėgėjo kortelė",
        "en": "Coffee Lover Card"
      },
      "description": {
        "lt": "Rink taškus už kiekvieną pirkinį ir gauk nemokamą kavą!",
        "en": "Collect points with every purchase and get free coffee!"
      },
      "card_design": {
        "background_color": "#2D1810",
        "text_color": "#FFFFFF",
        "logo_url": "https://staging-api.loyalty.lt/storage/logos/coffee-card.png"
      },
      "is_active": true,
      "shop_ids": [],
      "auto_assign": true,
      "points_enabled": true,
      "initial_bonus_points": 50,
      "points_expiration_days": 365,
      "points_per_currency": 10,
      "currency_amount": 1.00,
      "round_points_up": true,
      "min_points_per_purchase": 1,
      "max_points_per_purchase": 500,
      "points_per_visit": 5,
      "points_redemption_enabled": true,
      "points_per_currency_redemption": 100,
      "currency_amount_redemption": 1.00,
      "min_points_for_redemption": 100,
      "max_points_per_redemption": 1000,
      "terms_conditions": {
        "lt": "Taškai galioja 1 metus nuo gavimo datos.",
        "en": "Points are valid for 1 year from earning date."
      },
      "qr_code": "CARD-001-ABC123",
      "partner": {
        "id": 45,
        "name": "Coffee Paradise",
        "logo": "https://staging-api.loyalty.lt/storage/logos/coffee-paradise.png"
      },
      "created_at": "2024-01-01T10:00:00.000Z",
      "updated_at": "2024-06-15T14:30:00.000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 10,
    "total": 1
  }
}

​
Points Calculation Example

Given the following card configuration:
  • points_per_currency: 10
  • currency_amount: 1.00
  • points_per_visit: 5
  • round_points_up: true
For a €15.50 purchase:
  1. Base points: (15.50 / 1.00) × 10 = 155 points
  2. Plus visit bonus: 155 + 5 = 160 points

Get Card Details

Get specific card template details

Get Loyalty Card Info

Get user’s card by number or ID

Create Transaction

Award points via transaction