Introduction

Omniware is a full-stack payments platform that lets you accept money, send money, bill customers, and onboard sub-merchants from a single set of APIs.

This documentation covers every endpoint you'll need to integrate.

💳Payments

Accept payments via cards, UPI, net banking, wallets, EMI, BharatQR, and more on a hosted page or seamlessly on your own UI.

💸Payouts

Disburse funds to vendors and customers over NEFT/IMPS with real-time status callbacks.

🧾Invoicing

Programmatically create, dispatch, and reconcile invoices that customers pay through a hosted link.

🧑‍💼Merchant Onboarding

Register sub-merchants on Omniware from your own dashboard with an encrypted API.

How the platform fits together

_{Solid arrows are synchronous API calls. Dotted arrows are asynchronous callbacks Omniware fires back to your server.}

What every Omniware API has in common

1. HTTPS POST

   All endpoints accept POST over HTTPS. Most expect application/x-www-form-urlencoded; a few accept JSON (noted per endpoint).

2. api_key + hash auth

   Every request includes your api_key and a SHA-512 hash of the request parameters salted with your salt. See Authentication and Hash calculation.

3. JSON responses

   Responses are JSON. Successful responses contain a data object; failures contain an error object with code and message. See Error handling.

4. Verify the response hash

   Many endpoints return a hash in the response. Recompute it on your side to defend against tampering before treating the response as final.

Get your credentials

You'll need four secrets to integrate. They are issued by Omniware at onboarding and visible in your dashboard.

Credential	Purpose
api_key	Identifies your merchant account on every request.
salt	Used in SHA-512 hash calculations. Server-side only.
encryption_key	AES key for encrypting payment requests (when using encrypted variants).
decryption_key	AES key for decrypting payment responses returned on return_url.

warning

Treat salt, encryption_key, and decryption_key like passwords. Never expose them in HTML forms, mobile binaries, or client-side JavaScript.

Next steps

⚡Quickstart

Make your first payment request in under 10 minutes.

🖥Environments

Test vs. live URLs and how to switch between them.