UniPay Gateway Documentation

Are you ready?

In this tutorial we are going to learn how to enable PGP encryption for batch and real-time processing via the user interface.

For encryption/decryption of the fields in real-time API requests and batch request files, we will use public and private keys, generated by the gateway administrators. The private key, used for data decryption, is stored within the gateway. It is uploaded to the resources folder on the server and its name is added on the user interface, therefore encrypted fields in real-time API requests and batch request files can be decrypted automatically. The public key, used for data encryption, is not required to be stored within the gateway as it is used by a merchant only.

For encryption of batch response files, we will use a public key generated on the merchant's side. The name of this key is added to the processing settings of the merchant, therefore batch response files containing sensitive data are encrypted automatically before being sent to the merchant.

We will use the following parameters:

Private key used for decryption of fields in real-time API requests and batch request files:
Primary Private Key: gatewayprivatekey.asc
Primary Passphrase: gatewayprivatekey

Public key used for encryptiopn of batch response files:
Merchant's Public Key: merchantpublickey.asc
Firstly, let's set PGP keys that are going to be used both for real-time and batch processing.
Log in to the system using your Username and Password and switch to the Administration -> System Perspective.

Note: To learn how to log in and select perspectives, use the prerequisite tutorial Logging in and navigating the application.
Click Systembutton in the top right section of the screen.
Choose Settings menu item from the list.
Locate Services tab
Locate Batch Processing groupbox
Locate PGP Encryption groupbox
Enter gatewayprivatekey.asc into the Primary Private Keytextbox
Enter gatewayprivatekey into the Primary Passphrasetextbox
Locate Realtime Processing groupbox
Locate PGP Encryption groupbox
Enter gatewayprivatekey.asc into the Primary Private Keytextbox
Enter gatewayprivatekey into the Primary Passphrasetextbox
Click Savebutton
Now, when the name of the private key is added to the gateway, you can use PGP encryption for real-time API requests and batch request files. Using gatewaypublickey.asc public PGP key, received from the gateway support team, you can encrypt sensitive data within real-time API requests or an entire batch file with an external application for PGP encryption.

See integration notes for example of real-time API request with PGP-encrypted field.
Next, let's learn how to configure a merchant for using PGP encryption for CAU response files.
Switch to the Management -> Merchant perspective.
Select appropriate Merchant or Merchant Account in the top left section of the screen.
Click Detailsbutton in the top section of the screen.
Choose Processing menu item and choose Settings menu item from the list.
Locate File Encryption Public Ke... groupbox
Enter merchantpublickey.asc into the File Nametextbox. Account update response files will be encrypted with this key.
Click Savebutton
Congratulations, you are done!

You have learned how to set PGP keys for real-time and batch processing. Now you can do this by yourself.

Managing PGP keys

Useful Terms

Managing PGP keys

Tags