--- title: "Set Up Converge for Payments" slug: "set-up-converge-for-payments" description: "Learn how to configure CivicPlus Payments with Converge, including whitelisting IPs and setting up hosted payment forms for seamless transactions." updated: 2025-07-24T16:31:03Z published: 2025-07-24T16:31:03Z canonical: "www.civicplus.help/set-up-converge-for-payments" --- > ## Documentation Index > Fetch the complete documentation index at: https://www.civicplus.help/llms.txt > Use this file to discover all available pages before exploring further. # Set Up Converge for Payments This process is necessary for CivicPlus Payments 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. > [!NOTE] > 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**](/civicplus-help-center/docs/)**.** > - 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 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 Payments. 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](https://www.cppay.civicplus.help/hc/en-us/articles/360042707893) 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 > [!WARNING] > **Note**: This is because Payments 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![Hosted payments option on the Settings tab.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047642903.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=CIQgQ%2BXYk4%2FF%2FWN2Sv2m8ViG%2Fg7%2FwQgKDI11bpIu2R4%3D)** 2. Click **Setup** for the **Payment Page![Setup payment page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047633943.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=eUi08iRw1cmecFS%2BBz2xgeB5egz8oO7O1eGhQTne49g%3D)** 3. Click **Billing Address** ![Billing address option on Payment page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042585367.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=V3iEtl9sycsfwFbipLuOW8HUyFB1YEr0pbk98L1AuAc%3D) 4. Uncheck **Phone** and **Email Address** ![Phone and email.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047564439.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=3XcQizICPHG72EinxtgD9xiCIuKJvzLlPPQ2YqtwTGc%3D) > [!WARNING] > **Note**: If you do not turn off Email Addresses, it is possible your users will receive duplicate or bad receipts. 5. Click **Shipping Address![Shipping address.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042522391.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=pOFLeZZCUiA037J6sVYRNKt0dwDvQym9Bd684WFsw5I%3D)** 6. Turn off the **Shipping Address** ![Turn off shipping.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042802199.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=M1NY8BILzo37V1yGn0d4b2fvAkk3ThbQ10V2yqBWN1M%3D) 7. Return to the main setup page ![Back arrow next to shipping address.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047781655.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=tM1yXI4YEJXeeucitPUwu6q0iu3W391%2BaxxeMKlHmqA%3D) 8. Scroll down and paste in the **Cancel Link![Cancel payment.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042774039.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=aIA188R6%2BLYFPGxMqU0Sdfikvr8a57AgJK0kFo2ZG6U%3D)** > [!WARNING] > **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![Response page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047752727.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=qVmJNA1RTVYLW5SOgLxgulkeazqFVU%2FkBHiNLZUCKiM%3D)** 10. On the **Approval Page** paste in the link to the **Button Link![Button link.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047715479.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=lunITuk5JcSa9u9Twiq8JgfDconokq%2Frqk4%2FUbV3p64%3D)** > [!WARNING] > **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![Decline page tab on the Response Page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042734999.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=BOzWFZJyjl%2BfNmfZtivBhtbV%2FZkjXNYL2NJKbsVSz%2BI%3D)** 12. **Paste** in the link to the **Button Link![Button link decline page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042707863.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=%2Bk%2BDhuhrBe89yHOQwspvKO%2FDjneKwil4x33efDdQa6E%3D)** > [!WARNING] > **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 ![Redirect URL tab on the Response Page.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042707991.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=JnayyuM6qxQhc3OR8jauV0u0xBl7cb8cSiR7RAV%2FUDI%3D) 14. **Paste** in the link to the **Redirect URL![Paste redirect URL.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640042674583.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=d9vTMV%2FdxToifPQHoGehNnu%2FGCm6mAG8wZola3OFEro%3D)** > [!WARNING] > **Note**: Make sure you select **POST**. Do **not select GET** as this may break the setup process. 15. Click **Save![Save button.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640047659799.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=XdeUSnk%2F1%2BTy%2BaqKSU99P9YBAR6psSMpmEEawxCpxE0%3D)** ## Set Up Payment Fields in Converge 1. Log in to Converge, go to **Settings**, and select **Payment Fields** ![Payment fields option on the Settings tab.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640132757271.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=VK2VBJ1oVO%2BTO8ZhUf6EcZfVXcdEibCel8PKWbSeDJs%3D) 2. In the **Order** **Section**, click **Add Payment Field![Add payment field.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640133322903.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=VaxRKEhbthRGfFXd3GbHU4YL1Jj4jsERP65YLK8QkZo%3D)** 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.**![Converge fields.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640191192727.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=XzMrJhOCm0qFaNVWvrNTjlQdRJTLmhFr2%2F3ArBUJ9YU%3D)** - **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![Add button.](https://cdn.us.document360.io/17dc564a-8310-4f61-b929-1bd73b36e158/Images/Documentation/10640237302807.png?sv=2026-02-06&spr=https&st=2026-11-22T13%3A15%3A23Z&se=2026-11-22T14%3A15%3A23Z&sr=b&sp=r&sig=FyLzfoibOa0zEVMrzu2nlXOxk%2BU3R8KDwf5Zsy4WibE%3D)** Identification or Identifier. Internet Protocol.A set of rules for communication over the internet or a local network, such as sending mail, streaming videos, or connecting to a website. Uniform Resource Locator Application Programming Interface. A set of rules that allows programmers to develop software for a particular operating system without having to be completely familiar with that operating system. Personal Identification Number.