Update Vendor Status

Update the status of a specific vendor. Use this endpoint to activate, deactivate, or suspend a vendor.

PATCHhttps://api.zenpayz.com/merchant/api/v1/vendors/:id/status

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)

Body Parameters

Parameter	Type	Description
status REQUIRED	string	New status (active, inactive, suspended, pending)
reason OPTIONAL	string	Reason for the status change
adminComment OPTIONAL	string	Internal admin comment

Response

Success (200 OK)

{
  "success": true,
  "data": {
    "vendorId": "vnd_a1b2c3d4e5f6g7h8",
    "previousStatus": "active",
    "status": "suspended",
    "reason": "Compliance review required",
    "adminComment": "Flagged during quarterly audit",
    "updatedAt": "2024-03-21T14:00:00.000Z"
  },
  "message": "Vendor status updated successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-03-21T14:00:00.000Z",
    "processing_time_ms": 90,
    "api_version": "v1",
    "endpoint": "PATCH /vendors/:id/status",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
VALIDATION_ERROR	400	Invalid status value
UNAUTHORIZED	401	Invalid API key
VENDOR_NOT_FOUND	404	Vendor with specified ID does not exist
INVALID_STATUS_TRANSITION	409	Status transition is not allowed

Examples

cURL

curl -X PATCH https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/status \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-03-21T14:00:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "suspended",
    "reason": "Compliance review required",
    "adminComment": "Flagged during quarterly audit"
  }'

JavaScript

const response = await fetch('https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8/status', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    status: 'suspended',
    reason: 'Compliance review required',
    adminComment: 'Flagged during quarterly audit',
  }),
});

const result = await response.json();
console.log(result.data.previousStatus); // active
console.log(result.data.status); // suspended

SDK

const result = await zenpays.vendors.updateStatus('vnd_a1b2c3d4e5f6g7h8', {
  status: 'suspended',
  reason: 'Compliance review required',
  adminComment: 'Flagged during quarterly audit',
});

console.log(result.previousStatus); // active
console.log(result.status); // suspended

Related Endpoints

• Get Vendor
• Update Vendor
• Update Vendor KYC