This guide contains instructions for integrating your Salesforce.com environment with the Ezidebit payment gateway—using the Chargent payment processing plug-in.
Click a link to go directly to one of these sections:
Ezidebit is an Australia based payment provider that offers a range of online payment solutions to merchants worldwide. Based in Australia and now part of the Global Payments network, Ezidebit has been empowering businesses, large and small since 1998. Over the years, we’ve helped thousands of businesses across Australia, New Zealand, and Hong Kong to regain control of their cash flow through the use of secure online payment solutions, including Direct Debit, BPAY and E-Commerce. Ezidebit specialise in bringing revenue more efficiently to businesses across a diverse range of sectors, including childcare, fitness, education, accountancy and charities, to name just a few.
Using the stepwise instructions in this guide, it’s easy to connect Salesforce to the Ezidebit gateway with Chargent Payment Processing. Chargent has many features to offer, including automating and streamlining Salesforce payment processes, easy subscription management, click-to-charge buttons, payment request emails, and more.
Integrating Ezidebit with Chargent gives you the ability to easily build a seamless process for completing payment for orders that you manage in Salesforce. The integration connects the Ezidebit gateway directly to Salesforce. Chargent also supports Ezidebit gateway tokenization for processing credit card and direct debit payments. See Configuring Salesforce for Ezidebit Integration for additional information on the gateways.
The first task is to get a sandbox / test account from Ezidebit so that you can run test transactions from Salesforce. To being the process for obtaining a sandbox account, complete the form on the Enquiry page.
Upon approval, you’ll receive an email that contains these testing credentials:
Click the link in the email to go to the administration login page:
Login with your username and temporary password, and then follow the prompts to change your password.
Need help? Contact Ezidebit through the options given on their Support page.
On your first successful login, you’ll get a prompt to enter a permanent password of your own choosing. The password must be:
In the same email that contains your credentials you also find a Digital Key.
You will need each of these to configure the gateway connection in Salesforce:
See the next section, Configuring Salesforce for Ezidebit Integration.
Production account: You’ll also need to register for a production account. When you’re ready, use the contact information in the enrollment email messages to work with Ezidebit Support and obtain the same set of credentials for your production account.
NOTE: You must get each of these gateway credentials from Ezidebit before moving on to the steps in the next section, Configuring Salesforce for Ezidebit Integration.
Follow the steps below to configure Salesforce to integrate with Ezidebit:
NOTE: Both the sandbox and production installation of Chargent include a free, 30-day trial license.
|Gateway Page Field||Value|
|Gateway Name||Enter an easily recognizable name for this gateway, such as “Ezidebit Test”.|
|Merchant ID||Digital Key|
|Merchant Security Key||Digital Key|
|Active||Check this box|
NOTE: The Ezidebit Digital Key is taken from your Ezidebit introductory email message. See the section above, Get your Digital Key.
This section contains the procedure for testing the integration that you set up according to the procedure given in Configuring Salesforce for Ezidebit Integration, using your Ezidebit sandbox credentials.
Follow the steps below to verify that the integration is correct.
See the figure to the right, which indicates Chargent Orders for the purpose of illustration. (If you installed the Chargent Opportunities or Cases package, you would use that object for testing).
|Card Type||Card Number||Expiry Date||CVN|
|MasterCard||5123 4567 8901 2346||Current month/year||Any|
|Visa||4987 6543 2109 8769||Current month/year||Any|
|Amex||3400 0000 0000 009||Current month/year||Any|
|Amex||3411 1111 1111 111||Current month/year||Any|
|Amex||3421 3589 8797 783||Current month/year||Any|
|Amex||3423 3764 9030 528||Current month/year||Any|
|Diners Club||3012 3456 7890 19||Current month/year||Any|
See the figure below for the placement of these fields.
When Chargent is installed in a Salesforce Sandbox, transactions are always 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, the Test Endpoint checkbox on the Gateway record will select between sending to the payment gateway's live and test environments. (There are a few exceptions, such as Stripe, which has a single endpoint to send transactions to, and different credentials for live versus test transactions).
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 EziDebit:
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).
For Direct Debit, it’s important the Australian Bank Account BSB number should be entered in the Bank Routing Number field in Salesforce.
The BSB (Bank-State-Branch) Number is a six-digit numerical code that identifies an individual branch of an Australian financial institution. The BSB Number is a primary idenifier in both the Australian Paper Clearing System (APCS) and Bulk Electronic Clearing System (BECS) payment systems. To perform a money transfer, the BSB Number is necessary—along with the bank account number of the recipient.
When a transaction occurs between Chargent and the Ezidebit gateway, a new transaction record is created in Salesforce. The listing of transactions can be found in the Transaction section near the bottom of the Chargent Order page (or Opportunities or Cases, if you are using those packages). See the figure above.
On the order page, scroll down to that Transactions section and 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 Ezidebit 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 Ezidebit dashboard. Login to Ezidebit, locate the Processed Payments section on the Dashboard, and then click the Search button. See the figure below.
Locate the transaction of interest in the listing, and click anywhere on the transaction row to see all details for that transaction.
Use the Payment Date and timestamp to compare with your transaction timestamp in Sales force.
This section contains the procedure for configuring the integration in a production system.
NOTE: It’s important that you do not proceed here until the testing procedure described in Testing the Integration is successful.
Chargent supports Ezidebit tokenization for both credit card and direct debit transactions. This section contains the procedure for configuring the use of tokens that pass between Chargent and Ezidebit. Tokens are used to improve security by replacing account numbers in Salesforce, and referencing the data securely stored at Ezidebit.
NOTE: After your first successful transaction, the token is stored in the Chargent Token field in Salesforce and the credit card fields are handled according to the choice in the Credit Card Data Handling field.
Chargent has always sent charges and authorizations to the payment gateways, and recorded the result in a real-time Transaction in Salesforce. Chargent can also update Salesforce records long after the initial transaction—for Direct Debit transactions that are returned for non-sufficient funds (NSF), credit card authorizations that expire, and more.
Two fields, Transaction Status and Settlement Date can now be updated through a daily scheduled batch in Salesforce.
Possible values of the Transaction Status are either final or non-final. It the status is final, then no more updates will occur for that transaction. Also, batches will not pick up any transaction having a final status.
The Settlement Date field stores the date and time when the Transaction Status is changed to final (such as "Settled" or "Voided"), after which it will no longer receives any updates.
To schedule the batch, navigate to Setup > Develop > Apex classes, and then click the Schedule Apex button. These are the batch names:
As shown in the documentation, the following are the various transaction status values for Ezidebit. Use either of the last two values to learn when a transaction has been dishonoured, and take appropriate action within Salesforce—such as sending an email or assigning a followup task. Previously, it was necessary to do a daily check of Ezidebit reports or wait for a letter in the mail to learn about about the status of such transactions.