The MerchantProfile object
Represents a merchant's profile in the ZenPays system. The merchant profile contains business information and configuration settings for payment processing.
Fields
| Field | Type | Description |
|---|---|---|
id REQUIRED | string | Unique identifier for the merchant |
name REQUIRED | string | Business or display name |
email REQUIRED | string | Primary email address |
phone OPTIONAL | string | Contact phone number |
logo OPTIONAL | string | URL to the merchant's logo |
website OPTIONAL | string | Business website URL |
description OPTIONAL | string | Brief description of the business |
businessType OPTIONAL | string | Type of business (e.g., 'ecommerce', 'saas', 'marketplace') |
country OPTIONAL | string | Two-letter ISO country code where the business is registered |
timezone OPTIONAL | string | Timezone identifier (e.g., 'America/New_York') |
defaultCurrency OPTIONAL | string | Default currency for transactions |
kycStatus OPTIONAL | KycStatus | KYC verification status KycStatus |
isActive REQUIRED | boolean | Whether the merchant account is active |
createdAt REQUIRED | string | ISO 8601 timestamp when the merchant was created |
updatedAt REQUIRED | string | ISO 8601 timestamp when the merchant was last updated |
Example
{
"id": "obj_1a2b3c",
"name": "string",
"email": "customer@example.com",
"phone": "string",
"logo": "string",
"website": "string",
"description": "string",
"businessType": "string",
"isActive": false,
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
}