Starship Rewards API

Wallets Overview

Manage client wallets for multi-currency transactions and balance tracking

Wallets Overview

The Starship Rewards Wallet system provides comprehensive multi-currency wallet management for clients, enabling secure storage and tracking of funds across different currencies for voucher purchases and reward redemptions.

Wallet System Features

Multi-Currency Support Each client can maintain separate wallets for different currencies, enabling seamless transactions in local and international currencies without complex forex conversions during purchases.

Real-time Balance Tracking Monitor wallet balances in real-time with atomic transaction processing ensuring accurate balance updates and preventing overdrafts or double-spending scenarios.

Transaction History Complete audit trail of all wallet transactions including deposits, withdrawals, purchases, and refunds with detailed metadata for reconciliation and reporting.

Security & Compliance Enterprise-grade security with encryption at rest, secure transaction processing, and comprehensive audit logging for regulatory compliance and financial reporting.

Wallet Types

Prepaid Wallets

Primary wallet type for storing client funds used for purchasing products. Supports both manual funding and automated top-ups with configurable limits and thresholds.

Reward Wallets

Dedicated wallets for storing earned rewards, cashback, and promotional credits. Can be configured with specific usage rules and expiration policies.

Corporate Wallets

Specialized wallets for enterprise clients with features like budget controls, approval workflows, and department-level sub-wallets for organizational spending management.

API Documentation

Wallets API

Core wallet operations including balance queries, wallet creation, and transaction management.

Key Operations:

  • List client wallets with filtering
  • Get wallet details and current balance
  • View transaction history
  • Check available balance for purchases

→ Wallets API Documentation

Transactions API

Detailed transaction operations for deposits, withdrawals, and transfers between wallets.

Key Operations:

  • Fund wallet via various payment methods
  • Process wallet-to-wallet transfers
  • Handle refunds and reversals
  • Query transaction status and history

→ Transactions API Documentation

Integration Guide

Quick Start

  1. Authentication: Obtain API credentials and authenticate your requests
  2. List Wallets: Query available wallets for your client account
  3. Check Balance: Verify sufficient funds before initiating purchases
  4. Process Transaction: Use wallet ID in order creation for payment

Best Practices

Balance Management

  • Always verify wallet balance before initiating transactions
  • Implement retry logic for transient failures
  • Cache wallet IDs to reduce API calls

Multi-Currency Handling

  • Use appropriate wallet based on product currency
  • Consider forex rates when funding wallets
  • Implement currency preference logic for user experience

Error Handling

  • Handle insufficient balance errors gracefully
  • Implement proper timeout and retry mechanisms
  • Log all transaction attempts for debugging

Security Considerations

API Security

  • Always use HTTPS for API communications
  • Rotate API keys regularly
  • Implement IP whitelisting for production environments

Transaction Security

  • Verify transaction amounts before processing
  • Implement idempotency keys for duplicate prevention
  • Use webhook notifications for transaction confirmations

Compliance

  • Maintain transaction logs for audit requirements
  • Implement KYC/AML checks as required
  • Follow regional financial regulations for stored value

Technical Specifications

Rate Limits

  • 1000 requests per minute for read operations
  • 100 requests per minute for write operations
  • Bulk operations count as single requests

Response Times

  • Average response time: < 200ms
  • 99th percentile: < 500ms
  • Timeout recommendation: 30 seconds

Data Retention

  • Transaction history: 7 years
  • Audit logs: 3 years
  • Inactive wallets: No expiration

Support Resources

For additional assistance with wallet integration:

  • Technical Documentation: Full API reference with examples
  • Integration Support: Contact our technical team
  • Status Page: Monitor API availability and performance
  • Developer Forum: Community support and best practices