Update Vendor

Update an existing vendor's information. All fields are optional; only provided fields will be updated.

PUThttps://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)

Body Parameters

Parameter	Type	Description
name OPTIONAL	string	Vendor display name
description OPTIONAL	string	Vendor description
email OPTIONAL	string	Vendor email address (must be valid email)
phone OPTIONAL	string	Vendor phone number
website OPTIONAL	string	Vendor website URL
status OPTIONAL	string	Status (active, inactive, suspended, pending)
contactInfo OPTIONAL	object	Contact information object
businessInfo OPTIONAL	object	Business information
commissionRate OPTIONAL	number	Commission rate (0-100)
commissionType OPTIONAL	string	Commission model (percentage, fixed, tiered)
commissionConfig OPTIONAL	object	Additional commission configuration
riskLevel OPTIONAL	string	Risk classification (low, medium, high, critical)
payoutFrequency OPTIONAL	string	Payout schedule (weekly, monthly, quarterly)
bankDetails OPTIONAL	object	Bank account for payouts
environment OPTIONAL	string	Environment identifier
metadata OPTIONAL	object	Custom key-value pairs

Response

Success (200 OK)

{
  "success": true,
  "data": {
    "vendorId": "vnd_a1b2c3d4e5f6g7h8",
    "name": "Acme Referrals",
    "description": "Updated partner description",
    "email": "partners@acmereferrals.com",
    "phone": "+14155559999",
    "website": "https://acmereferrals.com",
    "status": "active",
    "contactInfo": {
      "primaryContact": {
        "firstName": "Sarah",
        "lastName": "Chen",
        "email": "sarah.chen@acmereferrals.com",
        "phone": "+14155551235",
        "designation": "VP of Partnerships"
      },
      "address": {
        "street": "100 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      }
    },
    "businessInfo": {
      "registrationNumber": "REG-2024-78901",
      "taxId": "87-6543210",
      "businessType": "LLC",
      "incorporationDate": "2020-03-15",
      "monthlyVolume": 750000
    },
    "commissionRate": 15.0,
    "commissionType": "percentage",
    "commissionConfig": null,
    "riskLevel": "low",
    "payoutFrequency": "monthly",
    "bankDetails": {
      "accountNumber": "****6789",
      "routingNumber": "****4321",
      "bankName": "First National Bank",
      "swiftCode": "FNBKUS33",
      "beneficiaryName": "Acme Referrals LLC",
      "accountType": "current",
      "payoutType": "wire"
    },
    "environment": "production",
    "metadata": {},
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-03-21T11:00:00.000Z"
  },
  "message": "Vendor updated successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-03-21T11:00:00.000Z",
    "processing_time_ms": 110,
    "api_version": "v1",
    "endpoint": "PUT /vendors/:id",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
VALIDATION_ERROR	400	Invalid request parameters
UNAUTHORIZED	401	Invalid API key
VENDOR_NOT_FOUND	404	Vendor with specified ID does not exist
DUPLICATE_VENDOR	409	Another vendor with this email already exists

Examples

cURL

curl -X PUT https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8 \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-03-21T11:00:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -d '{
    "commissionRate": 15.0,
    "phone": "+14155559999",
    "businessInfo": {
      "monthlyVolume": 750000
    },
    "contactInfo": {
      "primaryContact": {
        "designation": "VP of Partnerships"
      }
    }
  }'

JavaScript

const response = await fetch('https://api.zenpayz.com/merchant/api/v1/vendors/vnd_a1b2c3d4e5f6g7h8', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    commissionRate: 15.0,
    phone: '+14155559999',
    businessInfo: {
      monthlyVolume: 750000,
    },
    contactInfo: {
      primaryContact: {
        designation: 'VP of Partnerships',
      },
    },
  }),
});

const result = await response.json();
console.log(result.data.commissionRate); // 15.0

SDK

const vendor = await zenpays.vendors.update('vnd_a1b2c3d4e5f6g7h8', {
  commissionRate: 15.0,
  phone: '+14155559999',
  businessInfo: {
    monthlyVolume: 750000,
  },
  contactInfo: {
    primaryContact: {
      designation: 'VP of Partnerships',
    },
  },
});

console.log(vendor.commissionRate); // 15.0

Related Endpoints

• Get Vendor
• Update Vendor Status
• Update Vendor KYC
• Delete Vendor