Skip to main content

Get Vendor

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

Request parameters

api_keystring (36)required
vendor_codestring (30)required

The vendor code you assigned at creation time. Must exist — the API errors otherwise.

hashstring (255)required

Computed as:

toUpper(sha512(SALT|api_key|vendor_code))

Response

{
"data": {
"vendor_code": "5d1ee6743a3asd2d476a669b",
"vendor_name": "Sindhu",
"vendor_contact_email": "sharathkumar@example.com",
"vendor_contact_num": "9900990099",
"vendor_contact_address": "Domlur, Indira Nagar, Bangalore",
"vendor_pan": "ARSPH1234Q",
"vendor_approved": "y",
"vendor_split_percentage": null,
"vendor_split_amount": null,
"earliest_settlement_time_frame": null,
"latest_settlement_time_frame": null,
"vendor_logo": null,
"qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJMAAACTAQMAAAAC...",
"bank_accounts": [
{
"account_id": 3288,
"account_name": "Dummy",
"account_number": "1000000001",
"ifsc_code": "UTIB0000003",
"bank_name": "Dummy Bank",
"bank_branch": "Demo Road",
"upi_id": null,
"bank_approved": "y",
"default_account": "y"
}
]
}
}

Field reference

FieldDescription
vendor_codeYour unique identifier for the vendor.
vendor_nameDisplay name.
vendor_contact_email / vendor_contact_num / vendor_contact_addressContact info.
vendor_panPAN, if supplied.
vendor_approvedy if Omniware has approved the vendor and splits can be sent. Otherwise n — modifications and new vendors start non-approved.
vendor_split_percentage / vendor_split_amountDefault split if configured on the dashboard.
earliest_settlement_time_frame / latest_settlement_time_frameSettlement window configuration.
vendor_logoURL to the uploaded vendor logo.
qr_codeBase64 BharatQR image, present only if activate_bharat_qr=y was set at creation.
bank_accountsArray of all settlement accounts linked to the vendor.

Each entry in bank_accounts carries account_id (use this with Modify Vendor to update a specific account), bank or UPI details, bank_approved (y if Omniware has cleared the account), and default_account (y for the one account that receives payouts).