Integrating BluePay With Chargent In Salesforce

Salesforce Payments by Chargent is the leading payments application available on the Salesforce AppExchange. Chargent allows you to charge credit cards and Bank Account transactions directly from within Salesforce. This guide shows you how you can easily connect the BluePay (aka Clover) gateway with Salesforce using Chargent.

Not yet a Chargent customer? Get started today with a 30-day free trial!

About This Guide

Chargent supports BluePay’s card-not-present transactions for merchants and suppliers of any size in the United States and Canada. Now integrated into Clover, BluePay processes business-to-consumer and business-to-business payments while providing real-time settlement, reporting, and reconciliation. Integrate BluePay using Chargent to start processing payments in Salesforce today!

Using the instructions in this guide, connecting Salesforce to the BluePay gateway with Chargent is easy. Chargent’s integration with BluePay uses emulation. Emulation supports most standard credit card and ACH transaction types, including Authorize, Charge, Refund, and Void. Advanced features like tokenization and some fraud screening features are not supported via emulation.

Obtain a BluePay Sandbox Account

The first task is to get a test account from BluePay so that you can run test transactions from Salesforce.

To request a sandbox account, complete the form on the Sandbox Account Request page.


Upon approval, you’ll receive an email that contains these testing credentials:

  • Account ID
  • User ID
  • Password (temporary)

If you need any help, contact BluePay through their Support page.

Production account: You’ll also need to register for a production account. Use the contact information in the enrollment email messages to work with BluePay Support and obtain the same set of credentials for your production account.

NOTE: You must get at least your test credentials from BluePay before moving on to the steps in the next section.

Obtain the Secret key from your BluePay test account

As we explain in the next section, it’s necessary to enter the Security Key into Salesforce. Follow these steps below to locate your Secret Key for your BluePay account:

  1. Login to the BluePay Account page.
  2. In the menu, click Admin > Accounts.
  3. In the Account List panel, click the Account Name link.
    account name
  4. Scroll down to find the 32-character Secret Key. It is this key that you need to copy and paste into the Merchant Security Key field on the Gateway page in Salesforce (as given in the instructions in the next section).
    secret key

Prior to setting up BluePay in Salesforce

Prior to following the steps in this guide, Chargent should be installed in your Salesforce org and licenses assigned. If you have not yet installed, a 30 day free trial is available on our Installation Page.

Since Chargent’s BluePay integration is connected via Emulation, you will need to first add the Remote Site.

  1. Click the Gear icon on the top right side of Salesforce and select Setup
  2. Under Security click Remote Site Settings
  3. Click the button for New Remote Site.
  4. For the new remote site, enter “BluePay” for the Remote Site Name.
  5. Enter “” for the Remote Site URL.
  6. Click Save.

Setting Up Salesforce to Connect to BluePay

Add a BluePay Gateway record in Salesforce using Chargent’s Gateway Wizard.

  1. Click on the App Launcher on the top left side in Salesforce.
  2. Select Chargent as the App
  3. Select the Chargent Settings Tab
  4. Choose Chargent Setup Wizard
  5. Do you have a Payment Gateway account – Select Yes
  6. Select as your Payment gateway (BluePay uses emulation of
  7. Select Test Transactions for testing or Live Transactions if you are looking to process real payments.
  8. Follow the prompts to configure your gateway.
  9. Name your Gateway (BluePay Test or BluePay Live)

You will need the following information:

  • API Login ID:This is your BluePay Account ID
  • Transaction Key:This is the BluePay Secret Key
  • Endpoint Override:

Other information that will be asked:

  • Will you be using tokenization? Select No since Tokenization is not available through the Emulator.
  • What currency will you be using? (USD, CAN, etc.)
  • What payment methods will you be accepting?
  • Credit cards and/or Direct Debit / ACH (electronic check)
  • What Credit Card types will you be accepting? (Visa, Mastercard, etc…)
  • Payment Console Setup (Premium feature for Platform Edition)
    • Show Charge Button
    • Show / Create Update Token Button (this should be turned off since BluePay does not support tokenization)
    • Show Authorize Button

Add a BluePay Gateway record in Salesforce (Chargent versions prior to 5.40)

  1. Click on the AppLauncher on the top left side in Salesforce.
  2. In the Search for apps or items box, Search for Gateways and select
  3. Click New and select as the Gateway Type (BluePay uses emulation of
  4. Name the Gateway BluePay Test (or BluePay Live if you’re processing live credit cards)
  5. Map the following fields in Chargent with your credentials from BluePay:
      • Merchant ID:BluePay Account ID
      • Merchant Security Key: Your BluePay Secret Key
      • Endpoint Override:
  6. Setup the following Gateway fields
      • Active – Check to make the Gateway active
      • Use Tokenization – Leave this unchecked since Tokenization is not available through the emulator.
      • Available Card Types – Select the cards you will be accepting (this is based on your gateway settings and what card types they can process – Visa, Mastercard, American Express, etc..)
      • Available Payment Methods – Will you be accepting just Credit Cards or Direct Debit / ACH
      • Available Currencies – What currencies will you accept (this is based on your payment gateway and the currencies they accept payment in.
      • Credit Card / Bank Account Data Handling – This lets Chargent know when to clear the information in Salesforce. You have 4 options.
        • Never Clear
        • Clear After Successful Charge
        • Clear After All Transactions
        • Clear When Token is Present (recommended)
          new gateway

When using Payment Requests or Payment Console the following should also be set. Please note these features come with Sites and Platform edition & require activation in your Production Org.

    • Available PR Transaction Types
      • Charge Full Amount – Charges the credit card immediately
      • Authorize Full Amount – This option won’t charge the card but only holds the funds available until you capture them.
      • Authorize Minimum Amount – This option won’t charge the card but only holds the minimum amount that your gateway will allow. You will need to charge the correct amount in order to capture the transaction
        card types
      • Show Charge Button
      • Show Authorize Button
        pr transaction

Your Gateway page should look similar to the figure below once you have saved.

gateway details

Testing the Integration

Now that you have created the BluePay gateway record in Salesforce, it is time to run some test transactions to ensure it was set up correctly, and understand how Chargent works to take payments within Salesforce.

Create a Chargent Order in Salesforce to run test transactions

  1. Click on the App Launcher in the top left side and select Chargent as the App.
    chargent app
  2. Click the Chargent Orders Tab.
  3. Click on New
  4. Enter in the following information:
    • Account: The Account the Chargent Order should be associated with.
    • Payment Type should either be credit card or check depending on if you are testing credit cards
    • Billing Information
      • Billing First Name
      • Billing Last Name
      • Billing Address
      • Billing City
      • Billing State / Province
      • Billing Zip Code / Postal Code
      • Billing Email Address(if you want to test the email receipt that gets triggered upon a successful transaction)
    • Charge Amount- The amount you want to test with in order to process a test transaction. This can be any amount
    • Manual Charge check this box to enter a number directly in the Charge Amount. If you are entering Subtotal, Tax, and/or Shipping then the Charge Amount will be automatically calculated and the Manual Charge box does not need to be checked.
    • Credit Card Number = See BluePay test credit card information. BluePay uses different test credit card numbers to determine the response message and whether it’s approved or declined for specific reasons. For ACH testing see BluePay’s Test ACH Account and Routing Numbers.
    • Card type (Visa, MasterCard, etc..)
    • Card Expiration Month and Card Expiration Year should be in the future
  1. Click Save
  2. Click the Charge button. You will receive a pop-up asking for the CSC (Card Security Code). You can enter 123 for credit cards (1234 for American Express).
  3. Press the Charge button

You should receive a popup that shows the test transaction was approved.


Going Live

This section contains the procedure for configuring the integration in a production system.

First, obtain the production credentials for the BluePay production gateway account (similar to the method given for sandbox credentials in Obtain a BluePay Sandbox Account.

  • Get these production credentials from your enrollment email message:
    • Account ID
    • User ID
    • Password (temporary)

Sending Live Transactions from a Salesforce Sandbox

When Chargent is installed in a Salesforce Sandbox, transactions are typically sent to the payment gateway’s test / sandbox / development environment, regardless of whether Chargent’s Test Endpoint checkbox is checked. This is done as a security precaution, to prevent real transactions from being accidentally sent from a Salesforce Sandbox.

When Chargent is installed in a production or developer Salesforce org, checking the Test Endpoint checkbox on the Gateway record will route transactions to the test environments provided by the gateway.

Note: Some gateways use the same endpoint for live and test environments. For these gateways, the Chargent application does not prevent live transaction processing. As such, it is best practice to deactivate your live gateway records in orgs used for testing.

If you wish to send live transactions from a Salesforce Sandbox, as a final step in testing, simply use Chargent’s Endpoint Override field on the Gateway record, and enter the production endpoint of your chosen gateway there.

Here is the production endpoint URL for Chargent’s integration with BluePay:

Note that the full endpoint URL must be entered in the Endpoint Override field, and the domain must be present in the Remote Site Settings (for standard Chargent integrations it should be already present).

Going Live in Production

Repeat the steps in the Configuring Salesforce for BluePay Integration section above, but substitute the production credentials.

For the production Endpoint Override field, enter:

Repeat the steps in the Testing the BluePay Integration section above with respect to the SalesForce production environment, using the production credentials using live credit card data.

Void the transactions: If you’re using an actual credit card and want to prevent the charge from settling, remember to void the transaction after testing.

Be sure to successfully transmit at least one real credit card transaction using company or personal accounts. We recommend that you submit a transaction with a very small amount and then void that transaction afterwards. This ensures that the system works with your production credentials.

Understanding Transactions

When a transaction occurs between Chargent and the BluePay gateway, a new transaction record is created in Salesforce. The listing of transactions can be found under the Related tab of the Chargent Order.

Click a Transaction ID

link to see the details, as shown in the figure below.

This transaction record contains the entire set of data that BluePay sends in its response, including transaction Type (Charge, Authorize, Refund or Void), the Response Status (Approved, Declined, Error), and any related approval or error messages.

You can compare the transaction records in Salesforce with the records in your BluePay administrative app. As shown in the figure below, click the Processing menu category, then click Transactions > Transaction List. Then click the link for a specific transaction to view details.

Correspondence in the Transaction Fields

The Gateway Date is the timestamp for the submission to BluePay, and the Gateway ID field corresponds to the BluePay Transaction ID for use in reconciliation between two systems.

This table contains the mapping information between BluePay and Salesforce fields.

Salesforce field Direction Gateway field
Gateway ID < Transaction ID
Invoice Number > Invoice ID
PO Number > Order ID