Skip to main content
PATCH

Intro

Updates a sub-merchant’s profile fields and/or this marketplace’s commission rate for that merchant, in a single partial update.

Context

Sits between Get Merchant Details (read) and Remove Merchant (suspend) in the merchant lifecycle. This endpoint changes the merchant’s own Khaime profile and this marketplace’s commission override for them specifically — for your own marketplace’s profile or default commission rate, use Update Marketplace Settings instead. For a one-off commission-only change, Update Commission does the same commission update without touching profile fields.

Hows

Path Parameters

string
required
The business ID of the sub-merchant to update.

Request Body

At least one field is required.
string
Sub-merchant business name.
string
Sub-merchant email address. Must be unique across Khaime accounts.
string
Sub-merchant public phone number.
string
Sub-merchant country name.
string
2-letter ISO country code, for example NG, US, or GB.
string
Sub-merchant website URL. Must be a full absolute URL.
string
Public sub-merchant description.
number
Commission rate for this marketplace-merchant relationship, expressed as a decimal between 0 and 1. For example, send 0.12 for 12%.

Response

Behavior

This endpoint only updates merchants that are actively linked to your marketplace — a suspended relationship must be reactivated first (see Link Merchant). Profile fields update the sub-merchant’s Khaime business profile and public portfolio fields. commission_rate updates the commission override for this specific marketplace-merchant relationship only; it does not touch your marketplace’s default rate.

Error Codes

Requests that fail Khaime’s schema validation (missing all fields, invalid email format, commission_rate out of range) return 422. Requests that fail an application-level check (merchant ID shape, email already taken) return 400.

Whys

Profile fields and commission rate are combined into one PATCH because operators frequently update both together (e.g., correcting a merchant’s contact details while also renegotiating their rate) — splitting them into separate calls would add round trips for a common workflow. The endpoint is deliberately scoped to your marketplace’s relationship with the merchant: it can’t be used to reach into a merchant’s account for fields unrelated to how they operate under your marketplace.

Why nots

This does not create a new merchant or relationship — it only updates an existing active one. It does not let you change a merchant’s password, payout configuration, or KYC status; those go through their dedicated endpoints. It also does not update your marketplace’s own default commission rate — that’s Update Marketplace Settings.