Set Up Converge for CivicPlus Pay

This process is necessary for CivicPlus Pay to be allowed to communicate with the Converge gateway. This article describes the process of calling Converge and configuring your hosted payment form.

Disclaimer

This article is for information purposes only. We cannot guarantee the accuracy of the steps below as Converge may make modifications to what things are called or where they are placed. The outline below should be substantially similar to what you should see on the Converge site.

Important Notes

• Please be aware that you must have your federal tax ID, merchant ID, or bank information ready before calling in.
• You will also need to get the IP addresses and redirect URLs from your implementation consultant or CivicPlus support.
• The IP addresses only need to be whitelisted on the Converge terminals that you will be using for internet / Hosted Payment Pages. If you add whitelisting to your retail terminals, all of your transactions will be blocked. This is because this traffic comes directly from the computer you use for card-present transactions and not from CivicPlus.

Customer Responsibilities

If you (as the customer) do not set up an API (application program interface) user, whitelist the correct IP address, or configure your hosted payment form, users will not be able to complete a transaction. 

Call Converge

1. Call Converge at 1-800-377-3962, Option 2, then Option 2. On the call, make the following requests:
   1. Request that they enable NextGen HPP (Hosted Payment Page) on the Terminal associated with your API user ID
   2. Request that they whitelist the IP address given to you
   3. Request that they create a registered API user. Collect the username and PIN and give them to CivicPlus for setting up CivicPlus Pay.
   4. Request that they set up a shared token vault across all your terminals. This step is only important if you are planning to save cards-on-file
   5. Request to enable HTTP POST for your account.
2. You can ensure that Converge performs these requests in two areas:
   • Area 1: In the Online Security Whitelist Manager, called Valid IP Addresses
   • Area 2: In the Fraud Prevention Rules, called IP Address Whitelist 
3. You can ensure that Converge set up a registered API user under Online Security Whitelist Manager Registered API Users
4. If problems persist, you may request that Converge disables the registered domain referrer restriction so that any referrer can be used
    
   Note: This is because CivicPlus Pay URLs contain dynamic values and Converge’s referrer restriction requires an exact URL.

Set Up the Hosted Payment Page in Converge

After the phone call, you will need to configure your Hosted Payment Page (HPP). If you do not configure these links, users will be redirected to incorrect places when they cancel or complete a transaction.

In the Payment Page settings, update the Approval button, Cancel button, Decline button, and the Redirect URL to be the URL given to you.

1. Log into Converge and navigate to Settings and select Hosted Payments
   
2. Click Setup for the Payment Page
   
3. Click Billing Address
   
4. Uncheck Phone and Email Address
   
   Note: If you do not turn off Email Addresses, it is possible your users will receive duplicate or bad receipts.
5. Click Shipping Address
   
6. Turn off the Shipping Address
   
7. Return to the main setup page
   
8. Scroll down and paste in the Cancel Link
   
   Note: Make sure you select POST and check Include Original Post Data. Do not select GET as this may break the setup process.
9. Navigate to the Response Page
   
10. On the Approval Page paste in the link to the Button Link
    
    Note: Make sure you select POST and check Include Original Post Data. Do not select GET as this may break the setup process.
11. Select the Decline Page
    
12. Paste in the link to the Button Link
    
    Note: Make sure you select POST and check Include Transaction Data. Do not select GET as this may break the setup process.
13. Navigate to the Redirect URL tab
    
14. Paste in the link to the Redirect URL
    
    Note: Make sure you select POST. Do not select GET as this may break the setup process.
15. Click Save
    

Go to Article Navigation

Set Up Payment Fields in Converge

1. Log in to Converge, go to Settings, and select Payment Fields
   
2. In the Order Section, click Add Payment Field
   
3. In the pop-up, fill out the information to match exactly. Make sure that you follow all casing and spacing. Any mistakes that you make will result in missing transactions. For example, you must put cp_trans_id. If you put “CP_trans_id” that will not be a match because ‘CP’ should be lowercase.
   
   • Field 1: CP Trans ID
     • Name: cp_trans_id
     • Display Name: CP Trans ID
     • Display Name French: CP Trans ID
     • Section: Order Section
     • Field Type: Text
     • Minimum Number Characters: Leave blank
     • Maximum Number Characters: 36
     • Check the box: Forward on Approval, Forward on Decline, and Show on Export Script
   • Field 2: CP Form ID
     • Name: cp_form_id
     • Display Name: CP Form ID
     • Display Name French: CP Form ID
     • Section: Order Section
     • Field Type: Text
     • Minimum Number Characters: 1
     • Maximum Number Characters: 50
     • Check the box: Forward on Approval, Forward on Decline, and Show on Export Script
   • Field 3: CP Form Type
     • Name: cp_form_type
     • Display Name: CP Form Type
     • Display Name French: CP Form Type
     • Section: Order Section
     • Field Type: Text
     • Minimum Number Characters: 1
     • Maximum Number Characters: 50
     • Check the box: Forward on Approval, Forward on Decline, and Show on Export Script
4. Select Add
   

Go to Article Navigation