Purpose:
The purpose of the this document is to help the person to configure and deploy the POS payment through Paytm with respect to different types of payment devices - UPI, QR-code and Credit and Debit Cards. The complexities of configuring the various MOPs in different POS, gave birth to POS Plugin Manager, which allows centralized the configuration and synchronization process with respect to MOP (Mode of Payment). The aim is to make life easy for the people responsible to perform the POS billing by Paytm.
POS-Plugin Management
Following are the steps to be followed in sequence to manage the entire process for configuring the POS Plugin:
Step #A: Configuring Plug-in Manager in Ginesys ERP user interface
Step #B: MoP (Mode of Payment) configuration in Ginesys ERP user interface
Step #C: Data Synchronization based on site from ERP to POS
Step #D: Pulling/syncing down the required configuration from ERP via Data Exchange in the POS system
Step #E: Update the latest POS Plugin using the AutoUpdater
Step #F: Logout and login into the POS application
Step #G: Test whether payment is being possible from POS using the configured MOP
Assumption
The plugin will be installed in Ginesys POS Server.
Ginesys HO version availability (minimum v12.5.1). Recommendation is to have the latest available version.
POS version availability (minimum v2.5.1). Recommendation is to have the latest available version.
- Any URL that Paytm provides will be whitelisted.
Explanation of the entire process
This section will be of a great help to the users who are expected to perform the configuration and deployment. The user of this document needs to expand each of the following steps in the sequence given:
Step #A: Configuring Plug-in Manager in Ginesys ERP user interface
Create the app.config file for EDC and DQR from the samples given.
EDC -
PAYTM EDC PRE-REQUISITE/CHECKLIST
Prior configuring/deploying the Auto-POS Plugin for Paytm EDC make sure that the following are in place:
Value for paytmMid attribute (get this from Paytm)
Value for MerchantKey attribute (get this from Paytm)
Value for TerminalId attribute (this is your store/site specific POS terminal ID)
Value for paytmTid attribute (this is EDC device specific)
Ledger name (Brand needs to have this in place)
Make sure that the integration mode of EDC device is on, otherwise the payment request coming in EDC device will not be visible. To know how to switch on the integration mode, take help from your device provider.
The sample content of the app.config file for Paytm EDC (Wired or Wireless) type of device would be :
Click the following link to download this sample file: paytm-edc-app.config
Attribute Description:
ATTRIBUTES | DESCRIPTIONS |
---|
paytmMid | This is the Merchant Id for EDC devices for both API call and wired integration. This will be provided by Paytm. |
mid | This is the Merchant Id for DQR and UPI payment request. This will be provided by Paytm. |
MerchantKey | This is the merchant key. It is a mandatory parameter for initiating a payment request for EDC API call and DQR. This will be provided by Paytm. The merchant key will be according to PaymentProcess value : - If it is 0 then the merchant key will be for EDC API call.
- If it is 2 or 3 then it will be for DQR or UPI call.
|
businessType | This is the type of QR code to be created. This is provided in the Paytm QR Document provided by Paytm. It has to be as identical as mentioned in that document. |
displayName | Display name for QR code. This is provided in the Paytm QR Document provided by Paytm. It has to be as identical as mentioned in that document. |
posId | This is to identify the POS. This is provided in the Paytm QR Document provided by Paytm. It has to be as identical as mentioned in that document. |
PaymentProcess | The value of PaymentProcess would vary as per the payment request from client: - 0 for EDC API call
- 1 for EDC wired integration
- 2 for DQR payment
- 3 for UPI payment request
|
EDCDeviceAPICheckPaymentStatusURL | This URL is to check EDC payment status for API call. This will be provided by Paytm. |
EDCDeviceAPITransactionURL | This URL is for EDC payment request API call. This will be provided by Paytm. |
DynamicQRCodeGenerationURL | This URL is for creating DQR payment request. This will be provided by Paytm. |
DynamicQRCodeCheckPaymentStatusURL | This URL is to check the status for EDC payment request. This will be provided by Paytm. |
UPIPaymentRequestURL | This URL is for creating UPI payment request. Provided by Paytm. |
checkUPIPaymentRequestURL | This URL is for checking payment status of UPI payment request. Provided by Paytm. |
TidMap | This is necessary for mapping POS terminal ID with the respective EDC device ID. How to find the value for the TerminalId attribute in the TidMap section? - Connect to the POS server system
- Login to POS with the valid user credential.
- On successful login, the following screen will appear:

- From the tree panel, select the POS Terminal option (2nd option from the bottom).
- The following screen will appear:

- In the right-hand panel, the first column is showing the Terminal name and the column beside is showing the corresponding TerminalId.
Example: The TerminalId for the terminal called USER-PC is 4. Follow the above steps and find the TerminalId
|
TerminalId | This is for POS terminal ID. It should be provided by the merchant. |
paytmTid | This is the EDC device ID required for EDC API calls. This will also be provided by Paytm. |
DQR
PAYTM DQR PRE-REQUISITE/CHECKLIST
Prior configuring/deploying the Auto-POS Plugin for Paytm DQR, make sure that the following are in place:
Value for mid attribute (get this from Paytm)
Value for MerchantKey attribute (get this from Paytm)
The sample content of the app.config file for Paytm DQR (Wired) type of device would be :
Click the following link to download this sample file:

Attribute Description:

Under the Setup tab, click on the Plugin Manager under Configure section.
Click on Add to start configuring a new Plugin Manager.

Under the General tab enter the following for the required fields. The name of the Plugin Short Code is a sample name only. In real deployment, Plugin Short Code needs to be provided by Ginesys and the same needs to be set for the Plugin Short Code -
Values for various modes of Paytm Plugin Short Code -
Paytm Plugin Short Code for UPI - PaytmEDC
Paytm Plugin Short Code for DQR - Paytm
Paytm Plugin Short Code for CC/DC - PaytmEDC
Plugin Vendor - EaseMyRetail
- Plugin Type - ProcessPOSPayment
- Plugin Assembly Name EDC - GinesysPaytmIntg
Plugin Assembly Name DQR - GinesysPaytmDQRIntg
- Target Config File name - app
Do the Hook Mapping.

- Move to the Config Files tab to specify the config file name.
- Click on the Add Row button to add a new row.
By clicking on the Add Row button, multiple configuration files can be added one after another. However any one can be marked as “Is Default”. - Scroll to the right to find the Browse button for the newly added row.

- Enable the Is Default option.

Click on the Browse button.
Select the config file called app.config
Click on the Upload button and then click on the OK button.
Assign the site in the Site Allocation tab. The process is similar to how the site has been moved from the list of Available Site to the list of Assigned Site section by clicking the right arrow.

Click on the save and close button at the top to save the Plugin Manager configuration.

The configured Plugin Manager will now appear in the list of configured plugin managers.

Plugin Manager configuration is now completed.
Step #B: MoP (Mode of Payment) configuration in Ginesys ERP user interface
Step #C: Data Synchronization based on site from ERP to POS
Step #D: Pulling/syncing down the required configuration from ERP via Data Exchange in the POS system
Step #E: Update the latest POS Plugin using the AutoUpdater
1.Login to the POS system using the valid user credential.
2. Open the AutoUpdate application.

3. The Auto Update screen will appear. Move to the Update Plugin tab.

4. Click on the Download button to download the latest updates in the POS system.

5. The latest POS Plugin is now downloaded successfully in the POS system and is visible in the list.

6. Click on the Close button to exit from the Auto Update application.
Step #F: Logout and login into the POS application
Verify the following:
Go to the folder where you have the POS application configuration file called NPOS.exe.config.
Open the file in notepad and check if it has the following section -
<runtime>
<loadFromRemoteSources enabled="true"/>
</runtime>
If it is already there, close the file. If it is not there, copy and paste the above <runtime</runtime> section after the </Startup> tag.
Logout and re-login
Step #G: Test whether payment is being possible from POS using the configured MOP
With all the above steps done successfully, the configuration and testing can now be considered completed.