Payment Response

The following guideline explains how to apply the corresponding source code to retrieve payment response parameters from the message returned by PayMaster.

Java

Step 1 : Library

The merchant must include the PayMaster Merchant Plug-In (MPI) Java library, PayMaster.jar, in the merchant application.

Step 2 : Import

For UPP payments, the merchant must import the following into the merchant code:

• com.PayMaster.Entities.PayMasterEntity
• com.PayMaster.PropertiesReader.PropertiesReader
• com.PayMaster.MessageResponseBuilder.PaymentResponseMessageBuilder

Step 3 : Source Code

import com.PayMaster.Entities.PayMasterEntity;
import com.PayMaster.PropertiesReader.PropertiesReader;
import com.PayMaster.MessageResponseBuilder.PaymentResponseMessageBuilder;

// Declare variable for Payment Master Properties - 1st Parameter = File Path, 2nd Parameter = File Name
PropertiesReader propertiesReader = new PropertiesReader("./PayMasterProperties/", "UPPPayment.properties");

// Declare variable for Payment Master Entity
PayMasterEntity paymentResponseEntity = new PayMasterEntity();

// Get response message from PayMaster and set it into Payment Master Entity
paymentResponseEntity.setter("ResponseMessage", responseMessage);

// Call Payment Master Payment Response Message Builder to set value
PaymentResponseMessageBuilder paymentResponseMessageBuilder = new PaymentResponseMessageBuilder();
paymentResponseMessageBuilder.buildUPPPaymentResponseMessage(paymentResponseEntity, propertiesReader);

if (paymentResponseEntity.getter("TxnStatDetCde").equals("0000")) {
    String merchantID = paymentResponseEntity.getter("MerchantID");
    String merchRefNo = paymentResponseEntity.getter("MerchRefNo");
    String txnStatus = paymentResponseEntity.getter("TxnStatus");
    String shAlgorithmType = paymentResponseEntity.getter("SHAlgorithmType");
    String shValue = paymentResponseEntity.getter("SHValue");
    // To do ...
}

Step 4 : Indicate PayMaster Properties File Location

The merchant must specify the location of the PayMaster Properties File using PropertiesReader.

Step 5 : Indicate PayMaster Properties File Location Using Setter

The merchant must indicate where the PayMaster Properties File is located using the setter function setter(“ResponseMessage”,”<response message returned by PayMaster Gateway>”). The setter function assigns a value and accepts two parameters: setter(parameter name, parameter value).

Step 6 : Assign Values to the PayMaster Response Entity

The merchant should call the UPP Payment Response Message Builder to process the response message and assign the values to the PayMaster Response Entity.

Refer to Pre-Auth Payment Parameters for the fields supported by the PayMaster Merchant Plug-In (MPI).

Step 7 : Retrieve Values from PayMaster Response Entity

The merchant can retrieve values from the PayMaster Response Entity using the getter function, which accepts only one parameter: getter(parameter name).

Ensure that the value of TxnStatDetCde is not equal to 5015, as this represents an invalid secure hash value.

.Net

Step 1 : Library

The merchant must include the PayMaster Merchant Plug-In (MPI) .NET library, PayMaster.dll, in the merchant application.

Step 2 : Namespace

For UPP payments, the merchant shall include the following namespaces in the merchant code:

• using com.PayMaster.Entities
• using com.PayMaster.Properties
• using com.PayMaster.MessageResponseBuilder

Step 3 : Source Code

using com.PayMaster.Entities;
using com.PayMaster.Properties;
using com.PayMaster.MessageResponseBuilder;

// Declare variable for Payment Master Properties - 1st Parameter = File Path, 2nd Parameter = File Name
PropertiesReader propertiesReader = new PropertiesReader("./PayMasterProperties/", "UPPPayment.properties");

// Declare variable for Payment Master Entity
PayMasterEntity uppPaymentResponseEntity = new PayMasterEntity();

// Get response message from PayMaster and set it into Payment Master Entity
uppPaymentResponseEntity.setter("ResponseMessage", responseMessage);

// Call Payment Master Payment Response Message Builder to set value
PaymentResponseMessageBuilder uppPaymentResponseMessageBuilder = new PaymentResponseMessageBuilder();
uppPaymentResponseMessageBuilder.buildUPPPaymentResponseMessage(uppPaymentResponseEntity, propertiesReader);

if (uppPaymentResponseEntity.getter("TxnStatDetCde").Equals("0000")) {
    string merchantID = uppPaymentResponseEntity.getter("MerchantID");
    string merchRefNo = uppPaymentResponseEntity.getter("MerchRefNo");
    string txnStatus = uppPaymentResponseEntity.getter("TxnStatus");
    string shAlgorithmType = uppPaymentResponseEntity.getter("SHAlgorithmType");
    string shValue = uppPaymentResponseEntity.getter("SHValue");
    // To do ...
}

Step 4 : Indicate PayMaster Properties File Location

The merchant must specify the location of the PayMaster Properties File using the PropertiesReader.

Step 5 : Assign Response Message into Payment Response Entity

The merchant should assign the response message received from PayMaster into the PayMaster Response Entity using the setter function: setter(“ResponseMessage”,”<response message returned by PayMaster Gateway>”).

Step 6 : Assign Values into PayMaster Response Entity

The merchant should call the UPP Payment Response Message Builder to process the response message and assign the values to the PayMaster Response Entity.

Refer to Pre-Auth Payment Parameters for the fields supported by the PayMaster Merchant Plug-In (MPI).

Step 7 : Retrieve Values from PayMaster Response Entity

The merchant can retrieve values from the PayMaster Response Entity using the getter function, which accepts only one parameter: getter(parameter name).

Ensure that the value of TxnStatDetCde is not equal to 5015, as this represents an invalid secure hash value.

PHP

Step 1 : Library

The merchant must include the PayMaster Merchant Plug-In (MPI) PHP library, PayMaster.phar, in the merchant application.

Step 2 : Merchant Code

For UPP payments, the merchant should import the following into their code:

• PropertiesReader - to read the properties files.
• PayMasterEntity – to assign all the acceptable values for PayMaster UPP payment.
• PaymentResponseMessageBuilder – to generate the PayMaster UPP payment response message.

Step 3 : Source Code

<?php
use com\PayMaster\Entities\PayMasterEntity;
use com\PayMaster\PropertiesReader\PropertiesReader;
use com\PayMaster\MessageResponseBuilder\PaymentResponseMessageBuilder;
use com\PayMaster\Import\ImportFile;

// Locate the absolute path of PayMaster.phar
$basePath = 'phar://<absolute path of PayMaster.phar>/paymaster/PayMaster.phar/';
include_once $basePath . 'com/PayMaster/Import/ImportFile.php';

$import = new ImportFile();
$import->includeFile($basePath);

// Declare variable for Payment Master Properties - 1st Parameter = File Path, 2nd Parameter = File Name
$propertiesReader = new PropertiesReader();
$propertiesReader->PropertiesReader(<absolute path> . "/paymaster", "UPPPayment.ini");

// Declare variable for Payment Master Entity
$paymentResponseEntity = new PayMasterEntity();

// Get all the parameter values from the user side and set them into Payment Master Entity
$paymentResponseEntity->setter("ResponseMessage", $responseMessage);

// Call Payment Master Payment Response Message Builder to set value
$paymentResponseMessageBuilder = new PaymentResponseMessageBuilder();
$paymentResponseMessageBuilder->buildUPPPaymentResponseMessage($paymentResponseEntity, $propertiesReader);

if (strncmp($paymentResponseEntity->getter("TxnStatDetCde"), "0000") == 0) {
    $merchantID = $paymentResponseEntity->getter("MerchantID");
    $merchRefNo = $paymentResponseEntity->getter("MerchRefNo");
    $txnStatus = $paymentResponseEntity->getter("TxnStatus");
    $shAlgorithmType = $paymentResponseEntity->getter("SHAlgorithmType");
    $shValue = $paymentResponseEntity->getter("SHValue");
    // To do ...
}
?>

Step 4 : Locate Absolute Path of PayMaster.phar

The merchant must locate the absolute path of PayMaster.phar and set it as the $basePath in the merchant source code (line 7 in the example above).

Example:$basePath=’phar://<absolute path of PayMaster.phar>/’

Step 5 : Indicate PayMaster Properties File Location

The merchant must specify the location of the PayMaster Properties File using the PropertiesReader.

Step 6 : Assign Response Message into Payment Response Entity

The merchant should assign the response message received from PayMaster into the PayMaster Response Entity using the setter(“ResponseMessage”,<response message returned by PayMaster Gateway>”) function.

Step 7 : Assign Values into PayMaster Response Entity

The merchant should call the UPP Payment Response Message Builder to process the response message and assign the values to the PayMaster Response Entity.

Refer to Pre-Auth Payment Parameters for the fields supported by the PayMaster Merchant Plug-In (MPI).

Step 8 : Retrieve Values from PayMaster Response Entity

The merchant can retrieve values from the PayMaster Response Entity using the getter(parameter name) function, which accepts only one parameter.

Ensure that the value of TxnStatDetCde is not equal to 5015, as this represents an invalid secure hash value.

Python

Step 1 : Packages

The merchant must set up and include the PayMaster Merchant Plug-In (MPI) Python packages in the merchant application.

Step 2 : Import

For UPP payments, the merchant should import the following modules into the merchant code:

• PropertiesReader – to read the properties files.
• PayMasterEntity – to assign all the acceptable values for PayMaster UPP payment.
• PaymentResponseMessageBuilder – to generate the PayMaster UPP payment response message.

Step 3 : Source Code

from com.PayMaster.Entities.PayMasterEntity import PayMasterEntity
from com.PayMaster.PropertiesReader.PropertiesReader import PropertiesReader
from com.PayMaster.MessageResponseBuilder.PaymentResponseMessageBuilder import PaymentResponseMessageBuilder

# Declare variable for Payment Master Properties - 1st Parameter = File Path, 2nd Parameter = File Name
propertiesReader = PropertiesReader("PayMasterProperties/", "UPPPayment.properties")

# Declare variable for Payment Master Entity
uppPaymentResponseEntity = PayMasterEntity()

# Get response message from PayMaster and set it into Payment Master Entity
uppPaymentResponseEntity.setter("ResponseMessage", responseMessage)

# Call Payment Master Payment Response Message Builder to set value
uppPaymentResponseMessageBuilder = PaymentResponseMessageBuilder()
uppPaymentResponseMessageBuilder.buildUPPPaymentResponseMessage(uppPaymentResponseEntity, propertiesReader)

if uppPaymentResponseEntity.getter("TxnStatDetCde") == '0000':
    merchantID = uppPaymentResponseEntity.getter("MerchantID")
    merchRefNo = uppPaymentResponseEntity.getter("MerchRefNo")
    txnStatus = uppPaymentResponseEntity.getter("TxnStatus")
    shAlgorithmType = uppPaymentResponseEntity.getter("SHAlgorithmType")
    shValue = uppPaymentResponseEntity.getter("SHValue")
    # To do ...

Step 4 : Indicate PayMaster Properties File Location

The merchant must specify the location of the PayMaster Properties File using the PropertiesReader.

Step 5 : Assign Response Message into Payment Response Entity

The merchant should assign the response message received from PayMaster into the PayMaster Response Entity using the setter(“ResponseMessage”,<response message returned by PayMaster Gateway>”) function.

Step 6 : Assign Values into PayMaster Response Entity

The merchant should call the UPP Payment Response Message Builder to process the response message and assign the values to the PayMaster Response Entity.

Refer to Pre-Auth Payment Parameters for the fields supported by the PayMaster Merchant Plug-In (MPI).

Step 7 : Retrieve Values from PayMaster Response Entity

The merchant can retrieve values from the PayMaster Response Entity using the getter(parameter name).

Ensure that the value of TxnStatDetCde is not equal to 5015, as this represents an invalid secure hash value.

Node.js

Step 1 : Library

The merchant shall set up and include the PayMaster Merchant Plug-In (MPI) Node.js library into the merchant application.

Step 2 : Functions

• MERCH_UppPaymentResponse()
  • This function should be used on the merchant's response page for UPP payment.
  • It processes the response parameters returned from the PayMaster Gateway and returns the result required by the merchant.

Step 3 : Source Code

var paymaster = require('./js/PayMaster.min.js');

module.exports = function (app) {
    app.get('/UPPPayment', (req, res) => {
        paymaster.PropertiesReader('./properties/', 'UPPPayment.properties');
        
        paymaster.MERCH_UPPPaymentResponse(req, paymaster.propDetails, function(err, response, result) {
            if (err) {
                throw err;
            }
            if (response) {
                if (paymaster.getter('TxnStatDetCde') === "0000") {
                    var MerchantID = paymaster.getter('MerchantID');
                    var MerchRefNo = paymaster.getter('MerchRefNo');
                    var TxnStatus = paymaster.getter('TxnStatus');
                    var SHAlgorithmType = paymaster.getter('SHAlgorithmType');
                    var SHValue = paymaster.getter('SHValue');
                    // To do ...
                }
            }
        });
        // More code here...
    });
};

Step 4 : Indicate PayMaster Properties File Location

The merchant must specify the location of the PayMaster Properties File using the PropertiesReader.

Step 5 : Retrieve Values from PayMaster Response Entity

The merchant can retrieve values from the PayMaster Response Entity using the getter(parameter name) function, which accepts only one parameter.

Refer to Pre-Auth Payment Parameters for the fields supported by the PayMaster Merchant Plug-In (MPI).

Ensure that the value of TxnStatDetCde is not equal to 5015, as this represents an invalid secure hash value.