Skip to main content

Modify Vendor

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

Modifying an active approved vendor instantly disapproves them. Splits to that vendor fail until Omniware re-approves. Plan changes carefully.

Request parameters

api_keystring (36)required
vendor_codestring (30)required

Must already exist in Omniware. The API errors if not.

Vendor identity (all optional)

vendor_namestring (100)
vendor_contact_emailstring (200)
vendor_contact_numstring (10)
vendor_contact_addressstring (300)
vendor_panstring (10)
description_1string (200)
description_2string (200)
activate_bharat_qrstring (1)
y to (re)generate a BharatQR for the vendor.
aadhar_numberstring (12)
Required if activate_bharat_qr=y.

Settlement account (all optional)

This is the account that will receive splits. Pass account_id to target a specific existing account; omit it to update the last-approved account.

account_idstring (10)

The account_id returned by Add Vendor or Add Vendor Account. Identifies which settlement account to modify.

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

Signature

hashstring (200)required

Compute the hash over only the fields you are actually sending — omitted optional fields must not appear in the hash input. Keys are sorted alphabetically before joining. See Hash calculation.

Response

{
"data": {
"code": "SUCCESS",
"message": "Vendor Details Updated Successfully"
}
}

Errors

If the vendor_code doesn't exist, Omniware returns an error — Modify Vendor never auto-creates a vendor.

{
"error": {
"code": 1024,
"message": "Vendor code not found"
}
}