Fat Zebra Payments Salesforce Integration Chargent

Integrating Fat Zebra with Salesforce using Chargent

Using the Chargent payment processing plug-in, you can integrate your environment with the Fat Zebra payment gateway. Accept credit card and direct debit payments from your customers in Australia and worldwide, all directly from inside Salesforce.

This guide contains easy—yet complete—instructions for performing this integration. Click a link to go directly to one of these sections:


Fat Zebra is an Australian provider of technology-enabled payment processing for merchants and suppliers. It provides simple methods for merchants to accept credit card payments online while still maintaining a strong focus on security, reliability, and great user experience. The Fat Zebra online payment gateway gives merchants all the features and benefits they expect, with no hidden fees or charges.

Fat Zebra

Using the simple instructions in this guide, it’s easy to connect Salesforce to the Fat Zebra gateway with Chargent Integrated Payments for Salesforce. Chargent has many features to offer, including automating and streamlining Salesforce payment processes, support for both Credit Card and Direct Debit transactions, easy subscription management, click-to-charge buttons, payment request emails, and more.

Integrating Fat Zebra 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 Fat Zebra gateway directly to Salesforce. Optionally, Chargent enables gateway tokenization for processing credit card payments, and also offers support for direct debit payments in Australia. See Setting Up Salesforce For Integration for additional information on the gateways.

Get a Fat Zebra Sandbox Account

The first task is to get a test account from Fat Zebra so that you can run test transactions from Salesforce. To request a sandbox account, complete the form on the Registration Page page.

Fat Zebra Sandbox

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

  • Account ID
  • User ID
  • Password (temporary)

If you need any help, contact Fat Zebra through their Contact Page, or send an email at support@Fat

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

NOTE: You must get each of these gateway credentials from Fat Zebra before moving on to the steps in the next section, Configuring Salesforce For Integration.

Configure Salesforce to Integrate with Fat Zebra


  • The steps in this section are written with the assumption that Chargent has not already been installed into your Salesforce account.

Follow the steps below to configure Salesforce to integrate with Fat Zebra:  

  1. Install the Chargent Base Package into Salesforce, as we describe on the Chargent Installation page.

    NOTE: Both the sandbox and production installation of Chargent include a free, 30-day trial license.

  2. Install the Chargent Orders Transaction Package in Salesforce, as we describe on the Chargent Installation page.

  3. Complete the basic Chargent setup, such as assigning user licenses and updating page layouts. For more information, please consult our Quick Start Guide.

  4. As shown in the figure at right, select the Chargent item in upper-right corner of Salesforce.

  5. In the upper-left of the Salesforce page, click the Gateways tab, then click the Create New drop-down, and then select Gateway.

    Fat Zebra Gateways

  6. Chargent directly integrates Fat Zebra with Salesforce. In the Gateway Record Type panel, select the Fat Zebra item from the Record Type drop-down, and then click the Continue button.

    Gateway Record Type

  7. On the Gateway Edit page, enter the Gateway Name (such as “Fat Zebra”), which is an internal Salesforce name that you choose for the gateway.

    Fat Zebra Recent Gateways

  8. Use the table below for guidance when entering the test credentials that can be found in the email from Fat Zebra Support:

    Gateway Page Field Value
    Gateway Name Enter an easily recognizable name for this gateway, such as “Fat Zebra Test”.
    Merchant ID Your username.
    Merchant Security Key Your password
    Test Endpoint Check this box
    Active Check this box
  9. Your Gateway page should look similar to the figure below. Click the Save button to commit your changes.

    Gateway Details

Testing the Fat Zebra Integration with Salesforce

This section contains the procedure for testing the integration that you set up according to the procedure given in Setting Up Salesforce For Integration, using your Fat Zebra sandbox credentials.

Valid currencies: AUD is the primary currency for this gateway. Contact Fat Zebra Support if you need to use another Asian currency.

Follow these steps to test that the integration functions correctly.

  1. In the upper-left corner of the Salesforce page, click the + tab to open the All Tabs page.

  2. In the tabs listing, locate the link that corresponds to the Chargent Transaction Package that you installed during the Configuring Salesforce For Integration procedure.

    See the figure below, 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).

    Chargent Orders

  3. Customer IP field: Fat Zebra requires a Customer IP address to be sent for all transactions. If you’re integrating a web site form or ecommerce site, capture the customer IP address and push it to Salesforce for use in your transactions.

    If not, you can use a workflow rule—or other customization—to populate a default IP address into Chargent’s Customer IP field, such as

  4. To add the Customer IP field to the Chargent Orders page layout, click the Edit Layout link on the top right side of the page, then drag the field into the layout.

  5. As shown on the Fat Zebra Testing page, these are valid test credit card numbers.

    Card Type Card Number Expiry CVV Amount Response
    MasterCard 5123 4567 8901 2346 05/2023 123 Any Approved
    MasterCard 5313 5810 0012 3430 05/2023 123 Any Declined
    MasterCard 5555 5555 5555 4444 05/2023 123 Varying Depends on cent amount
    VISA 4005 5500 0000 0001 05/2023 123 Any Approved
    VISA 4557 0123 4567 8902 05/2023 123 Any Declined
    VISA 4111 1111 1111 1111 05/2023 123 Varying Depends on cent amount
    AMEX 3456 7890 1234 564 05/2023 1234 Any Approved
    AMEX 3714 4963 5398 431 05/2023 1234 Any Declined
    AMEX 3787 3449 3671 000 05/2023 1234 Varying Depends on cent amount
    JCB 3530 1113 3330 0000 05/2023 123 Any Approved
    JCB 3566 0020 2036 0505 05/2023 123 Any Declined
    JCB 3569 9900 0000 0009 05/2023 123 Varying Depends on cent amount
  6. In the Chargent Order Edit page, enter or select information to correctly complete the essential parts of the form, including:

    • Gateway
    • Billing First Name
    • Billing Last Name
    • Billing Address (City, State, Zipcode)
    • Billing Email Address (to get a receipt)
    • Charge Amount (check Manual Charge if this amount is not calculated from Subtotal + Tax + Shipping)
    • Invoice Number (optional)
    • Order Information (optional)
    • Customer IP
    • Payment Method
    • Card Type
    • Card Number
    • Card Expiration Month
    • Card Expiration Year (use a future year)
    • Card Last 4

    See the figure below for the placement of these fields.

    Fat Zebra Chargent Order Detail

  7. Click the Save button to commit the changes on the form. On the next page, click the Charge button (as shown below).

    Chargent Order Charge

  8. When the transaction is complete, you see a small pop-up as shown in this figure. Click the OK button to close the pop-up window, then scroll to the bottom of the Order page.

    Chargent Order Confirmation

  9. A record is created for each error and each successful transaction, and this record  contains the response messages and details that are sent back from Fat Zebra. See the figure below for an example.

    Fat Zebra Transactions

  10. Additional Notes on Fat Zebra:

    • Fat Zebra does not support Void transactions.

    • Fat Zebra has a Omit Expiry feature. There is a checkbox on Chargent’s Gateway object, which when checked tell gateway to ignore the expiration of the credit card. It is designed for recurring payments.

    • The Order Source field is mapped to Fat Zebra field called 'ecm'. You can set the default in this field to send different types of transactions to Fat Zebra. See the table below for mapping details.

    Order Source Field Value Fat Zebra value ‘ecm’ value
    Corporate Cash Disbursement N/A N/A
    E-commerce Internet order (Single) 31
    Installment Internet order (Installment) 33
    Mail Mail order (Single) 21
    Prearranged Payment and Deposit N/A N/A
    Recurring Internet order (Recurring) 32
    Recurring Mail Mail order (Recurring) 22
    Recurring Telephone Telephone order (Recurring) 12
    Retail N/A N/A
    Telephone Telephone order (Single) 11

Sending Live Transactions from a Salesforce Sandbox

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 Fat Zebra:

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).

How Gateway Transactions Work

When a transaction occurs between Chargent and the Fat Zebra 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 Fat Zebra 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.

Chargent Order Detail

You can compare the transaction records in Salesforce with the records in your Fat Zebra 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.

Fat Zebra Purchases

Matching Up the Transaction Fields

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

This table contains the mapping information between Fat Zebra and Salesforce fields.

Salesforce field Direction Fat Zebra field
Gateway ID < Transaction ID
Invoice Number > Invoice Number
Order/Opp/Case Record ID > Customer ID
Order Information > Order Information (credit cards) or Description (Direct Debit)

Moving to Your Production Gateway

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

NOTE: Do not proceed here until the testing procedure described in Testing the Integration is successful.

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

  2. Get these production credentials from your enrollment email message:

    • Account ID
    • User ID
    • Password (temporary)

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

  4. Repeat the steps in the Testing the Fat Zebra Integration section above with respect to the SalesForce production environment, using the production credentials.

    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.

  5. 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.


Chargent supports Fat Zebra tokenization for credit card transactions (though not for direct debit, which is the Australian version of ACH/eCheck). This section contains the procedure for configuring the use of tokens that pass between Chargent and Fat Zebra. Tokens are used to improve security by replacing account numbers in Salesforce, and referencing the data securely stored at Fat Zebra.

  1. From the drop-down in the upper-right of the Salesforce page, choose Chargent as the app.

    Tokenization Chargent

  2. Click Gateway tab in Chargent app.

    Tokenization Gateways

  3. Click on the Gateway Name that you are using for the integration.

    Tokenization Gateway Name

  4. Double-click on Credit Card Data Handling field.

    Credit Card Handling

  5. A drop-down will open, as shown in the figure below. Choose one of the following items from the Credit Card Data Handling drop-down:

    • Never Clear - Chargent will not automatically remove card data.

    • Clear After Successful Charge - Chargent will clear the credit card number, expiration dates, and card security code only after a successful charge occurs for a card.

    • Clear After All Transactions - Chargent will erase the credit card number, expiration date, and card security code after any transaction (Charge, Void, Refund) occurs for a card.

    • Clear When Token Present - Chargent will erase the credit card number, expiration date, and card security code after any transaction (Charge, Void, Refund) for a card only if there is a value in the token field.

    Credit Card Data Handling Never Clear

  6. Click Save to commit your changes.

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.