​

Delete Merchant

​

Path Parameters

​

Response

​

Successful Deletion (merchant account also deleted)

{
  "success": true,
  "message": "Sub-merchant deleted successfully",
  "data": {
    "account_skipped": false,
    "account_balance": null
  }
}

​

Successful Deletion (merchant account skipped due to balance)

{
  "success": true,
  "message": "Sub-merchant deleted successfully. Note: merchant account was not deleted because it has a balance of 150.00 USD. Please drain the balance manually before deleting the merchant account.",
  "data": {
    "account_skipped": true,
    "account_balance": {
      "amount": 150.00,
      "currency": "USD"
    }
  }
}

​

Response Fields

​

Behavior

1. Validates Relationship — Confirms the merchant belongs to your marketplace
2. Checks Account Balance — Retrieves the connected account’s available and pending balance
3. Deletes Connected Account — If balance is zero, permanently deletes the connected account
4. Removes Marketplace Link — Deletes the MarketplaceMerchant relationship record
5. Clears Portfolio — Removes marketplace references from the merchant’s portfolio
6. Deletes Business Data — Removes all associated data including:
   • Products and variations
   • Orders and transactions
   • Wallet and withdrawal records
   • Customer data
   • Forms and responses
   • Website configurations
   • All other business-related records

​

Connected Account Handling

• Balance = 0: The merchant account is permanently deleted
• Balance > 0: Account deletion is skipped, but all other data is still deleted. The response includes account_skipped: true and the balance details

​

Use Cases

• Removing a merchant who has violated marketplace terms
• Cleaning up test merchant accounts
• Merchant-requested account deletion for compliance (GDPR, etc.)

​

Comparison with Remove Merchant

​

Error Codes

curl -X DELETE https://api.khaime.com/api/v1/marketplace/merchants/1676/delete \
  -H "X-API-Key: pk_live_your_key"

const response = await fetch(
  'https://api.khaime.com/api/v1/marketplace/merchants/1676/delete',
  {
    method: 'DELETE',
    headers: {
      'X-API-Key': 'pk_live_your_key'
    }
  }
);

const result = await response.json();

if (result.data.account_skipped) {
  console.log(`merchant account has balance: ${result.data.account_balance.amount} ${result.data.account_balance.currency}`);
}

import requests

response = requests.delete(
    'https://api.khaime.com/api/v1/marketplace/merchants/1676/delete',
    headers={'X-API-Key': 'pk_live_your_key'}
)

result = response.json()

if result['data']['account_skipped']:
    balance = result['data']['account_balance']
    print(f"merchant account has balance: {balance['amount']} {balance['currency']}")