HS-Soft · API Platform · v1.0

The loyalty card API for CashAssist.

Issue, link, top up, redeem and inspect customer cards over a clean REST API. Test the whole flow in the sandbox in minutes — no SMS, no real money.

Get your API key → Explore the API Reference

Authenticate with the x-api-key header · base URL api-ai.hssoft.com/v1

quickstart.sh

# Read a loyalty card — try it with the shared sandbox key
curl -H "x-api-key: sk_test_demo" \
  "https://api-ai.hssoft.com/v1/cashassist/loyalty-cards/info?id=10472"

# → 200 OK
{ "id":"10472", "name":"Max Muster", "balance":42.50, "points":1280 }

Why developers like it

Everything you need to integrate fast

A focused, well-documented API with a real sandbox and money-safe primitives baked in.

⚡

12 REST endpoints

Link existing cards, create wallet cards, read balances & transactions, top up and redeem.

🧪

Instant sandbox

A seeded demo card and a test key out of the box. Run the full flow with zero side effects.

🔒

Money-safe by design

Idempotency keys on every booking, scoped API keys and rate limits — so retries never double-charge.

API surface

The CashAssist loyalty endpoints

Full request/response schemas and a try-it console live in the API Reference.

POST/cashassist/loyalty-cards/request-codeRequest an SMS code

POST/cashassist/loyalty-cards/confirm-codeConfirm an SMS code

POST/cashassist/loyalty-cards/verifyVerify a card by receipt

POST/cashassist/loyalty-cards/signupStart wallet sign-up

POST/cashassist/loyalty-cards/verify-signupConfirm wallet sign-up

POST/cashassist/loyalty-cards/createCreate card + wallet link

GET/cashassist/loyalty-cards/infoGet card information

POST/cashassist/loyalty-cards/updateUpdate card master data

GET/cashassist/loyalty-cards/transactionsList transactions

GET/cashassist/loyalty-cards/transactions/itemsTransaction line items

POST/cashassist/loyalty-cards/refillTop up balance

POST/cashassist/loyalty-cards/withdrawRedeem balance / points