Chargent for Salesforce Billing

Installation
User Guide

Installation #

Step 1: Package Installation #

Prerequisites  #

Packages  #

• Salesforce CPQ 222.2, or later must be installed first.
• Salesforce Billing, Version Summer ’19 220.7 or later must be installed first.
• Consumption Schedule must be enabled.  Contact Salesforce support for enablement if needed.

Install Links #

Chargent Gateways Connector for Salesforce Billing

Step 2: Salesforce Organization Setup #

Add Gateway Type #

In order to add Chargent gateways to your Salesforce Billing setup, you will first need to create a new Gateway Type in the Global Value set. To do this simply:

1. Navigate to Salesforce Setup
   
2. In the search box type “Picklist Value Sets”
3. Click on “Picklist Value Sets”
4. Find the “Gateway Type” value set
5. Click On the “Gateway Type” label
   
6. Click “New” under values
7. Type “Chargent Gateway” in the text box – exclude the quotes
8. Check the box that reads “Add the new picklist values to all Record Types that use this Global Value Set.”
9. Click the [Save] button

Permission Set Assignment #

Assign the “Chargent Gateway Admin” permission set to users who will set up and / or edit the Gateway records. Typically, it is advised to only provide this permission to Admin users.

1. Navigate to Salesforce Setup
   
2. In the search box type “Permission Sets”
3. Click on “Permission Sets”
4. Click on “Chargent Gateway Admin”
5. Click the [Manage Assignments] button near the top of the screen
6. Click the [Add Assignments] button

7. Check the box next to users you wish to grant access, then click the [Assign] button.

Add Chargent Gateway to Custom Setting #

1. Navigate to Salesforce Setup
2. In the search box type “Custom Settings”
3. Click “Custom Settings”
4. Next to Payment Gateway Config click “Manage”

5. Click the [New] button
6. Complete the Fields:
   1. Name
      1. Chargent Gateway
   2. Gateway Class Name
      1. ChrgntBllng.ChargentGatewayAPI

7. Click the [Save] button

Update the Payment Gateway Page Layout #

NOTE: Completing this step can be done in two ways; Adding the “Chargent Gateway” field to the default “Payment Gateway” page layout, or assigning the “Chargent Gateway Layout” to the needed profiles. We recommend the first option, adding the “Chargent Gateway” field to the default “Payment Gateway” page layout, as it’ll ensure that your “Payment Gateway” layout remains as up-to-date as possible in cases where Salesforce.com updates this Object.

To add the “Chargent Gateway” field to the Payment Gateway Layout, follow these steps:

1. From the Salesforce Setup page, click the “Object Manager” tab
2. Click on “Page Layouts” in the left-side menu
3. Click “Payment Gateway Layout”
4. From the “Fields” section of the palette, drag the “Chargent Gateway” field (ChrgntBllng__Chargent_Gateway__c) onto the Payment Gateway layout
   
5. Click the [Save] button

If you wish to instead assign the Chargent Gateway Layout to the appropriate profiles, follow these steps:

1. From the Salesforce Setup page, click on the “Object Manager” tab
2. Click on “Payment Gateway”
3. Click on “Page Layouts” in the left-side menu
4. Click the [Page Layout Assignment] button
5. Click the [Edit Assignments] button
6. Select the appropriate profiles (those you wish to use for this feature). Hold the CTRL button while clicking to choose multiple profiles
   
7. From the “Page Layout to Use” picklist, choose “Chargent Gateway Layout”
8. Click the [Save] button

Step 3: Setup Your Chargent Gateway Record #

1. Click the App Launcher icon at the top-left of the screen
2. Search for and click on “Chargent Settings”
3. Click the “Chargent Setup Wizard” tab
4. Choose your payment gateway from the picklist
5. Enter your payment gateway credentials, then click the [Sign In] button
6. Choose whether to enable Tokenization. (We highly recommend enabling it in order to protect yours and your customers’ data.)
7. Select the Currency Types you plan to accept, then click the [Continue] button
8. Select the Payment Methods you plan to accept, then click the [Continue] button

Step 4: Salesforce Billing Payment Gateway Setup #

1. Click the App Launcher icon at the top-left of the screen
2. Search for “Payment Gateways,” then click on “Payment Gateways”

Note: There will be two different Payment Gateway objects. You want to select the one that is installed with the Billing Connector package.

3. Click the [New] button
4. Complete the following fields:
   • Payment Gateway Name
   • Check the Active box
   • Check the Default (Based on your requirements)
   • Gateway Type should be Chargent Gateway (See organization setup above if not present)
   • Chargent Gateway – Lookup to the Chargent Gateway record you created in the previous step
5. Click the [Save] button

Chargent for Salesforce Billing – Customer User Guide #

• Salesforce CPQ 222.2, or later must be installed.
• Salesforce Billing, Version Summer ’19 220.7 or later must be installed.
• Consumption Schedule must be enabled. Contact Salesforce support for enablement if needed.
• Chargent for Salesforce Billing must be installed and configured based on the documentation.
• The Chargent Base Package must be installed.
• You have your Chargent Gateway setup using the Chargent Base package and Setup Wizard.
• You have a Salesforce Payment Gateway set up in Salesforce that connects to the Chargent Gateway record.

In Salesforce Billing a few steps need to happen before you can process a payment using the Chargent for Salesforce Billing component.

1. Create a new Opportunity
2. Create a Quote from the Opportunity
3. Create a new Order from the Quote
4. Check the Bill Now checkbox to create an Invoice record (if you are looking to apply payment towards Invoices).

Take Payments Using Your Gateway of Choice #

Your gateway can be used according to the documentation for Payment Gateway usage provided by Salesforce Billing. Salesforce provides great documentation for taking payments! Click here to see these docs.

Payment Methods Supported #

Cards (Credit/Debit/Prepaid/Procurement) #

Chargent for Salesforce Billing will support all cards supported by your payment gateway and payment processor.

Tokenization #

Tokenization can be used for both cards and bank drafts (ACH/eCheck/EFT/Direct Debit).

Note: Tokenization for all payment methods is not supported for every gateway. You should check our documentation specific to your gateway to see if it supports tokenization.

Bank Account Tokenization #

When creating a new bank payment method (direct debit/EFT/ACH) via the “New Payment Method” button in Salesforce Billing, the payment method will not immediately be tokenized. Only once a payment is made using that payment method, will Chargent perform the tokenization, if enabled.

Processing Payments using Chargent for Salesforce Billing  #

Processing Payments Using the Payment Center #

From an Account Record click the [Payment Center] button.

You will have 3 options

• Total Balance – Pay the complete balance due for a specific Account
• By Invoice (Recommended) – Choose an Invoice you want to apply a payment towards. This includes partial payments as well.
• By Amount– Select a specific amount to apply payment towards a specific Account.

Total Balance #

Selecting Total Balance and pressing the [Next] button, it will bring you directly to any stored credit cards or ACH bank information on file.  You can then use the existing payment information to process the remaining balance of the Account.  

Clicking the [Pay Now] button will allow you to process the full balance.

By Invoice (Recommended) #

Selecting ‘By Invoice’ will allow you to choose to pay in Full or add a Partial Payment towards an open Invoice.  Select the [ + ] next to the Invoice and either the [Full] or [Partial] option. Click the [Next] button to go to your stored Payment Methods.

Note: If you choose [Partial] you will need first to edit the amount by clicking the pencil icon prior hitting [Next] and moving to the stored Payment Methods.

Select the Payment Method and click the [Pay Now] button to complete the transaction.

The Invoice will update

• Invoice Status is changed from Draft to Posted
• Invoice Payment Status is changed from Unpaid to Paid

By Amount #

Selecting ‘By Amount’ it will allow you to enter an amount that will be applied to the Account’s balance.

Enter the specific amount and click [Next] to go to the Payment Method Page.

Select the Payment Method and click the [Pay Now] button to complete the transaction.

If the transaction is successful you will see the pop-up window showing Success.  You will also have the option to Return to the Account or Review the Payment details.  A Payment Transaction Record will be created logging the payment in your Salesforce Org.

Processing Payments using Payment Virtual Terminal on the Invoice #

Adding the Payment Virtual Terminal button to any of the Salesforce objects makes it even easier to process Payments anywhere in Salesforce Billing.

Similar to processing payments from the Payment Center, when you click the Payment Virtual Terminal button you will see the following payment options.  

• Total Balance
• By Invoice

Total Balance  #

Selecting Total Balance and pressing the [Next] button, it will bring you directly to any stored credit cards or ACH bank information on file.  You can then use the existing payment information to process the remaining balance of the Account.  

Clicking the [Pay Now] button will allow you to process the full balance.

By Invoice (Recommended) #

Selecting ‘By Invoice’ will allow you to choose to pay in Full or add a Partial Payment towards an open Invoice.  Select the [ + ] next to the Invoice and either the [Full] or [Partial] option. Click the [Next] button to go to your stored Payment Methods.

Note: If you choose [Partial] you will need first to edit the amount by clicking the pencil icon prior hitting [Next] and moving to the stored Payment Methods.

Select the Payment Method and click the [Pay Now] button to complete the transaction.

The Invoice will update

• Invoice Status is changed from Draft to Posted
• Invoice Payment Status is changed from Unpaid to Paid

Payment Transaction #

Enter and Saving New Payment Methods #

Salesforce Mapping #

Keep in mind Salesforce sends the data to your Payment Gateway.  Chargent does not control what fields are sent.  You should check with Salesforce for accuracy.  Here are some of the fields that will be mapped from your gateway to the Salesforce Payment Transaction record.  

	Gateway Fields		Salesforce Billing Fields	Copied to Payment Method Record
Card Details	Card Type	<	Card Type	Payment Method Record
	Card Holder	<	First Name / Last Name	Payment Method Record
	Card Number	<	Card Number	Payment Method Record
	Expiry Date	<	Expiration Month / Expiration Year	Payment Method Record
Shopper Detail	Reference	<	Account Record ID
	Token	<	Payment Gateway Token	Payment Method Record
	Billing Address	<	Billing Address 1, Billing Address 2, Billing City, Billing State, Billing Zip Code	Payment Method Record