BigCity Rewards API

Complete rewards platform integration for partner companies

Transform Customer Purchases into Rewards

The BigCity Rewards API enables companies to integrate with our rewards platform, allowing customers to earn and redeem rewards based on their purchases.

Quick Start Guide Authentication
Company Auth
Customer Auth
Rewards

API Overview

Secure Authentication

Two-tier JWT-based authentication system with company and customer tokens

Real-time Processing

Instant voucher generation and reward processing for seamless customer experience

RESTful Design

Clean, intuitive API design following REST principles with JSON responses

Scalable

Built to handle high-volume transactions with comprehensive rate limiting

Base URL & Configuration

Base URL

https://rewardapi.bigcityvoucher.co.in/v1/

Authentication Flow

1

Company Authentication

Companies authenticate to receive company access token

POST /v1/company/auth
2

Customer Authentication

Individual customers authenticated using company tokens

POST /v1/customer/auth
3

Rewards & Orders

Access rewards and create redemption orders

GET /v1/bigcity/rewards

Quick Start Examples

1. Company Authentication

curl -X POST https://api.bigcity.in/v1/company/auth \
  -H "Authorization: Required" \
  -H "Content-Type: application/json" \
  -d '{"secret": "your_company_secret"}'

2. Customer Authentication

curl -X POST https://api.bigcity.in/v1/customer/auth \
  -H "Authorization: Bearer {company_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "John Doe",
    "customer_mobile": "1234567890",
    "customer_email": "john@example.com"
  }'

3. Get Available Rewards

curl -X GET https://api.bigcity.in/v1/bigcity/rewards \
  -H "Authorization: Bearer {company_token}"

4. Create Redemption Order

curl -X POST https://api.bigcity.in/v1/bigcity/redeemptiononskus \
  -H "Authorization: Bearer {customer_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "order_timestamp": "2025-10-13T15:42:36-04:00",
    "order_total": 1500,
    "order_items": 3,
    "line_items": [...]
  }'

Key Features

Token-Based Security

  • Company-level authentication
  • Customer-level tokens
  • JWT token management
  • Automatic expiration

Rewards Management

  • Dynamic rewards catalog
  • Real-time availability
  • SKU-based mapping
  • Denomination structure

Order Processing

  • Real-time order creation
  • Voucher code generation
  • Order tracking
  • Comprehensive history

Flexible Integration

  • RESTful API design
  • JSON format
  • Comprehensive errors
  • Multiple SDKs

HTTP Status Codes

200
Success - Request completed successfully
201
Created - Resource created successfully
400
Bad Request - Invalid request format
401
Unauthorized - Invalid authentication
422
Unprocessable Entity - Validation failed
429
Rate Limited - Too many requests