Skip to main content
PATCH
/
marketplace
/
settings
curl -X PATCH https://api.khaime.com/api/v1/partner/marketplace/settings \
  -H "X-API-Key: pk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "notification_config": {
      "send_sub_merchant_notifications": false
    }
  }'

Documentation Index

Fetch the complete documentation index at: https://docs.khaime.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Update Marketplace Settings

Control which payment notification emails Khaime sends on behalf of your marketplace. By default, Khaime sends payment receipts to sub-merchants and payment confirmation emails to buyers after every successful charge. Use this endpoint to disable either or both.

​
Request Body

​
notification_config
object
required
Notification settings to update. At least one key is required.

​
Response

{
  "status": true,
  "message": "Marketplace settings updated successfully",
  "data": {
    "notification_config": {
      "send_sub_merchant_notifications": false,
      "send_buyer_notifications": true
    }
  }
}

​
Behavior

Settings are merged — you can update one key without affecting the other. Unset keys default to true at send time, so omitting a key from this call does not disable that notification.
send_sub_merchant_notificationsEffect
true (default)Sub-merchants receive a receipt email when a charge on their behalf is settled
falseSub-merchant receipt emails are suppressed across all payment gateways
send_buyer_notificationsEffect
true (default)Buyers receive a payment confirmation email after each successful charge
falseBuyer confirmation emails are suppressed across all payment gateways
These settings apply across all three payment gateways (Stripe, Paystack, StartButton). Changes take effect on the next incoming webhook — there is no retroactive sending or suppression.

​
Error Codes

StatusErrorFix
401UnauthorizedProvide a valid X-API-Key header
403This endpoint is restricted to marketplace operatorsYour account must have marketplace mode enabled
422"notification_config" must contain at least one settingInclude at least one key in notification_config
curl -X PATCH https://api.khaime.com/api/v1/partner/marketplace/settings \
  -H "X-API-Key: pk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "notification_config": {
      "send_sub_merchant_notifications": false
    }
  }'