Skip to main content

Add Vendor

POST https://pgbiz.omniware.in/v2/addvendor
Content-Type: application/x-www-form-urlencoded

The new vendor is non-approved by default. Omniware approves vendors out-of-band before they can receive split payouts.

Request parameters​

api_keystring (36)required
vendor_codestring (30)required
Unique alphanumeric identifier you assign to the vendor.
vendor_namestring (100)required
vendor_contact_emailstring (200)required
vendor_contact_numstring (10)required
vendor_contact_addressstring (300)

Bank or UPI (at least one)​

account_namestring (300)
Optional if UPI is given.
account_numberstring (50)
Optional if UPI is given.
ifsc_codestring (50)
Optional if UPI is given.
bank_namestring (200)
Optional if UPI is given.
bank_branchstring (300)
Optional if UPI is given.
upi_idstring (50)
Optional if bank details are given.

Optional metadata​

vendor_panstring (10)
description_1string (200)
description_2string (200)
activate_bharat_qrstring (1)
y to generate a BharatQR for the vendor.
aadhar_numberstring (12)
Required if activate_bharat_qr=y.
hashstring (200)required

Compute over only the fields you actually send. Omitted optional fields must not appear in the hash input.

Sample request​

curl -X POST https://pgbiz.omniware.in/v2/addvendor \
  -d "api_key=$API_KEY" \
  -d "vendor_code=2VEN449" \
  -d "vendor_name=Acme Seller" \
  -d "vendor_contact_email=seller@acme.com" \
  -d "vendor_contact_num=9999988888" \
  -d "account_name=Acme Seller LLP" \
  -d "account_number=000123456789" \
  -d "ifsc_code=HDFC0000001" \
  -d "hash=$HASH"

Response​

{
  "data": {
    "code": "SUCCESS",
    "account_id": "0026",
    "message": "Vendor is added Successfully",
    "static_qr_code": "..."
  }
}

static_qr_code is the BharatQR base64 image, returned only if you set activate_bharat_qr=y.

If the vendor code is already taken by an approved active vendor:

{ "error": { "code": 1024, "message": "Vendor code already exists" } }
note

If the existing vendor is inactive or non-approved, Add Vendor will overwrite their details and re-submit for approval instead of erroring.