REST API v.2.0

Authentication (Client API)

These endpoints are hosted by the Client System. Bigcity Microsite calls these APIs for OTP generation and verification.

Resource Description
POST /api/v1/auth/generate-otp CLIENT Validate Customer ID and generate OTP
POST /api/v1/auth/verify-otp CLIENT Validate OTP and authenticate customer
Customer Points (Client API)

Endpoints for managing customer points. Client System is the master ledger.

Resource Description
GET /api/v1/customer/points CLIENT Fetch latest customer points information
Catalog (Bigcity API)

Endpoints for browsing available rewards (E-Gift Vouchers, Merchandise).

Resource Description
GET /api/v1/catalog Retrieve available rewards catalog
Orders

Endpoints for order placement, status, redemption, and reversal.

Resource Description
POST /api/v1/orders Create reward redemption order (Bigcity API)
GET /api/v1/orders/status Get order fulfillment status (Bigcity API)
POST /api/v1/orders/redeem CLIENT Deduct points from customer ledger
POST /api/v1/orders/reverse CLIENT Reverse points for failed/cancelled orders