Configuring the Store extension for WS.WebTV.
support, ws.webtv, home, store, configuration
• Support/Admin E-Mail: This E-Mail will receive the Store notifications and will be shown to the Users as the Store support E-Mail.
NOTE: If you do not provide an E-Mail address, the WebTV's E-Mail for notifications will be used (and displayed to the Users) instead.
• Currency: Select the Store currency.
Important:
• Make sure that the payment gateway you plan to use supports your currency.
• We recommend you NOT to change the currency once the Store is working, specially, when orders have already been placed.
• Symbol Position: Select the position for the currency symbol (prefix or suffix).
• Allowed Payment Methods: Check the payment methods you want to offer to your Users (you must select, at least, one).
IMPORTANT: Only select the payment method(s) that you will actually use.
• Order No. Prefix: This allows you to customize the look of the Order number, by setting a prefix. The internal ID will always be part of the Order number.
• Order No. Length: The maximum length (in characters) of the Order number (excluding the prefix).
• Minimum Purchase: Use this option if you need to require a minimum purchase to the Users; otherwise, set it to 0.
• Add Credit on User Registration: (WS.WebTV 1.4.2.1+) Specify the amount of Credit you want to add to the Users when they register (only Front-End registrations). Leave it as 0 if you don't want to add any Credit to new Users.
• Non-Admin Sales Report Percent: (WS.WebTV 1.4.2.1+) When the WebTV has been modified to allow Authors and/or Contributors to access the Store tab on Clips and Channels, and thus the Content Sales Report, the amounts on the sales reports will reflect the percentage. For example: If the content of a User has generated $100 and the percent value is set as 30%, then the User will see $30; although the previous, Webmaster/Admin Users will always see the real amounts in the reports.
• Disable Video Ads on Purchased Content: (WS.WebTV 1.4.0.1+) Select whether you want to disable Video Ads when playing back purchased content or not.
• Disable Interactivities on Purchased Content: (WS.WebTV 2.0+) If this option is set to Yes the WebTV will not display Interactivities when playing back purchased content.
In case you want to exclude certain restricted Clips, Channels and/or Galleries from the WebTV access pass, enter their IDs (separated by comma), in the corresponding fields.
• Subscription No. Prefix: This allows you to customize the look of the Subscription number, by setting a prefix. The internal ID will always be part of the Subscription number.
• Subscription No. Length: The maximum length (in characters) of the Subscription number (excluding the prefix).
• Grace Period: (WS.WebTV 1.7.5+) Additional time that an access pass (subscription) will continue to be effective after its expiration date.
• Expiration Frequency Check: (WS.WebTV 1.7.5+) Minimum time that the system will wait to check for expired subscriptions.
• Message 1,2,3 «n» days before expiration: You can specify up to three messages that will be sent to the User notifying that a suscription is going to expire. Enter 0 if you don't want a message to be sent.
Please note that, in any case, a notification message will be sent to the User when a subscription expires.
In this tab you will be able to define the WebTV global products.
Credit allows Users to purchase content quickly, any time, without going through the checkout process.
• SKU: (Informative) This is the internal SKU for the product.
• On Sale: Whether you want to allow credit purchase ("recharge") or not.
• Image: In case you want to use a custom image, upload it here (16:9 aspect).
Drag and Drop Tip:
If you are using recent versions of Chrome/Safari, Firefox or Opera, you can drag and drop your image file to the image field.
• Quantity Options: Enter the credit purchase options, separated by commas.
A WebTV Access Pass grants access to all WebTV restricted content, during a time period.
• SKU: (Informative) This is the internal SKU for the product.
• On Sale: Whether you want to sell this product or not.
• Image: In case you want to use a custom image, upload it here (16:9 aspect).
Drag and Drop Tip:
If you are using recent versions of Chrome/Safari, Firefox or Opera, you can drag and drop your image file to the image field.
• Price: Enter the pice for this product (use the number format as defined in the Regional Settings of the WebTV configuration).
• Period: Enter the time period (from the time of purchase) during which the global access will be granted.
• Allow Content Download: This only applies to Clips. If set to Yes, you must make sure your Clips have the following settings for "Show Download Menu" (Video File Download) on Media tab:
Condition: "Depending on Purchase"
Allow Download: "Yes, (...)"
A WebTV Access Pass grants access to all WebTV restricted content, during a time period.
• On Sale: Whether you want to sell this product or not.
• SKU: (Informative) This is the internal SKU for the product.
• Image: In case you want to use a custom image, upload it here (16:9 aspect).
Drag and Drop Tip:
If you are using recent versions of Chrome/Safari, Firefox or Opera, you can drag and drop your image file to the image field.
• Price: Enter the pice for this product (use the number format as defined in the Regional Settings of the WebTV configuration).
• Period: Enter the renewal time period (from the time of purchase). The global access will be granted as long as the subscription has not expired.
• Allow Content Download: This only applies to Clips. If set to Yes, you must make sure your Clips have the following settings for "Show Download Menu" (Video File Download) on Media tab:
Condition: "Depending on Purchase"
Allow Download: "Yes, (...)"
*** This product is available since WS.WebTV 3.0.2 ***
The only difference between this product and the normal subscription is that this allows specifying a free trial period. The billing for the suscription will start after the trial period ends.
• Free Trial: Enter the period of time during which the free access will be granted (from the time of purchase).
NOTE: Products with free trials will only be displayed to Users which have not previously purchased an access pass for the same content.
• Trial requires recurring payments: If you select Yes the trial will only be activated (as well as the subscription) if recurring payments are enabled for the payment method selected by the User at the payment step and if there were no recurring payment related-errors in the payment process.
*** This product is available since WS.WebTV 2.1.0.1 ***
When an User purchases this product, its access level will "upgrtade"/change to "Author" (using the Default Privilege Set for this access level) so that it can create and publish content in the WebTV.
NOTES:
- This product can only be purchased by an User with a Contributor or Subscriber access level; therefore, it won't be available to Users with Author, Admin or Webmaster access level.
- (Applicable since version 2.2) In order to sell other Privilege Sets for "Author" access level, as Memberships, you must do it from the corresponding Privilege Set edit screen (Store tab).
• On Sale: Whether you want to sell this product or not.
• SKU: (Informative) This is the internal SKU for the product.
• Image: In case you want to use a custom image, upload it here (16:9 aspect).
Drag and Drop Tip:
If you are using recent versions of Chrome/Safari, Firefox or Opera, you can drag and drop your image file to the image field.
• Price: Enter the pice for this product (use the number format as defined in the Regional Settings of the WebTV configuration).
• Period: [Scheduler extension required] When an User purchases the membership, the WebTV will create a Scheduler task to revert the User access level after the specified period elapses.
*** This product is available since WS.WebTV 2.1.0.1 ***
When an User purchases this product, its access level will "upgrade"/change to "Contributor" (using the Default Privilege Set for this access level) so that it can create content in the WebTV (although Admin moderation will always be required).
NOTES:
- This product can only be purchased by an User with a Subscriber access level; therefore, it won't be available to Users with Contributor, Author, Admin or Webmaster access level.
- (Applicable since version 2.2) In order to sell other Privilege Sets for "Contributor" access level, as Memberships, you must do it from the corresponding Privilege Set edit screen (Store tab).
• On Sale: Whether you want to sell this product or not.
• SKU: (Informative) This is the internal SKU for the product.
• Image: In case you want to use a custom image, upload it here (16:9 aspect).
Drag and Drop Tip:
If you are using recent versions of Chrome/Safari, Firefox or Opera, you can drag and drop your image file to the image field.
• Price: Enter the pice for this product (use the number format as defined in the Regional Settings of the WebTV configuration).
• Period: [Scheduler extension required] When an User purchases the membership, the WebTV will create a Scheduler task to revert the User access level after the specified period elapses.
Since WS.WebTV 1.7.5, the extension includes a Widget to display the built-in products into the sidebar or into other widget zones.
To create a Built-In Product List Widget:
1. Go to Configuration > Widgets
2. Click on "New Widget..." button and select "Built-In Product List Widget (Store)". A new empty entry will be added to the list.
3. Enter the Title, CSS class (optional) and select the zone for the Widget.
Note: For the "Type" (available since version 2.2), specify which product types you want to include (you can choose whether to include Membership products).
Keep in mind that if you include Membership products, those corresponding to Privilege Sets (which are on sale) will also be included.
NOTE: This tab will ONLY be visible if the "Bank" payment method was selected in "Allowed Payment Methods", in the General tab explained above.
*** Empty fields will not be displayed to the User ***
• Name: Enter the name of the bank.
• Full Address: Enter the complete bank address.
• Account: Enter the bank account number.
• IBAN: Enter the account IBAN.
• SWIFT/BIC: Enter the SWIFT/BIC code for the bank. This is normally used for international wire transfers.
• Optional message...: If you want to display a message to the User (buyer), enter it here. It will be displayed below the bank info.
This payment gateway is supported since WS.WebTV v60.
- Website: https://www.stripe.com/
- Availability: Worldwide.
- Supported modality: Single payment + Recurring/automatic payments.
- Integration type: Stripe Checkout (with Webhooks).
NOTE: This tab will ONLY be visible if the "Stripe" payment method was selected in "Allowed Payment Methods", in the General tab explained above.
Important:
• Your Stripe account must already be verified.
• NOTICE: You should never use the same Stripe API info on multiple Websites. If you plan to use Stripe on multiple WebTVs/Websites then you must have a different Stripe account (like sub-accounts) for each of them. It is very easy to create/manage multiple Stripe accounts, please visit the following page for more info: https://stripe.com/docs/account/multiple-accounts
Get your Stripe API keys:
To get your Stripe API info visit the "API keys" section of your Stripe Dashboard / Developers page: https://dashboard.stripe.com/apikeys
(Make sure that the correct Stripe account is selected at the top-left).
...Then copy the "Publishable key" and "Secret key" and paste them into the corresponding fields of the WebTV Stripe configuration tab.
Configure the Stripe Webhook:
Once you have your API info then you need to add a Webhook endpoint and get the Webhook signing secret:
1.
Visit the "Webhooks" section of your Stripe Dashboard / Developers page: https://dashboard.stripe.com/webhooks
2. Click the "+ Add endpoint" button at the right.
- For "Endpoint URL" enter the "Webhook URL" provided in the WebTV Stripe configuration tab.
- For "Description" you can enter a descriptive text like "WebTV Webhook Endpoint"
- For "Listen to", leave it as "Events on your account".
- Then click "Select events": and make sure to select -at least- ALL "Charge" events and ALL "Checkout" events.
- After the events were selected click the "Add events" button.
- Finally, click the "Add endpoint" button.
... Now, in the created Webhook page, in "Signing secret", click "Reveal" and get it (it is a string which starts with "whsec_"...) then paste the data into the "Endpoint Secret (Webhook)" field of the WebTV Stripe configuration tab.
- Website:
https://www.paypal.com/
- Availability: Worldwide.
- Supported modality: Single payment + Recurring/automatic payments.
- Integration type: PayPal "Express Checkout" redirection.
NOTE: This tab will ONLY be visible if the "PayPal" payment method was selected in "Allowed Payment Methods", in the General tab explained above.
Important:
• Your PayPal account must already be verified.
• In order to use the PayPal integration you need a PayPal Premiere or Business account .
• If you already have a PayPal Premiere or Business account, and don't know how to get your API credentials, in the following tutorial we will show you how to do it.
Regarding PayPal Error 10486:
If your users can't pay an order and get the PayPal error 10486 then the following are possible causes:
1. Your PayPal seller account has not been verified.
2. You have not made optional the necessity to have a PayPal account in order to pay. Verify the option from PayPal > Seller preferences > Website preferences > PayPal Account Optional, it must be set as On
3. If an user is trying to pay an order using a credit card then the card is being declined.
4. If an user is trying to pay an order using a PayPal account, then it is possible that the user does not have enough funds in its account. You should tell the user to pay using a different method (Ex. credit card without using its PayPal account).
• Sandbox Mode: If you already have your PayPal API credentials (API signature) and you are ready to start selling, select No. If you want to use the PayPal API Sandbox mode (test environment) for simulating payments, then select Yes (this requires having special Sandbox credentials).
• Username: Enter you API credentials Username.
• Password: Enter you API credentials Password.
• Signature: Enter you API credentials Signature.
• Enable Recurring Payments: (WS.WebTV 1.7.5+) This feature only applies to subscriptions. It is intended for automatic billing. When it is disabled, the buyer will need to pay manually on each renewal/expiration date. If enabled, the buyer will be able to decide (while placing an order) whether to pay manually or automatically.
The external payment processor allows you to develop the integration with any payment gateway (requires a developer/programmer).
This functionality is available since WS.WebTV 1.6.1. Please, check this document for more information.
This payment gateway is supported since WS.WebTV v51.
- Website:
https://squareup.com/
- Availability: USA only.
- Supported modality: Single payment modality - recurring/automatic payments not supported.
- Integration type: Square "Checkout" redirection.
This payment gateway is supported since WS.WebTV v54.
- Website:
https://www.authorize.net/
- Availability: USA only.
- Supported modality: Single payment modality - recurring/automatic payments not supported.
- Integration type: Authorize.Net "Accept Hosted".
This payment gateway is supported since WS.WebTV v54.
- Website: http://www.redsys.es/
- Availability: Spain only.
- Supported modality: Single payment modality - recurring/automatic payments not supported.
- Integration type: Redsys redirection.