Skip to main content

​
The All-in-One Payments Platform for SMEs

Omnispay helps small businesses manage their cash flow effectively by simplifying how they collect, pay, and borrow. With a robust payment infrastructure, Omnispay enables seamless transactions while ensuring security, scalability, and reliability. 🔗 Visit our website: Omnispay

​
Custom Response Codes

CodeMessage
00SUCCESS
90Blocked user
91Empty Request Body
92Bad Request
93Data not found
96Not Acceptable
97Payment Gateway Failure
99Unable to process the request.

​
Transaction Limits

CodeMessage
90Account Blocked
99Monthly transaction limit exceeded
99Per transaction limit exceeded

​
Standard HTTP Response Codes

CodeMessageDescription
200OKEverything worked as expected.
201CreatedThe request has been fulfilled, and a new resource has been created.
204No ContentThe request was successful, but there is no response body.
400Bad RequestThe request was unacceptable, often due to missing a required parameter.
401UnauthorizedNo valid API key provided.
402Request FailedThe parameters were valid, but the request failed.
403ForbiddenThe API key doesn’t have permissions to perform the request.
404Not FoundThe requested resource doesn’t exist.
405Method Not AllowedThe requested HTTP method is not supported.
409ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
415Unsupported Media TypeThe media format of the requested data is not supported.
422Unprocessable EntityThe request was well-formed but contains semantic errors.
429Too Many RequestsToo many requests hit the API too quickly. We recommend an exponential backoff.
500Internal Server ErrorSomething went wrong on the server’s end.
502Bad GatewayThe server received an invalid response from an upstream server.
503Service UnavailableThe server is temporarily unavailable.
504Gateway TimeoutThe server did not receive a timely response from an upstream server.

​
Card Types

TypeDescription
VisaPopular global payment card
MasterCardWidely accepted credit card
American ExpressPremium credit card service
DiscoverU.S.-based payment network
JCBJapanese payment card
Diners ClubTravel-focused credit card

​
Supported Currency

The available currency codes on your account are determined by the merchant accounts you have with your acquiring bank. You can only process transactions in those currencies. Submitting a transaction request in a currency that is not available on your account will result in the request being rejected.

​
Available Currencies

CodeDescription
AEDUnited Arab Emirates Dirham

​
🧾 Documenting Parent-Child Merchant Relationship Flow

This document explains how parent-level API keys work to authenticate merchants using apikey and accountId.

​
🔑 How Parent-Level API Keys Work

  1. Parent-Level API Key Usage
    • A payment aggregator holds a parent API key that is used to process payments on behalf of multiple merchants (sub-merchants).
  2. Why Passing accountId is Recommended
    • Helps track which merchant initiated the transaction (auditability).
    • Avoids mistakes where a request for one merchant goes to another.
    • Enables specific rate limits and security policies for each merchant.

​
❓ Which accountId Should Be Passed in the Header?

  • If the parent (API key owner) is acting on behalf of a child merchant, send the child’s accountId in the request.
  • If a merchant is calling on their own, use their own accountId.
  • If accountId is missing:
    • Reject the request.