Payouts overview
The Payouts (Fund Transfer) APIs let your application initiate NEFT and IMPS transfers programmatically. You pre-fund a disbursement balance with Omniware and then call the Fund Transfer API to move money out.
Prerequisites
- Maintain a disbursement balance
Your Omniware disbursement account must hold sufficient funds. Load funds from one of your whitelisted source bank accounts (see Fund loading whitelisting).
- Get your API key + salt
Issued at onboarding. The Payouts product uses the same hash algorithm as Payments — see Hash calculation.
- Decide transfer rails
IMPS for amounts ≤ ₹2 lakh and 24×7 instant credit; NEFT for anything above, or when IMPS is unavailable.
All endpoints
| Endpoint | Purpose |
|---|---|
| Fund Transfer | Initiate a payout. |
| Fund Transfer Status | Reconcile a prior payout by your reference number. |
| Get Balance | Check the current disbursement balance. |
| Get Statement | Pull credits + debits over a date range. |
| Whitelist source account (merchant) | Approve a source bank account to load funds for this merchant. |
| Whitelist source account (team) | Approve a source account across all merchants in the team. |
| S2S callback | Receive payout outcomes server-to-server. |
| Credit notification | Receive notifications when an e-collect virtual account is funded. |
Status model
| Status | Meaning | Action |
|---|---|---|
PROCESSING | Disbursement in progress. | Query status until terminal. |
INCOMPLETE | Same as PROCESSING. | Query status until terminal. |
PENDING | Same as PROCESSING. | Query status until terminal. |
SENT_TO_BENEFICIARY | Initiated from source bank; awaiting confirmation. | Query status until terminal. |
SUCCESS | Settled at the beneficiary. | Terminal. Mark paid. |
FAILED / FAILURE | Bank rejected the disbursement. See error_message. | Terminal. Mark failed; retry with a fresh merchant_reference_number if needed. |
RETURNED_FROM_BENEFICIARY | Beneficiary's bank rejected the credit. | Terminal. Funds returned to your disbursement balance. |
Full status reference: Disbursement statuses.