Carrefour Gift Card Verification API

A simple, efficient, and robust API to verify the balance and validity of Carrefour gift cards.

📋 Description

This API, built with the NestJS framework, allows automated checking of Carrefour gift card balances. It uses Puppeteer to scrape balance information directly from the official Carrefour website.

🌟 Features

• ✅ Gift card balance verification
• ✅ Card validity date checking
• ✅ Debug mode for troubleshooting
• ✅ Configurable retry attempts and timeouts (Exponential Backoff)
• ✅ Interactive API documentation via Swagger

🔧 Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• Chromium (automatically installed with Puppeteer)

🛠️ Installation

# Clone the repository
git clone https://github.com/your-username/api-carrefour-giftcard-checker.git
cd api-carrefour-giftcard-checker

# Install dependencies
npm install

🚀 Running the Project

# Development mode
npm run start

# Watch mode
npm run start:dev

# Production mode
npm run start:prod

The API will be accessible at: http://localhost:3000
Swagger Documentation: http://localhost:3000/api

🧪 Tests

# Unit tests
npm run test

# End-to-end tests
npm run test:e2e

# Test coverage
npm run test:cov

🐳 Docker Deployment

# Build the image
docker build -t carrefour-giftcard-api .

# Run the container
docker run -p 3000:3000 carrefour-giftcard-api

📌 API Usage

Checking a Card Balance

curl -X POST http://localhost:3000/card-balance \
  -H 'Content-Type: application/json' \
  -d '{
    "cardNumber": "50320004304585671840123",
    "pin": "3301"
  }'

Response

{
  "balance": "25.00 €",
  "validityDate": "31/12/2025"
}

🏗️ Architecture

src/
├── card-balance/         # Gift card verification module
│   ├── dto/              # Data Transfer Objects
│   ├── models/           # Data models
│   ├── card-balance.controller.ts
│   └── card-balance.service.ts
├── core/                 # Core functionality
│   └── puppeteer/        # Puppeteer scraping service
├── shared/               # Shared resources
└── app.module.ts         # Main application module

📄 License

This project is licensed under the MIT License.