Interactive guide to building deposit URLs
Basic deposit page with user email and platform
/deposit?user=john@example.com&platform=myshopuser Requiredjohn@example.complatform RequiredmyshopSpecify expected payment amount (triggers payment tracking)
/deposit?user=alice@example.com&platform=myshop&dollars=50user Requiredalice@example.complatform Requiredmyshopdollars Optional50Redirect user after successful payment
/deposit?user=bob@example.com&platform=myshop&dollars=100&callback=https://myshop.com/payment-successuser Requiredbob@example.complatform Requiredmyshopdollars Optional100callback Optionalhttps://myshop.com/payment-successAll parameters for full payment flow
/deposit?user=customer@example.com&platform=myshop&dollars=250.50&callback=https://myshop.com/success?order=12345user Requiredcustomer@example.complatform Requiredmyshopdollars Optional250.50callback Optionalhttps://myshop.com/success?order=12345User's email or unique identifier
user=john@example.comYour registered platform name
platform=myshopExpected payment amount (triggers auto-redirect)
dollars=50.00URL to redirect after successful payment
callback=https://...Include dollars parameter to enable automatic payment verification and callback after the exact amount is received.
Set callback in URL or configure frontend_callback_url during platform registration for automatic user redirects.
Always URL-encode parameter values, especially emails and URLs with special characters.
All deposit pages are mobile-optimized. Users can scan QR codes or copy addresses easily.
Once registered, platforms can use these APIs to manage deposits and transactions
/api/platform/balance?user_id=USER_ID Get total balance and transaction summary for a specific user
curl -X GET 'https://yourapp.com/api/platform/balance?user_id=brinisremote@gmail.com' \
-H 'x-api-key: YOUR_API_KEY'{
"success": true,
"user_id": "user123",
"balance": {
"total_deposited": 150.50,
"completed": 150.50,
"pending": 0
},
"transactions": {
"total": 3,
"completed": 3,
"pending": 0
}
}/api/platform/transactions?user_id=USER_ID&time_range=1h Retrieve transaction history with filters
user_id - Filter by user (optional)time_range - 1h, 24h, 7d, 30d (default: 24h)status - pending or completedlimit - Results per page (default: 100)offset - Pagination offset (default: 0)curl -X GET 'https://yourapp.com/api/platform/transactions?user_id=brinisremote@gmail.com&time_range=1h' \
-H 'x-api-key: YOUR_API_KEY'{
"success": true,
"filters": {
"user_id": "user123",
"time_range": "1h",
"status": "all"
},
"pagination": {
"total": 2,
"limit": 100,
"offset": 0,
"has_more": false
},
"transactions": [
{
"id": 123,
"user_id": "user123",
"amount": 50.01,
"token": "USDT",
"blockchain": "BSC",
"status": "completed",
"tx_hash": "0x123...",
"created_at": "2025-12-21T10:30:00Z"
}
]
}/api/platform/verify Verify if a payment was received and forwarded
curl -X POST 'https://yourapp.com/api/platform/verify' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"deposit_id": "123",
"user_id": "brinisremote@gmail.com"
}'deposit_id - Deposit ID (use this OR tx_hash)tx_hash - Transaction hash (alternative)user_id - User identifier (optional){
"success": true,
"verified": true,
"deposit": {
"id": 123,
"user_id": "user123",
"amount": 50.01,
"token": "USDT",
"blockchain": "BSC",
"status": "completed",
"tx_hash": "0x123...",
"forwarded_at": "2025-12-21T10:35:00Z",
"forwarded_tx_hash": "0xabc..."
},
"message": "Payment verified and forwarded successfully"
}All API requests require your API key in the x-api-key header:
-H 'x-api-key: YOUR_API_KEY_HERE'⚠️ Keep your API key secure! Never expose it in client-side code.
Use GET /balance to verify user has sufficient funds before processing withdrawals
Use GET /transactions to show users their deposit history in your dashboard
Use POST /verify to confirm deposits received through callbacks are legitimate
Poll GET /transactions?time_range=1h to monitor recent deposits