Set up the Integration (External)

Modified on Fri, Mar 27 at 9:03 AM


1. Introduction

The following guide can be used to help you, our valued customer, understand how to set up the NetSuite-Chargezoom integration.  Since every installation and configuration of NetSuite is unique, this guide attempts to provide a "lowest common denominator" process for helping you to understand the requirements from your side.  This installation and configuration is meant to be performed with a Chargezoom agent on a screen share, guiding and directing you through every step of the process. 


2. Accessing the Feature

  1. Before you begin the install, it is best practice to go into your settings and ensure you have the prerequisite features enabled:

    • Confirm "REST WEB SERVICES", "TOKEN-BASED AUTHENTICATION" and "OATH 2.0" are set up.  Go to Setup → Company → Enable Features

      • Go to SuiteCloud Sublist and locate the three items highlighted in yellow below.
      • ....
  2. Next, we will go find the app and install it.

    1. In NetSuite, go to customization → SuiteBundler→Search and Install Bundles

      In the keywords field, type "Chargezoom".  The bundle itself is called "Chargezoom AR"

    2. Type Chargezoom in the search, and then select the item shown below in yellow

  3. Click on the bundle, and click the install button on the next screen.  NetSuite may take you to another page where you must click the install bundle button again.

    Note, this can take several minutes.


3. Step-by-Step Instructions

  1. Now that the App is installed, we will configure it.  Please ensure you have logged into NetSuite with Admin access to start.
  2. You will need to provide the following information to the Chargezoom agent you are working with

    •  a. Account Name: Setup → Company → Company Information → Company Name

    •  b. Account ID: This value can be taken directly from the NetSuite URL as shown in the page below, td2980611

    •  c. Subsidiary Name & ID: Setup → Company → Subsidiary Settings Manager and select the top entry as highlighted below.

  3. Provide Client Credentials.  Start by creating an Integration record following the steps below

    • a. Setup → Integration → Manage Integrations → New

      • Name: Chargezoom API Integration
      • Description: Note that this record is for the Chargezoom API integration
      • Verify the following checkboxes are checked:

        • TOKEN-BASED AUTHENTICATION
        • AUTHORIZATION CODE GRANT
        • TBA: AUTHORIZATION FLOW
        • RESTLETS
        • REST WEB SERVICES
        • SUITEANALYTICS CONNECT
      • CALLBACK URL = https://payportal.com
      • REDIRECT URL = https://payportal.com
    • b. After pressing the Save button, STOP.  On the next screen, you will need to copy the Consumer Key and the Consumer Secret and provide these to your Chargezoom Agent

  4. Provide Access Tokens

    1. Start this step by ensuring a user has the "Chargezoom Integration Role".  This can be done by creating a new user or simply assigning the role to an existing user.  This will be the user whose name is listed in documents in NetSuite.  See pic below
    2. In all audit logs/system information, the integration user's name will be listed with the record.  The Integration User in the pic below is Wade Simmons

    3.  Go to Lists → Employees → New

      • NAME = Chargezoom Integration
      • EMAIL = <<your admin email address>>
      • Then proceed down to bottom of page and select the "Access" sublist. Make sure "GIVE ACCESS" is checked and the add the Role = "Chargezoom Integration Role". Click the Add button, then click Save.

    4. Now that we have a user and a proper role assigned, we can generate the tokens. 
    5. Go to Setup → Users/Roles → Access Tokens → New

      • APPLICATION NAME = Chargezoom API Integration
      • USER = Chargezoom Integration (or whichever user you provided the Chargezoom Integration Role to). This will be the user who has his/her name listed in records.
      • ROLE = Chargezoom Integration Role
      • TOKEN NAME = will be filled in by default.
    6. After pressing the Save button STOP.  On the next screen, you will need to copy the TOKEN ID and the TOKEN SECRET and provide these to your Chargezoom Agent

  5. The final step is to enter the Chargezoom API Key into the Chargezoom settings file

    • API Key: Once all the fields above are completed, the Generate API key button in the Chargezoom interface becomes live.  Press this button to generate the API key, then use the copy button next to it to copy the key to your clipboard.  Finally, we need to put this API Key into the customer's NetSuite instance. 

    • In NetSuite, search for Chargezoom settings file and click on the yellow name highlighted below

    • Open the file in Edit Mode  
    • Put the API key into the field for Default API Key and click save.

    •  This is also where you set some defaults including the base payment URL which will be given to you by the Chargezoom agent.  

      1. Set Environment = "Production"
      2. Set Default Payment Account and Default Accounts Receivable
      3. Remove Base Payment URL


4.  Confirming the integration is complete

  1. After the API key has been added to NetSuite, the next step is to confirm that the systems can communicate.  

    1. Create a dummy invoice to ensure that the invoice is populated with a Chargezoom payment link.  
    2. Make a dummy payment using the link, and confirm the payment flows back through NetSuite and updates the Invoice accordingly

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article