Vendor APIs overview

A vendor is a third party you want to pay a portion of a customer payment to (a marketplace seller, a delivery partner, a content creator). Omniware needs each vendor's bank or UPI details before it can route money to them.

Lifecycle

1. Add the vendor

   Call Add Vendor with their identity + bank/UPI details. The vendor is created in a non-approved state.

2. Omniware approves

   Omniware reviews and approves vendors out-of-band for security. You cannot split payments to an unapproved vendor.

3. (Optional) Add more accounts

   A vendor can have multiple settlement accounts. Use Add Vendor Account and toggle the default_account flag to pick which one receives payouts.

4. Reference in splits

   Use vendor_code in Payment Request split_info or Split Settlement.

5. Modify or delete

   Edits via Modify Vendor re-trigger approval. Deletion is supported via Delete Vendor — pending payouts are preserved.

All endpoints

Endpoint	Purpose
Add Vendor	Create a new vendor.
Modify Vendor	Update vendor details. Re-triggers approval.
Add Vendor Account	Add a settlement account to an existing vendor.
Delete Vendor	Remove a vendor. Pending payouts still settle.
Get Vendor	Look up vendor details.