Starting Without Integration: The Portal Approach
Most RynoWallet merchants start with the web portal. They open the merchant portal on their phone browser after each customer payment, enter the phone number and bill amount, and issue coins. This manual workflow takes about 10 seconds and requires no technical setup whatsoever.
For shops with 10 to 30 customers per day, the portal approach is perfectly adequate. The 3 to 5 minutes of daily time investment is minimal, and the workflow quickly becomes habitual.
But for higher-volume merchants—those processing 50 to 200+ transactions per day—manual issuance adds meaningful operational overhead. And for merchants who want coins issued automatically the moment a bill is generated, without any manual step, the REST API is the answer.
RynoWallet Is Built API-First
Every action available in the merchant portal is also available via the REST API. This includes:
- Issue coins to a customer (by phone number or wallet ID)
- Process a redemption (deduct coins from a customer's balance)
- Check a customer's current balance
- Look up a customer by phone number or QR code
- View the transaction ledger
- Check the merchant's current MIR ratio and issuance statistics
All API responses are in standard JSON format. Authentication uses JWT tokens, which are generated from your merchant dashboard under Developer and API Keys. The API follows standard REST conventions—GET for read operations, POST for write operations, with consistent URL patterns and error codes.
The Integration Workflow
Step 1: Generate Your API Key
From your merchant dashboard, navigate to the Developer section and generate an API key. This key is used as a Bearer token in the Authorization header of every API request. Keep it secure—treat it like a password.
Step 2: Identify Your Integration Point
In your billing software, identify where a bill is finalized and payment is confirmed. This is the trigger point for coin issuance. In Tally, this might be the voucher save event. In Vyapar, it might be the invoice creation event. In a custom POS, it might be the payment confirmation callback.
Step 3: Implement the Issuance Call
After payment confirmation, your billing software makes a POST request to the RynoWallet issue endpoint with the following parameters:
- Customer phone number (from your billing record)
- Bill amount (to let RynoWallet calculate coins based on your earning rules)
- Coins to issue (or omit this to let RynoWallet auto-calculate from your rules)
- Transaction reference (optional, for your own audit trail)
The API returns a success response with the coins issued and the customer's new balance. The entire call completes in under 200 milliseconds.
Step 4: Implement the Balance Check and Redemption Flow
When a customer wants to redeem coins, your POS queries the balance endpoint with the customer's phone number or QR code. The balance is returned. You confirm with the customer how many coins to redeem, then make a POST request to the redemption endpoint.
The redemption endpoint deducts the specified coins and returns the updated balance. Your POS adjusts the bill total accordingly.
Step 5: Test in Sandbox
RynoWallet provides sandbox credentials for testing. Use the sandbox environment to test your integration end-to-end before going live. The sandbox accepts all valid API requests and returns realistic responses without affecting real customer balances.
Compatible Systems
RynoWallet's API is compatible with any system that can make HTTP requests. Specifically tested and documented integrations include:
- Tally ERP 9 and Tally Prime: Via TallyPrime's API framework or post-voucher scripts
- Vyapar: Via webhook triggers on invoice creation
- Khatabook: Via API hooks in the Khatabook business app
- Custom billing software: Any software that can make HTTP calls
- Shopify and WooCommerce: For merchants with e-commerce stores alongside physical shops
- Any POS with webhook support: Standard REST integration
For systems that do not natively support HTTP calls but have scripting capabilities, lightweight integration scripts in Python, Node.js, and PHP are available in the RynoWallet developer documentation.
Security and Audit
All API calls are authenticated via JWT tokens. Tokens can be rotated at any time from the merchant dashboard. Every API transaction is logged with a full audit trail—timestamp, customer ID, coins issued or redeemed, and transaction reference. This audit trail is accessible from the dashboard and is essential for reconciliation and dispute resolution.
The API uses HTTPS for all communication. No coin issuance or redemption is possible without a valid, authenticated API key. This security architecture ensures that your loyalty data is protected even in automated integration scenarios.
👉 Access full API documentation at rynowallet.com/api/docs.