Skip to main content

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

FieldTypeDescription
id
REQUIRED
stringUnique identifier for the merchant
name
REQUIRED
stringBusiness or display name
email
REQUIRED
stringPrimary email address
phone
OPTIONAL
stringContact phone number
logo
OPTIONAL
stringURL to the merchant's logo
website
OPTIONAL
stringBusiness website URL
description
OPTIONAL
stringBrief description of the business
businessType
OPTIONAL
stringType of business (e.g., 'ecommerce', 'saas', 'marketplace')
country
OPTIONAL
stringTwo-letter ISO country code where the business is registered
timezone
OPTIONAL
stringTimezone identifier (e.g., 'America/New_York')
defaultCurrency
OPTIONAL
stringDefault currency for transactions
kycStatus
OPTIONAL
KycStatusKYC verification status KycStatus
isActive
REQUIRED
booleanWhether the merchant account is active
createdAt
REQUIRED
stringISO 8601 timestamp when the merchant was created
updatedAt
REQUIRED
stringISO 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"
}