Add-ons and ModulesDocdata

Docdata

Sana Commerce 8.3
Your provider

Select all
Back

Docdata Specific Configuration Values

The table below provides the description of the Docdata payment module configuration values:

Name Description
merchant_name The name of the account that will be used by Docdata to process the payment. This information will be supplied by Docdata when creating the (test) account.
Default value: depends on the PSP account
merchant_password The password of the account that will be used by Docdata to process the payment. This information will be supplied by Docdata when creating the (test) account.
Default value: depends on the PSP account
days_pay_period The amount of days the user will have to pay the order. For more information about this field, please refer to the Docdata documentation. This configuration value is required for the Docdata payment module.
Default value: 14
endpoint_name The name of the endpoint configuration setting in the 'web.config' file which is used by the add-on to connect to the Docdata Order API web service. The add-on uses WCF to make connection to the Docdata web service. By default when the add-on is installed there are two endpoints already preconfigured in the 'web.config' file. The endpoint_name configuration setting should match the name of one of those settings, either test or production. By default it is DocData_OrderApi_test which refers to the endpoint set for the Docdata test environment. Another endpoint name is DocData_OrderApi_production which refers to the endpoint set for the Docdata production environment.
paid_status_check_mode The mode of the order paid status check. This value tells Sana Commerce how the status of the order should be checked. There are three possible values: quick, safe or custom. The default value is quick. Each value stands for its own algorithm of the status check.

quick - when this value is set, Sana Commerce will perform a quick check of the order paid status. In this case Sana Commerce sums up total shopper pending, total acquirer pending and total acquirer authorized amounts and checks whether this sum is equal to the total amount which was registered for this order. This option is the fastest but it does have the risk that some payments will actually not have been made yet.

safe - in this case Sana Commerce will perform a safe check of the order paid status. Sana Commerce checks that the total captured amount is equal to the total amount which was registered for this order. Although it is the safest check, the downside is that it can sometimes take a long time for the acquirer to actually have the money transferred and captured.

custom - this value can be set if a custom check needs to be implemented. In the current implementation the custom check just invokes the quick check. But it is intended to be overridden by the end-developers so that a new custom check can be performed.
maximum_orderlines_to_send Limits the maximum number of order lines to be sent to Docdata Order API. Default value is "100".

The Docdata payment menu page can display information about the order including the list of order lines. Sana Commerce sends this list of order lines to the Docdata Order API every time a new payment gets started for the order in Docdata. It can be the case that customers post orders with the large amount of order lines and the data traffic between Sana Commerce and Docdata Order API gets increased significantly. This can also cause other issues, like inability to load the Docdata payment menu page in the user's browser, etc.

Use this setting to limit the number of order lines to be sent to Docdata. If this number is exceeded for some order, Sana Commerce will send only one order line to Docdata containing only total amount of the order instead of sending all order lines.

This value can be empty. In such case all order lines will be sent to Docdata.
PaymentPage The URL of the Docdata payment menu page. The web store users will be redirected to this URL to provide their payment account credentials and confirm the payment. By default this value is configured to the test environment of Docdata: https://test.docdatapayments.com/ps/menu?
For the live environment this value should be changed to the production environment of Docdata: https://secure.docdatapayments.com/ps/menu?
DebugDomains In most cases it is not possible to test a PSP in a development environment without a deployment, because of firewall issues. For Docdata, it is possible to test in a development environment by simulating calls made by Docdata for testing purposes. These test calls will be made in all domains set in the configuration setting. Multiple values can be separated by the ',' character.
Default value: localhost

Important! This value is for testing purposes only! Never configure this value for a live domain as it may cause problems with payments.

More detailed information about general configuration values of the external payment method can be found here.

If you want to post some optional parameters open the 'web.config' file of the Sana Commerce frontend. Locate the <payment-configuration> node in the <sanaCommerce> configuration section, where several modules are defined, which implement different payment methods. The DocData module is only needed. Add new configuration entry in the following format:

<add name="parameter name" value="parameter value" isRequestParameter="true" />

Every entry that has isRequestParameter="true" will be added to the URL parameters of the payment menu page URL. For example, if a new configuration has been added:

<add name="default_act" value="yes" isRequestParameter="true" />

This value will be added to the payment menu URL - this is the URL to which the user is redirected from the web store in the following way:
https://secure.docdatapayments.com/ps/menu?default_act=yes

Note, that for simplicity we do not show other parameters in the URL in the above example. In the real scenario numerous other parameters are added to this URL as well.

Back
Add-ons and ModulesDocdata

Sitemap

Installation

Product Versions

Links

Sana Commerce does not accept any liability for the content of this website, or for the consequences of any actions taken on the basis of the information provided. The information below should be interpreted as an example. No rights can be derived from this information.

Sana Commerce – the integrated e-Commerce solution for Microsoft Dynamics NAV & AX
© 1998 - 2014 Sana Commerce. All rights reserved
Updated: January 2014