YGG Redeem API Documentation

Overview

The YGG Redeem platform manages all payouts in the YGG Play gaming ecosystem. Partner games use this platform to allow their players to convert in-game "points" into $YGG tokens.

How It Works

The redemption process follows a simple but secure flow:

1. Players earn points in partner games
2. Players request redemption through the YGG Redeem platform
3. YGG verifies points with partner APIs
4. Points are deducted from the game account
5. $YGG tokens are distributed to the player's wallet

Key Features

• 🔐 Secure Authentication with API keys and HMAC signatures
• 💰 Bonus Mechanisms for large redemptions
• 🔄 Automatic Reversals for failed transactions
• 📊 Real-time Price Updates from CoinMarketCap
• 🌐 Multi-chain Support (Abstract, Ronin, Ethereum)
• 📈 Comprehensive Logging for audits and debugging

Redemption Formula

The amount of $YGG tokens a user receives is calculated using this formula:

$YGG = GamePoints × ConversionRate × Price<USD/YGG> × (1 + BonusRate)

Example Calculation

// User redeems 5,000 points
GamePoints = 5000
 
// 1 Point = 0.01 USD
ConversionRate = 0.01
 
// 1 YGG = 0.15 USD
Price<YGG/USD> = 0.15
Price<USD/YGG> = 1 / 0.15
 
// 2% bonus for redemptions >= 5,000 points
BonusRate = 0.02
 
// Final calculation
YGGAmount = (5000 × 0.01 × (1 / 0.15)) × (1 + 0.02) = 340 YGG

Quick Start

Integration Checklist

• Read the Authentication requirements
• Implement the required APIs
• Test with YGG development team
• Configure production endpoints
• Go live! 🎉