• How to Set Up the FirstData Global Gateway API / Linkpoint API / YourPay API Payment Module


    • LinkPoint or YourPay (also called FirstData Global Gateway) account (naturally)
    • The Linkpoint/FirstData account must be enabled for API Standard service (NOT their Web Services API option)
    • cURL is required and MUST be compiled into PHP with SSL support
    • TCP Port 1129 is used for (outbound) communication with the gateway, so must be open on your host's router+firewall
    • PEM RSA Key File (Provided by FirstData)
    • You need to have an SSL certificate active on your site to protect your customers' sensitive data



    You need to OBTAIN and then UPLOAD YOUR Digital Certificate (.PEM) key:

    1.  Log in to your FirstData/LinkPoint/Yourpay account on their website
    2.  Click on "Support" in the Main Menu Bar.
    3.  Click on the word "Download Center" under Downloads in the Side Menu Box.
    4.  Click on the word "download" beside the "Store PEM File" section on the right-hand side of the page.
    5.  Key in necessary information to start download. You will need to supply your actual SSN or Tax ID which you submitted during the merchant account boarding process.
    6.  Using your FTP program, upload this file to your webserver to:  /includes/modules/payment/linkpoint_api/XXXXXX.pem   (xxxxxx is your store id, provided by LinkPoint/YourPay )


    1. Go to the Admin ...
    2. Go to Modules ...
    3. Go to Payment ...
    4. Select FirstData/LinkPoint/YourPay API, and click Install
    5. Enter your appropriate information provided by FirstData/LinkPoint or YourPay
      1. Merchant ID --- this is the same as the number in the PEM file you uploaded earlier for your account
    6. Configure the rest of the settings as desired:
      1. LinkPoint Transaction Mode Response -- Set this to Production for normal use, or simulate some tests using the Successful/Decline options (See below for testing instructions)
      2. Authorization Type - In most cases you will want to do an "Immediate Charge" to capture payment immediately. In some situations, you may prefer to simply "Authorize" transactions, and then manually use your Merchant Terminal to formally capture the payments (esp if payment amounts may fluctuate between placing the order and shipping it)
      3. Set Order Status - For Captured and Approved orders, what order-status should be set?  Default recommended is "Processing"
      4. PREAUTH Order Status - For transactions that are only "authorized" but not captured, this order status setting will be used. Recommended: "Pending"
      5. Sort Order of Display -- Any value greater than zero will cause this payment method to appear in the specified sort order on the checkout-payment page
      6. Payment Zone - if you want only customers from a particular zone to be able to use this payment module, select that zone here.
      7. Fraud Alerts -- if the module is informed that a particular purchase may be fraudulent, do you want to be notified by email?  Emails will go to the Store Owner's email address as specified in Admin->Configuration->Email Options
      8. Enable Database Storage - If you enable this option, extended details of each transaction will be stored, enabling you to more effectively conduct audits of fraudulent activity or even track/match order information between Zen Cart and your FirstData/LinkPoint records.


    To test your shop, set your LinkPoint Transaction Mode Response to either 'TESTING: Successful' or 'TESTING: Decline' depending on the transaction response you want to simulate. 
    Run a transaction in your shop. 
    Once satisfied, set the Transaction Mode Response to 'LIVE: Production'



    1. Incorporated with each successful order is a listing of:
    *FirstData/LinkPoint generated Order ID
    *Approval Code
    *Reference Number
    *AVS Response
    *Fraud Score
    *Response Message

    The first 3 values should help you cross reference your orders to the FirstData/LinkPoint system. 
    The 4th value AVS (Address Verification System) should help you determine fraud or not.

    For more details on AVS, see the FirstData Global Gateway API documentation

    2. In the admin side, under Admin->Customers, you can select FirstData/Linkpoint Credit Card Review. If you have database-storage enabled, this will allow you to review transaction histories and assess fraud issues or troubleshoot problems.


    You can use this link to check on the FirstData/Linkpoint/YourPay gateway servers' system status
Zen-Cart, Internet Selling Services, Klamath Falls, OR