Documentation Index
Fetch the complete documentation index at: https://docs.paysight.io/llms.txt
Use this file to discover all available pages before exploring further.
Configuration Reference
This document provides a detailed reference for all configuration options available in the Paysight Widget SDK.Basic Configuration
The basic configuration requires only a few essential parameters to get started:Complete Configuration
Here’s a complete reference of all available configuration options:Configuration Options
Required Fields
| Option | Type | Description |
|---|---|---|
productId | string | Your unique product identifier |
sessionId | string | Unique session identifier for the transaction |
amount | number | Payment amount in smallest currency unit (e.g., cents) |
Environment Options
| Option | Type | Default | Description |
|---|---|---|---|
environment | string | ’production’ | Payment environment (‘production’, ‘sandbox’, ‘local’) |
Payment Options
| Option | Type | Default | Description |
|---|---|---|---|
currency | string | ’USD’ | ISO 4217 currency code. Supported: USD, EUR, GBP, JPY, AUD, CAD, CHF, CNY, HKD, NZD, SEK, KRW, SGD, NOK, MXN, INR, RUB, ZAR, TRY, BRL, TWD, DKK, PLN, THB, IDR, HUF, CZK, ILS, CLP, PHP, AED, COP, SAR, MYR, RON |
locale | string | ’en-US’ | Language/locale code |
threeDSRequired | boolean | false | Enable 3D Secure authentication |
failOnThreeDSChallenge | boolean | false | Do not display 3DS challenge if set to true. Proceed to payment without 3DS. |
cancelOnThreeDSFailure | boolean | false | Cancel the payment if the 3DS not successfully completed. |
ecom | boolean | false | Enable e-commerce mode |
Customer Information
| Option | Type | Required | Description |
|---|---|---|---|
customer.email | string | No | Customer email address |
customer.name | string | No | Customer full name |
customer.phone | string | No | Customer phone number |
customer.address | object | No | Customer address details |
Additional Data Options
| Option | Type | Required | Description |
|---|---|---|---|
data.campaignId | number | No | Paysight tracking campaign identifier |
data.campaignName | string | No | Name (or alias/identifier) of your campaign. If campaignId is 0 and this value is provided, Paysight will auto-assign or auto-create (if new value) the campaign record |
data.affiliateId | number | No | Paysight tracking affiliate identifier |
data.affiliateName | string | No | Name (or alias/identifier) of your affiliate/traffic source. If affiliateId is 0 and this value is provided, Paysight will auto-assign or auto-create (if new value) the affiliate (traffic source) record |
data.subAffiliateId | string | No | Paysight tracking sub-affiliate identifier |
data.trackhouseClickId | string | No | Paysight tracking click identifier |
data.clickId | string | No | Generic tracking click identifier for analytics and attribution |
data.gclid | string | No | Google Click Identifier for tracking ad clicks |
data.wbraid | string | No | Web BRAID identifier for Google Ads tracking |
data.gbraid | string | No | Google BRAID identifier for app conversion tracking |
data.utm_campaign | string | No | UTM campaign parameter for traffic attribution |
data.utm_source | string | No | UTM source parameter for traffic attribution |
data.utm_medium | string | No | UTM medium parameter for traffic attribution |
data.[key] | any | No | Any additional custom data key-value pairs |
Payment Success Configuration
| Option | Type | Default | Description |
|---|---|---|---|
paymentSuccess.title | string | ’Payment Successful’ | Custom title for the payment success message shown after successful payment |
paymentSuccess.description | string | ’Thank you for your business’ | Custom description for the payment success message shown after successful payment |
Apple Pay Configuration
| Option | Type | Required | Description |
|---|---|---|---|
applePayEnabled | boolean | No | Enable or disable Apple Pay for the widget |
applePayOptions.applePayMerchantId | string | Yes* | Apple Pay merchant identifier (per merchant account, currently required, will be optional in v2) |
applePayOptions.style.buttonStyle | ’black’ | ‘white’ | ‘white-outline’ | No | Button style: black, white, or white-outline |
applePayOptions.style.buttonType | string | No | Button type: pay, buy, donate, etc. |
applePayOptions.style.borderRadius | number | No | Border radius in pixels |
applePayOptions.style.size.width | number | string | No | Button width in pixels or ‘100%‘ |
applePayOptions.style.size.height | number | string | No | Button height in pixels |
applePayEnabled is true
Google Pay configuration
| Option | Type | Required | Description |
|---|---|---|---|
googlePayEnabled | boolean | No | Enable Google Pay (parent-hosted button on the merchant page) |
googlePayOptions.googlePayMerchantId | string | Yes* | Google Pay merchant identifier (from Paysight) |
googlePayOptions.style.buttonStyle | ’black’ | ‘white’ | ‘white-outline’ | No | Google Pay button color style |
googlePayOptions.style.buttonType | string | No | Google Pay button type (e.g. pay, checkout) |
googlePayOptions.style.borderRadius | number | No | Border radius in pixels |
googlePayOptions.style.size.width | number | string | No | Button width in pixels or % |
googlePayOptions.style.size.height | number | string | No | Button height in pixels |
googlePayOptions.style.locale | string | No | Optional locale for the Google Pay button |
googlePayEnabled is true
Wallet-only layout
| Option | Type | Required | Description |
|---|---|---|---|
showOnlyWalletMethods | boolean | No | When true, may hide the card form and “OR” divider until a wallet is ready; falls back to full card UI if no wallet is available or after a wallet payment error. Requires at least one of Apple or Google Pay to be fully configured. |
Theme Configuration
| Option | Type | Description |
|---|---|---|
theme.font | string | Custom font URL |
theme.css | object | Custom CSS styles |
Usage Examples
Basic Configuration
Advanced Configuration
Environment-Specific Configuration
3D Secure Configuration
Best Practices
- Session ID Generation
- Environment Management
- Field Validation
Next Steps
- Wallet-only checkout - Hide the card form; Apple Pay and/or Google Pay first
- API Reference - Complete API documentation
- Events Reference - Event handling documentation
- Basic Integration Example - Simple implementation example
- Custom Styling Example - Customize widget appearance