Cardli Rewards
API v1REST · JSON · HTTPS

API Reference

The Cardli Rewards REST API lets you integrate loyalty stamps, member management, and reward redemptions directly into your own app or POS system.

Browse endpointsAuthentication
Base URL

https://api.cardli.co.il

Auth

Bearer token (API key)

Rate limit

1,000 req / minute

Authentication

All API requests require an Authorization header with your API key. Find your keys in Settings → API Keys.

Authorization: Bearer lf_live_xxxxxxxxxxxx

Use lf_test_ keys for development — they hit a sandboxed environment with no real stamps or rewards.

Example: Record a stamp

Request

curl -X POST https://api.cardli.co.il/v1/cards/card_abc123/stamp \
  -H "Authorization: Bearer lf_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "member_id": "mem_xyz789",
    "location_id": "loc_001",
    "amount": 1
  }'

Response 200 OK

{
  "id": "txn_aAbBcC",
  "member_id": "mem_xyz789",
  "card_id": "card_abc123",
  "type": "stamp",
  "stamps_before": 4,
  "stamps_after": 5,
  "reward_triggered": false,
  "created_at": "2025-03-28T14:32:00Z"
}

Endpoints

Members

GET/v1/membersList all loyalty members for your business.
GET/v1/members/:idRetrieve a single member by ID.
POST/v1/membersCreate a new loyalty member.
PATCH/v1/members/:idUpdate member profile fields.
DELETE/v1/members/:idRemove a member from your program.

Cards

GET/v1/cardsList all loyalty card programs.
GET/v1/cards/:idRetrieve a specific card program.
POST/v1/cards/:id/stampRecord a stamp or visit for a member.
POST/v1/cards/:id/redeemRedeem a reward for a member.

Transactions

GET/v1/transactionsList all transactions with filters.
POST/v1/transactionsRecord a manual transaction.

Webhooks

POST/v1/webhooksRegister a webhook endpoint for events.
GET/v1/webhooksList all registered webhooks.
DELETE/v1/webhooks/:idRemove a webhook.