The site object is retrieved by calling the Site configuration endpoint. It contains general information about your site, a list of enabled features and settings for each, list of products available for purchase online, list of paywalls, their associated attributes and settings as well as payment gateway settings configured under your account.
| Attribute | Description |
|---|
account string | The unique identifier of the account to which the site is associated. |
default_currency string | The default currency associated to your account. |
default_locale string | The default locale associated to your site. |
ecommerce_enabled bool | Whether Ecommerce feature is enable in your site settings. |
name string | Name of your site, as define in your settings. |
link string | The link this site is available on. This is used in email notifications and any other reference to the site. |
logo array | Attributes of the logo. |
products array | List of products available for purchase online, and associated attributes. |
paywalls array | List of paywalls, associated attributes and settings. |
design_settings array | If defined, list of design configurations to apply to the default user interface. |
| Attribute | Description |
|---|
braintree_tokenization string | Braintree tokenization string, as defined in your gateway settings. |
braintree_currency string | Supported Braintree currency, as defined in your gateway settings. |
vantiv_gateway_settings array | List of configuration settings for Vantiv payment gateway. |
tap_gateway_settings array | List of configuration settings for Tap payment gateway. |
cybersource_gateway_settings array | List of configuration settings for Cybersource payment gateway. |
The passwordless feature allows your customers to request a link that they can use to login without entering their email or password.
| Attribute | Description |
|---|
passwordless_enabled bool | Whether Customer passwordless feature is enabled in your site settings. |
passwordless_token_duration\ int | If Customer passwordless feature is enabled, this is the link duration (in days). |
The social logins feature allows your customers to login with well-known identify providers.
| Attribute | Description |
|---|
google_app_id string | If provided, the Google app ID defined in your site settings used for social login feature. |
google_app_id_ios\ string | If provided, the Google iOS app ID defined in your site settings used for social login on iOS devices. |
google_app_id_android\ string | If provided, the Google Android app ID defined in your site settings used for social login on Android devices. |
facebook_app_id\ string | If provided, the Facebook app ID defined in your site settings used for social login feature. |
auth0_base_url string | If provided, the Auth0 Domain defined in your site settings used for social login feature. |
auth0_client_id string | If provided, the Auth0 Client ID defined in your site settings used for social login feature. |
Pelcro offers various tools for security and fraud prevention, some of which are surfaced via the Site object.
| Attribute | Description |
|---|
security_key string | This is the security key to use to initiate the verification process of end-user interaction on your website. This will be populated only if Risk Assessment feature is enabled. |
email_verify_enabled bool | Whether Customer email verification feature is enabled in your site settings. |
| Attribute | Description |
|---|
taxes_enabled bool | Whether taxes are enabled under your account. |
tax_inclusive bool | If enabled, whether taxes are inclusive or exclusive. |
| Attribute | Description |
|---|
google_analytics_id string | If provided, the Google analytics ID defined in your site settings. |
