Your PaySight product ID that identifies your merchant account and product configuration.

productId: 123

A unique identifier for the payment session. This should be unique for each payment attempt.

sessionId: 'unique-session-xyz'

The payment amount in cents. For example, $29.99 would be represented as 2999.

amount: 2999 // $29.99

The environment to run the widget in. Use ‘sandbox’ for testing and ‘production’ for live payments.

environment: 'production' // or 'sandbox'

An array of field configuration objects that define form fields. Must include an email field.

fields: [
  {
    label: 'Email Address',
    placeholder: 'Enter your email',
    fieldType: 'email',
    position: 'above',
    size: 'full',
    required: true  // Email field is required
  }
]

Customer’s first name. Can be provided via customer object or a name field.

Customer’s last name. Can be provided via customer object or a name field.

Customer’s state/province. Can be provided via customer object or a state field.

Customer’s country code (e.g., ‘US’). Can be provided via customer object or a country field.

Enable 3D Secure authentication for the payment. Recommended for enhanced security.

threeDSRequired: true

Enable ecommerce mode with additional fields for shipping and billing information.

ecom: true

Set the language and region for the widget interface.

locale: 'fr-FR'

The currency code for the payment. Must be a valid ISO 4217 currency code.

currency: 'EUR'

Custom text for the payment button. Use this to match your brand voice or specific action.

buttonText: 'Subscribe Now'

Override the merchant ID for the payment. Requires special permissions.

midOverride: 'MID_NUMBER'

Additional custom data to include with the payment. Useful for tracking and analytics.

data: {
  // PaySight tracking parameters
  campaignId: 'cmpid',      // PaySight campaign identifier
  affiliateId: 'affid',    // PaySight affiliate identifier
  subAffiliateId: 'subid', // PaySight sub-affiliate identifier
  trackhouseClickId: 'trfk_id',  // PaySight tracking click identifier
  
  // Generic tracking
  clickId: 'ad-campaign-123',      // Generic click identifier
  
  
  // Custom data
  customData: {
    plan: 'premium',
    term: 'annual'
  }
}

PaySight campaign identifier for tracking marketing campaigns and their performance.

PaySight affiliate identifier for tracking specific affiliate partners.

PaySight sub-affiliate identifier for more granular affiliate tracking.

PaySight tracking click identifier for detailed click tracking and attribution.

Generic click identifier for tracking ad campaigns or affiliate links from any source.

Google Click Identifier (gclid) for tracking Google Ads clicks and conversions.

Web BRAID identifier for Google Ads tracking in browsers with limited third-party cookies.

Google BRAID identifier for app conversion tracking and attribution.

Pre-fill customer information to streamline the checkout process. This will populate the corresponding form fields.

customer: {
  email: 'customer@example.com',
  firstName: 'John',
  lastName: 'Doe',
  phone: '+1234567890',
  address: '123 Main St',
  city: 'San Francisco',
  state: 'CA',
  zip: '94103',
  country: 'US'
}

Customize the widget appearance to match your brand.

theme: {
  font: 'https://fonts.googleapis.com/css2?family=Inter',
  themeName: 'light', // or 'dark'
  css: {
    input: {
      borderRadius: '8px',
      border: '1px solid #e5e7eb'
    },
    button: {
      backgroundColor: '#5D4CFE',
      color: 'white',
      borderRadius: '8px'
    }
  }
}

An array of field configuration objects that define custom form fields.

fields: [
  // Required email field
  {
    label: 'Email Address',
    placeholder: 'Enter your email',
    fieldType: 'email',
    position: 'above',
    size: 'full',
    required: true
  },
  // Additional fields
  {
    label: 'Phone Number',
    placeholder: 'Enter your phone number',
    fieldType: 'phone',
    position: 'above',
    size: 'full'
  },
  {
    label: 'Company Name',
    placeholder: 'Enter your company name',
    fieldType: 'text',
    position: 'above',
    size: 'half'
  }
]

The label text displayed to the user.

Placeholder text shown in the input field when empty.

The type of field to display. Supported values:

• email - Email address input with validation (required)
• name - Name input field
• phone - Phone number input with formatting
• address - Street address input
• city - City input
• state - State/province input
• zip - Postal/ZIP code input
• country - Country selection dropdown
• text - Generic text input
• divider - Visual divider (not an input field)

Label position relative to the input field. Options: above or below.

Field width within the form. Options: full, half, or third.

Whether the field is required to be filled before submission.