ALPPAY Integration Guide
Step 1: System Registration
- Visit alppay.io and register as a merchant.
- Provide essential company information and contact details.
- Upon registration, the system automatically creates:
- Wallets in required currencies (USDT, BTC, ETH, and others)
- API Key
- HMAC Key
Step 2: Documentation Review
- Study the API documentation covering:
- Endpoints:
- Payment creation and retrieving existing payments list (docs.alppay.io/endpoints#payments)
- Withdrawal request creation and retrieving existing withdrawals list (docs.alppay.io/endpoints#withdrawals)
- Authorization protocol (HMAC)
- Limitations, limits, and security recommendations
- Endpoints:
- Documentation is available at: docs.alppay.io
Step 3: Support Request
Contact [email protected] with the following information:
- Company name and registered email address
- Request for HMAC Key for API request signing
- Your endpoint URLs for receiving Webhooks (docs.alppay.io/webhooks)
- Documents confirming company operations
- (If necessary) Link to your product demo or business model description
Step 4: Testing and API Connection
Prepare Testing Environment
- Ensure your server IP address is added to the whitelist (configured in personal account)
- IMPORTANT: API usage is impossible without IP address configuration!
API Testing
- Verify HMAC signature correctness and API Key
- Test webhook reception and processing (payment, partial payment, overpayment)
- Test invoice creation, confirmation, and cancellation
- Validate business logic on your side
Step 5: Pre-Production Preparation
Contact [email protected] for final pre-production verification:
- Production wallet verification
- Staking configuration (if necessary)
- Fee setup (fixed or percentage-based)
- API access configuration, limits, and security settings
Step 6: Production Deployment
After all parameters are approved:
- Execute first test payment in production mode
- Verify all webhooks are processed correctly
- Check invoice status display accuracy and logging
Step 7: Post-Integration Support
For technical or operational questions, contact [email protected].
Recommendations:
- Maintain logging of all API requests and responses
- Monitor webhook endpoint availability
- Stay updated with documentation and API version changes
Quick Start Checklist
- [ ] Register at alppay.io
- [ ] Review API documentation
- [ ] Contact support for HMAC Key
- [ ] Configure IP whitelist
- [ ] Test API endpoints
- [ ] Implement webhook handlers
- [ ] Complete pre-production verification
- [ ] Deploy to production
- [ ] Perform production test transaction
Important Security Notes
- Never share your API Key or HMAC Key publicly
- Always use HTTPS for webhook endpoints
- Implement request signature verification
- Store keys securely using environment variables
- Regularly rotate your API credentials
Common Integration Patterns
Payment Flow
- Customer initiates payment on your platform
- Your system creates payment via ALPPAY API
- Customer is redirected to payment page
- Customer completes cryptocurrency payment
- ALPPAY sends webhook notification
- Your system updates order status
Withdrawal Flow
- Merchant requests withdrawal via API
- ALPPAY validates request and credentials
- Withdrawal is processed to specified address
- Webhook notification sent upon completion
- Merchant system updates internal records
Support Resources
- Email: [email protected]
- Documentation: docs.alppay.io
- API Status: status.alppay.io
- Business Hours: 24/7 support available
Note: This guide provides general integration steps. Specific requirements may vary based on your business model and transaction volume. Contact our support team for customized integration assistance.