Delete Vendor

Soft delete a vendor. The vendor record is marked as deleted but retained in the database for auditing purposes.

DELETEhttps://api.zenpayz.com/merchant/api/v1/vendors/:id

Bearer · API key

Request

Headers

Header	Description
Authorization REQUIRED	Bearer {api_key}
X-Signature REQUIRED	HMAC-SHA256 signature
X-Timestamp REQUIRED	ISO 8601 timestamp
X-Secret-Salt REQUIRED	Secret salt for HMAC validation
Content-Type REQUIRED	application/json

Path Parameters

Parameter	Type	Description
id REQUIRED	string	Vendor ID (e.g., vnd_a1b2c3d4e5f6g7h8)

Response

Success (200 OK)

{
  "success": true,
  "data": {
    "vendorId": "vnd_a1b2c3d4e5f6g7h8",
    "deleted": true,
    "deletedAt": "2024-03-21T12:00:00.000Z"
  },
  "message": "Vendor deleted successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-03-21T12:00:00.000Z",
    "processing_time_ms": 95,
    "api_version": "v1",
    "endpoint": "DELETE /vendors/:id",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
UNAUTHORIZED	401	Invalid API key
VENDOR_NOT_FOUND	404	Vendor with specified ID does not exist
VENDOR_HAS_ACTIVE_REFERRALS	409	Vendor cannot be deleted while active referrals exist

Examples

cURL

curl -X DELETE https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8 \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-03-21T12:00:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
});

const result = await response.json();
console.log(result.data.deleted); // true

SDK

const result = await zenpays.vendors.delete('vnd_a1b2c3d4e5f6g7h8');

console.log(result.deleted); // true

Related Endpoints

• Get Vendor
• Update Vendor Status
• List Vendors