Difference between revisions of "NATS4 DHDGateway"
| (12 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | show_billers_section = true | + | |show_billers_section = true |
}} | }} | ||
| + | {{NATS4 Manual}} | ||
| + | {{Test Billers Disclaimer}} | ||
| − | + | This feature is available starting from [[NATS]] version 4.0.71.3 | |
== Setting up at DHD == | == Setting up at DHD == | ||
| − | + | To set up a DHD Gateway, you must first register an account with [http://www.dhdmedia.com DHD Media]. | |
| − | + | When you register your account, you must give DHD the following two URLs so they can communicate with your NATS. | |
* Soap Server: <nowiki>http://linkdomain/signup/process_dhd.php</nowiki> | * Soap Server: <nowiki>http://linkdomain/signup/process_dhd.php</nowiki> | ||
* WSDL: <nowiki>http://linkdomain/signup/process_dhd.php?wsdl</nowiki> | * WSDL: <nowiki>http://linkdomain/signup/process_dhd.php?wsdl</nowiki> | ||
| − | Replace ''linkdomain'' with your [[Link Domain|linkdomain]]. | + | Replace ''linkdomain'' in the above examples with your [[Link Domain|linkdomain]]. |
| + | |||
| + | Once you register, DHD will provide you with a Domain, Merchant ID, Gateway Username, Password, and API Version. Make sure to record this information, as you will need it when setting up DHD Gateway in [[NATS]]. | ||
| + | |||
| + | When setting up products with DHD, you will also need to record each options. | ||
| + | |||
| + | == Set up DHDGateway in NATS == | ||
| + | === Billers Admin === | ||
| + | |||
| + | To begin setting up DHD Gateway as a [[Ct#Biller|biller]] in [[NATS]], go to the [[NATS4 Billers Admin|Billers Admin]]. Scroll down to the "Biller' drop-down menu, select "DHDMedia Gateway", and click Add. | ||
| + | |||
| + | When prompted, fill in the Gateway Username, Gateway Password, and API Version that were provided to you by DHD under the "Account Info" section. If you were not provided with this information, please contact your [[Ct#Biller|biller]] to receive it. Click Save once you have filled out the available fields. | ||
| + | |||
| + | === Sites Admin === | ||
| + | |||
| + | Next, go to the [[NATS4 Sites Admin|Sites Admin]], create or edit a [[Ct#Tour|tour]], and scroll down to the "Biller Details" section. Enter your Merchant ID, and fill out any of the optional settings beginning with "DHDGATEWAY". If you were not provided with this information, please contact DHD Support to obtain your [[Ct#Biller|Biller]] Details. Once you have filled out all applicable information, click Save Changes. | ||
| + | |||
| + | Once you have done this, scroll down to the section labeled "Join Options for this Tour" and click the "Edit Option Details for this tour" icon that corresponds to the [[Ct#Join Option|join option]] you wish to use. In the "Biller Codes" section on the next page, locate the "DHDGATEWAY" options and enter the Product ID, Purchase Page ID, and default currency that you configured with DHD for these [[Ct#Join Option|join options]]. Fill in any optional information that you wish to use with the additional fields. | ||
| + | |||
| + | Once you have completed these steps, save your [[Ct#Join Option|join option]] details. DHD Gateway will now be configured for use as a [[Ct#Biller|biller]] in [[NATS4]]. | ||
| + | |||
| + | === Cross Sales === | ||
| + | |||
| + | '''Note: This feature is available as of [[NATS4.1]]. If you are on a version of [[NATS4]] and would like to process [[Ct#Cross Sell|cross sales]], please [https://clients.toomuchmedia.com submit an upgrade ticket] to upgrade your [[NATS]] installation. | ||
| + | |||
| + | DHD Gateway also supports [[Ct#Cross Sell|Cross Sale]] transactions through [[NATS]]. In order to process cross sale transactions, however, you will first have to set them up with DHD. Please contact DHD for assistance with this. | ||
| + | |||
| + | To set up cross sales in [[NATS]], go to the [[Upsells Admin]] and click incoming or outgoing cross sales from the navigation tabs (depending on whether you are sending or receiving the cross sale). | ||
| + | |||
| + | If you are sending a cross sale to another [[Ct#Site|site]], go to the "Outgoing Cross Sales" section. Add DHDGATEWAY from the Biller drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your cross sell option. | ||
| + | |||
| + | You will then need to fill out the Biller Info for your cross sale, which should be provided to you by DHD. Fill in your Gateway Username, Gateway Password, API Version, Merchant ID, Product ID, Currency, Initial Amount, Ref Code, Merchant Bank Code, and Domain here, and click Save Changes. | ||
| + | |||
| + | If you are receiving the cross sale, go to the "Incoming Cross Sales" section. Add DHDGATEWAY from the Biller drop-down menu and click Add New Option. When prompted, choose the [[Ct#Site|site]] and [[Ct#Program|program]] you want to associate with the cross sale. | ||
| + | |||
| + | Under "Details," fill in the title of your cross sale option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Gateway Username, Gateway Password, API Version, Merchant ID, Product ID, Currency, Upgrade Product ID, and Merchant Bank Code in the "Biller Info" section and click Save Changes. | ||
| + | |||
| + | '''You will need to add the server ips to the configuration XSELL_DHDGATEWAY_SECURE_IPS in config.php or config_override.php for the NATS install that is receiving the cross sale. | ||
| + | |||
| + | === Upsells === | ||
| + | |||
| + | '''Note: This feature is available as of [[NATS4.1]]. If you are on a version of [[NATS4]] and would like to process [[Ct#Upsell|upsells]], please [https://clients.toomuchmedia.com submit an upgrade ticket] to upgrade your [[NATS]] installation. | ||
| + | |||
| + | [[Ct#Upsell|Upsells]] can be configured similarly to cross sales in [[NATS]]. Like [[Ct#Cross_Sell|cross sales]], you will have to set up upsells first with DHD. | ||
| + | |||
| + | To set up [[Ct#Upsell|upsells]] in [[NATS]], go to the [[Upsells Admin]] and click incoming or outgoing upsells from the navigation tabs (depending on whether you are sending or receiving the upsell). | ||
| + | |||
| + | If you are sending the [[Ct#Upsell|upsell]], go to the Outgoing Upsells section. Add DHDGATEWAY from the Biller drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your upsell. | ||
| + | |||
| + | You will then need to fill out the Biller Info for your upsell, which should be provided to you by DHD. Fill in your Product ID, Currency, Ref Code, Domain, whether you want to use HTTPS Post, whether this is the Master Merchant Account, your Merchant Bank Code, and the Initial Amount of your upsell here, and click Save Changes. | ||
| + | |||
| + | If you are receiving the [[Ct#Upsell|upsell]], go to the "Incoming Upsells" section. Add DHDGATEWAY from the Biller drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with the upsell. | ||
| + | |||
| + | Under "Details," fill in the title of your upsell option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Merchant ID, Product ID, Currency, Upgrade Product ID, and Merchant Bank Code in the "Biller Info" section and click Save Changes. | ||
| + | |||
| + | === Package Plus === | ||
| + | |||
| + | The Package Plus feature is available after NATS4.1.4.1 for the DHDGateway integration. This feature allows you to offer your members incentives to upgrade their memberships to a higher tier in your Members Area. For more information on Package Plus, visit the [[NATS4 Package Plus|Package Plus]] wiki. | ||
| + | |||
| − | + | === Upgrade Plus === | |
| + | UpgradePlus lets you shorten a Member's Trial by offering them incentives to upgrade to a full member. Most users do this by offering them two separate Members Areas: One only for members in their Trial Phase (showing a limited amount of content) and a separate area which gives access to the full content for members that paid for the full month. | ||
| − | + | DHD requires an Upgrade Product ID on the join options for this to work. The upgrade ID is the product ID of the new product. | |
| − | + | for more information, see [[NATS4 Upgrade Plus]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | [[Category:NATS4 Biller Instructions]] | |
Latest revision as of 13:02, 20 February 2020
NATS 4
|
|---|
Please don't test your biller setup with NATS4 DHDGateway's test account—it won't work correctly.
This feature is available starting from NATS version 4.0.71.3
Setting up at DHD
To set up a DHD Gateway, you must first register an account with DHD Media.
When you register your account, you must give DHD the following two URLs so they can communicate with your NATS.
- Soap Server: http://linkdomain/signup/process_dhd.php
- WSDL: http://linkdomain/signup/process_dhd.php?wsdl
Replace linkdomain in the above examples with your linkdomain.
Once you register, DHD will provide you with a Domain, Merchant ID, Gateway Username, Password, and API Version. Make sure to record this information, as you will need it when setting up DHD Gateway in NATS.
When setting up products with DHD, you will also need to record each options.
Set up DHDGateway in NATS
Billers Admin
To begin setting up DHD Gateway as a biller in NATS, go to the Billers Admin. Scroll down to the "Biller' drop-down menu, select "DHDMedia Gateway", and click Add.
When prompted, fill in the Gateway Username, Gateway Password, and API Version that were provided to you by DHD under the "Account Info" section. If you were not provided with this information, please contact your biller to receive it. Click Save once you have filled out the available fields.
Sites Admin
Next, go to the Sites Admin, create or edit a tour, and scroll down to the "Biller Details" section. Enter your Merchant ID, and fill out any of the optional settings beginning with "DHDGATEWAY". If you were not provided with this information, please contact DHD Support to obtain your Biller Details. Once you have filled out all applicable information, click Save Changes.
Once you have done this, scroll down to the section labeled "Join Options for this Tour" and click the "Edit Option Details for this tour" icon that corresponds to the join option you wish to use. In the "Biller Codes" section on the next page, locate the "DHDGATEWAY" options and enter the Product ID, Purchase Page ID, and default currency that you configured with DHD for these join options. Fill in any optional information that you wish to use with the additional fields.
Once you have completed these steps, save your join option details. DHD Gateway will now be configured for use as a biller in NATS4.
Cross Sales
Note: This feature is available as of NATS4.1. If you are on a version of NATS4 and would like to process cross sales, please submit an upgrade ticket to upgrade your NATS installation.
DHD Gateway also supports Cross Sale transactions through NATS. In order to process cross sale transactions, however, you will first have to set them up with DHD. Please contact DHD for assistance with this.
To set up cross sales in NATS, go to the Upsells Admin and click incoming or outgoing cross sales from the navigation tabs (depending on whether you are sending or receiving the cross sale).
If you are sending a cross sale to another site, go to the "Outgoing Cross Sales" section. Add DHDGATEWAY from the Biller drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your cross sell option.
You will then need to fill out the Biller Info for your cross sale, which should be provided to you by DHD. Fill in your Gateway Username, Gateway Password, API Version, Merchant ID, Product ID, Currency, Initial Amount, Ref Code, Merchant Bank Code, and Domain here, and click Save Changes.
If you are receiving the cross sale, go to the "Incoming Cross Sales" section. Add DHDGATEWAY from the Biller drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with the cross sale.
Under "Details," fill in the title of your cross sale option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Gateway Username, Gateway Password, API Version, Merchant ID, Product ID, Currency, Upgrade Product ID, and Merchant Bank Code in the "Biller Info" section and click Save Changes.
You will need to add the server ips to the configuration XSELL_DHDGATEWAY_SECURE_IPS in config.php or config_override.php for the NATS install that is receiving the cross sale.
Upsells
Note: This feature is available as of NATS4.1. If you are on a version of NATS4 and would like to process upsells, please submit an upgrade ticket to upgrade your NATS installation.
Upsells can be configured similarly to cross sales in NATS. Like cross sales, you will have to set up upsells first with DHD.
To set up upsells in NATS, go to the Upsells Admin and click incoming or outgoing upsells from the navigation tabs (depending on whether you are sending or receiving the upsell).
If you are sending the upsell, go to the Outgoing Upsells section. Add DHDGATEWAY from the Biller drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your upsell.
You will then need to fill out the Biller Info for your upsell, which should be provided to you by DHD. Fill in your Product ID, Currency, Ref Code, Domain, whether you want to use HTTPS Post, whether this is the Master Merchant Account, your Merchant Bank Code, and the Initial Amount of your upsell here, and click Save Changes.
If you are receiving the upsell, go to the "Incoming Upsells" section. Add DHDGATEWAY from the Biller drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with the upsell.
Under "Details," fill in the title of your upsell option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Merchant ID, Product ID, Currency, Upgrade Product ID, and Merchant Bank Code in the "Biller Info" section and click Save Changes.
Package Plus
The Package Plus feature is available after NATS4.1.4.1 for the DHDGateway integration. This feature allows you to offer your members incentives to upgrade their memberships to a higher tier in your Members Area. For more information on Package Plus, visit the Package Plus wiki.
Upgrade Plus
UpgradePlus lets you shorten a Member's Trial by offering them incentives to upgrade to a full member. Most users do this by offering them two separate Members Areas: One only for members in their Trial Phase (showing a limited amount of content) and a separate area which gives access to the full content for members that paid for the full month.
DHD requires an Upgrade Product ID on the join options for this to work. The upgrade ID is the product ID of the new product.
for more information, see NATS4 Upgrade Plus.
