Enable card and bank payments in one place

Powerful payment gateway

Trusted choice for secure online transactions.

Integrating USAePay Payment Gateway with Salesforce using ChargeOn

USAePay can be custom-integrated with Salesforce, but the process is largely manual. It depends on Apex development, custom Lightning Web Components (LWC), and tokenization, and comes with its own set of challenges.

Explore these gaps, the solution to them, and the stepwise integration guide with us.

Table of Contents

USAePay Salesforce integration challenges

  • Integrating the USAePay payment gateway with Salesforce requires custom API development and manual setup. This places a heavy technical burden on your business teams, shifting their productivity to infrastructure rather than growth.
  • Network errors, out-of-order events, or domain changes trigger retries. Without proper validation in place, those retries can result in duplicate charges, lost transactions, or mismatched records.
  • A manually built integration creates vendor dependency. Any platform update or change on either side can break the connection, leaving your payments stuck until someone fixes it.
  • Your payment data lives in USAePay, while customer and sales data live in Salesforce. Without a direct connection, your teams have to work with a fragmented, incomplete picture of every transaction.
  • Your finance and sales teams pull separate reports and reconcile them manually. This process is slow, error-prone, and unscalable with increased transactions. Additionally, they have to switch back and forth, that breaks focus and slows down operations.

However, ChargeOn is your go-to solution to eliminate all these challenges!

How does ChargeOn resolve USAePay Salesforce integration challenges?

ChargeOn is a 100% Salesforce native payment processor and orchestration platform. It offers a centralized view of all your payments in Salesforce, bringing data from USAePay and Salesforce together.

ChargeOn provides prebuilt flows for one-time and recurring payments, reminders, retries, payment links, and much more. Additionally, it offers tokenization, PCI DSS-compliant processing, and secure data flows with a failover backup mechanism.

Step-by-step USAePay Integration with Salesforce using ChargeOn

Before you proceed with the steps, ensure you have completed the prerequisites

This guide helps you in:

  • Assigning appropriate permissions to relevant users
  • Configure and set up ChargeOn

Note: Screenshots and details may differ based on your gateway version.

Create a USAePay Sandbox Account

You require test credentials to proceed with the account. If not available, you need to create a USAePay sandbox account.
Test the account you created by logging in
Step - Log in to the USAePay Developer Portal
  • If the login fails, you need to register and sign up again
Step - Fill in all the details
  • Fill in all the details
  • Click on ‘Register new account
  • Request for the Sandbox Account in the developer portal
  • In order to set up a sandbox account, click the Request Test Account tab in the sidebar and complete the form to obtain your login credentials
    • The fields are:
      • Requested Username: The username you would like to use to log in to the sandbox account
      • Contact Name
      • Company Name
      • Email: The email you want your credentials to land in
Step - Setup Sandbox Account
Note: You must not leave any of the fields blank. This will delay your account setup.
  • Post completion, click on Submit Request. When successful, you will receive a message
Note: Processing requests takes a few hours during regular office hours, which are based on Pacific Standard Time. Requests made on weekends may have a turnaround time of 24 hours or more.
  • Collect the required credentials

Configure the USAePay payment gateway in ChargeOn

For configuring the USAePay gateway in ChargeOn, the following details are required:
  • API Username
  • API Password
Once your sandbox account is created, you will receive an email with your login credentials.
Use those credentials to log in at https://sandbox.usaepay.com/login.

Create your USAePay gateway record in Salesforce

To create a USAePay gateway record in Salesforce, you need to configure the gateway in ChargeOn.
Step 1: Open ChargeOn App
  • Click on the App Launcher (9-dot icon)
  • Search for ChargeOn.
  • Click to open the ChargeOn application.
Step 2: Navigate to the Payment Gateway tab
  • From the ChargeOn app navigation bar, open the Payment Gateway tab.
  • Click New to create a new Payment Gateway record.
Step - Click new to create a new payment gateway record image
Step 3: Select the gateway
  • In Select Gateway, choose USAePay from the dropdown.
Step 4: Select payment methods
  • Under Select Payment Method, move the following options from Available to Selected:
    • Instant
    • Schedule
    • Recurring

These define how payments can be processed using this gateway.

Step 5: Select payment types
  • Under Select Payment Types, move the following options from Available to Selected:
    • Card
    • eCheck
    • Link
Step - Select Payment Method & Type image
Step 6: Enter basic payment gateway details
  • Fill in the required fields as follows:
    • Payment Gateway Name
    • Default Currency: USD
    • The supported currencies: USD
    • Base URI: https://sandbox.usaepay.com/api/v2/
    • Minimum Charge: $1
Note:
  • Use the apitest URL for sandbox/testing
  • Replace with the production URL when configuring live payments

Step 7: Add gateway credentials

  • In the Gateway Credentials section, add the following key-value pairs:
    • Key: apipin
    • Value: {your apipin }
    • Key: apikey
    • Value: {your apikey}

Step 8: Review all details carefully and click Save

The USAePay payment gateway is now configured and ready for use in ChargeOn.

Test your transactions in a Salesforce Sandbox

You can test your integration in multiple ways.

We are sharing one of the simplest ways to test the same using USAePay payments.

USAePay payment allows you to make payments using a payment link via Credit card or using a bank account number.

  • Selects the payment gateway to start the payment process
  • Once the gateway is chosen, select USAePay Payment as the payment method
  • Choose the payment mode: instant, schedule, or recurring payment
  • Enter basic personal details, such as Payee Name, Email, and Payable Amount
  • Click the Charge button to submit the payment
The system securely sends the Payment URL to the customer's email. The customer securely processes the payment using a credit card and bank account.
A confirmation email is automatically sent to the customer, and the payment details are saved in Salesforce for tracking and records.

Prepare to go live in production

After the testing is completed in the Sandbox, the configuration can be migrated to the production environment

  • After testing and development, switch the source key to the key generated from the live account and change the processing URL from https://sandbox.usaepay.com/api/v2/ to https://usaepay.com/api/v2/
  • Go to the live USAePay environment and get the credentials with the same steps we mentioned above. For example
    • Credential 1
      • Key: x-api-key
      • Value: {your x-api-key}
  • Add these credentials to ChargeOn, and now your data is ready for the live environment

Post deployment, perform controlled production testing to validate end-to-end payment processing before enabling the solution for live users.

With this, your USAePay integration with Salesforce is successful using ChargeOn. 

In case you encounter any challenges or errors during this setup, please reach out to our ChargeOn experts, who will assist you. 

Refer to our Salesforce Multi-Gateway Setup Guide for integrating multiple payment gateways and optimizing your Salesforce payment integration. This eliminates the dependency on a single vendor.

Apart from USAePay, ChargeOn supports other widely used global payment gateways, including:

Download our ChargeOn prerequisite guide

Fill this form to get access to our E-guide!