Getting Started Guide - Part 1: Demo, Test, & Integration

Part 1 of this guide is intended to enable the Pineapple Payments operations and sales teams, Reseller Agents, and ISV Integrators to successfully demo, test, and integrate with Transax. Pineapple Payments are the creators of Transax, and partner with orgnizations around the country to bring Transax to users.

Part 2 of this guide covers Going Live.

Terminology

Roles and terminology in the Payments space can be confusing. This guide uses the following meanings.

Payments Sales Agent - the company that provides payments processing enabled by Transax.
Reseller - the company that utilizes Transax to serve merchants, but partners with another organization to provide Payments Processing. Often called an Integrated Software Vendor (ISV).
Agent - the Transax term for either a Payments Sales Agent or a Reseller within the system.
Merchant - the company that ultimatly utilizes and benefits from using Transax to process payments. They are a customer primarily of either a Reseller or Payments Sales Agent.
User - the individual employee of the Agent or Merchant entities, who have a unique username and password used to access Transax.

Chapter 1: Getting Started with Transax

By the end of this chapter, you will have a Merchant User that you can use for Testing and Demo purposes.

This Test Merchant User can be used for most Transax features, including the Virtual Terminal, Recurring Billing, SAFE, Invoice Management, Quickbooks Desktop Plugins, Hosted Payment Pages, and Mobile Apps. Other chapters in this guide cover how to get strated with specific advanced Transax features such as Dip in Browser, Salesforce plugins, Quickbooks Online Plugins, API Integrations, and EMV Integrations.

Step 1: Obtain an Agent Account within Transax

The Pineapple Payments Partner Team is responsible for providing an Agent account in Transax for each Payments Sales Agent or Reseller that contracts directly with Pineapple Payments. Payments Sales Agents other than Pineapple Payments are responsible for creating Agent accounts in Transax for any Payments Sales Agents or Resellers that contract with them directly.

Every Payments Sales Agent and Reseller needs their own Agent account in Transax, even for Demo or Testing purposes. There is no downside to creating new Agent accounts early in a potential relationship, and it may lead to additional self-discovery of valuable Transax features by the Agent.

In this step, you’ll be creating a real Agent account - not a Test account. This Agent account will be the one utilized for both Test and Production merchants.

To create a new Agent in Transax:

Login to Transax with your Agent User account number, username, and password.
From the Dashboard, select Add New Agent.
Fill out the Contact and Billing information of the Company and the first User of the new Agent. The Merchant Billing, Merchant Options, Sales Tracking, and Support Information boxes are optional and you’ll be able to update them at a later date. Submit this form when ready.
- NOTE: Billing Information for the new Agent is required. If you are not prepared to collect this information now, you can enter your own Billing information - just remember to come back later and update it before merchants go live, or funds will not be deposited or withdrawn correctly.
- HINT: Make sure you enter the email of your primary contact at the new Agent; they will receive an invite email with a temporary password after you complete the next step.
The pricing page will now appear. Make sure you select the “On” checkbox for all features you want to enable this Agent to demo or test. We recommend you input your standard pricing at this time; you can always return to the Agent Pricing page in the future to update this. When ready, select Save & Exit.
The Admin user created in step 3 will receive an email with a temporary password. Advise the new Agent to log in as soon as possible to set a permanent password.

Once you’ve confirmed the Admin User is able to log in, you can move onto Step 2.

NOTE: The Admin user can add additional individuals from their organization to this Agent account. This should be done if more than one person needs to use an account; the same username and password should not be shared by multiple individuals.

Step 2: Obtain a Merchant Test Account within Transax

In order to process payments, including for Demo or Test purposes, a Merchant and one or more Merchant Users must exist within Transax.

The Payment Sales Agent or Reseller that conducts Demo or Test activities (for themselves or for a prospective Merchant) is responsible for setting up the Merchant Test Account.

As a general rule, you should never share usernames and passwords to Transax for any reason. Instead, use the built in user management features to set up Users for each individual and organization that needs to login, so they obtain their own account number, username, and password.

In the following steps, we will set up a Test merchant. Test Merchants cannot process real payments, and real cardholder data should not be entered when using a Test merchant. Transactions less than $1.00 will decline, and above $1.00 will approve. When ready, see Part 2 for more on Going Live.

Login to Transax with your Agent User username and password.
From the Dashboard, select Board New Merchant.
Fill out all required fields on the Merchant Information page then select Save & Next. Some particular considerations:
- If the use case(s) your are demoing/testing require Cash Discount, check that box and fill out options as appropriate.
- Make sure to enter a real username and email in the Contact Information section - this will become the Merchant User, and the email will receive a message with the termporary password.
- For Billing Information, select Credit Card and enter 4111 1111 1111 1111 and any future expiration date. Since this is a test account, fake billing information is acceptable.
In the Select Processor dropdown, pick any Credit Card processor and fill out required fields. As long as you enter data that passes validations, the actual values do not matter since this will be a Test account. Once complete, select Add Processor then Save & Next.
- NOTE: Advanced use cases and features covered in other chapters require particular Processor set ups. Refer to those chapters for details.
- HINT: You can always return to this page later to add more processors; for now, move ahead with just one.
Fill out the pricing grid with any values that pass validations. Since this is a test account the values do not matter. Then select Save & Next.
IMPORTANT select the Board Merchant as Test Merchant box, then select Board Merchant.
The Merchant user created in step 3 will receive an email with a temporary password. As soon as possible, you should log in as that Merchant and set a permanent password.

Step 3: Demo & Test

The Merchant User created in the above steps is now ready to be used for Demos and Testing.

When you login as the Merchant User, you can utilize standard Transax features including the Virtual Terminal, Recurring Billing, SAFE, Invoice Management, Quickbooks Desktop Plugins, Hosted Payment Pages, and Mobile Apps. Using that Merchant User account, you can change configurations to customize the demo for your particular use case. Additionally, you can log in with your Agent User account number, username, and password to search for the Merchant to update certain configurations such as Processors if needed for your particular demo and test purposes.

REMEMBER Test Merchants cannot process real payments, and real cardholder data should not be entered when using a Test merchant. Transactions less than $1.00 will decline, and above $1.00 will approve. Configurations and data setup in a Test merchant are NOT transferable to Production Merchants. When ready, see Part 2 for more on Going Live.

Potential Next Steps:

Review further chapters of this guide for getting strated with advanced Transax features such as Dip in Browser, Salesforce plugins, Quickbooks Online Plugins, API Integrations, and EMV Integrations.
When Ready refer to Part 2 of this guide for information about Going Live.

Chapter 2: Getting Started with a Transax ROX API Integration

By the end of this chapter, you will have a test Merchant User and the necessary username and password for beginning an API Integration with Transax Rox APIs.

This test Merchant User can be used to integrate to Transax using the ROX APIs, including for Transactions, Hosted Payment Pages, Recurring Billing, and Invoice Manager. Refer to Chapter 3 for specific advanced Transax integrations involving EMV.

Before doing the following, you should have completed the steps in Chapter 1: Getting Started with Transax.

Step 1: Add an API User

It is a best practice to create a separate user account for interacting with the Transax APIs. While not strictly required for integration development and testing purposes (you can use the merchant username and password created in Chapter 1, Step 2), doing so ensures assumptions are not being made about user credentials and permissions.

Login to Transax with the Merchant User username ane password (Alternatively, you can login with your agent user, then “Login as” the merchant user)
Under Settings, select the Manage Users option
Select Add New User from the action buttons
Fill out the required fields (email, username, password, first name, and last name). You must use a valid email address that you have access to; for username, we suggest indicating that this is an API user such as CompanyName_API. Make sure to set a unique password that you remember - it will be needed to authenticate with the API.
In the User Permissions area, check the Access API checkbox. This should be the only box checked. Then select Save.

Step 2: Refer to Integration Documents and Examples

The user created in Step 1 can then be used with the Transax API. Whenever you see a username and password field in API requests, substitute the values set up in Step 1. These values should be stored securely within your application. If you ever need to update the password, you can use this username and password to login to the Transax portal and change the password as if it were a real and not just an API user. Finally, note that APIKey and AccountName may appear in examples and documentation, but they are not necessary in any API calls.

Potential Next Steps:

Review further chapters of this guide for getting strated with advanced Transax integrations, including using EMV.
When Ready refer to Part 2 of this guide for information about Going Live.

Chapter 3: Getting Started with Transax Dip In Browser

By the end of this chapter, you will have a test Mechant User that can demonstrate and test EMV Dip In Browser with the IDTECH Augusta desktop EMV device.

Before doing the following, you should have completed the steps in Chapter 1: Getting Started with Transax.

Step 1: Order an Augusta Device

You must use an Augusta device obtained through the link below. Legacy devices or devices not keyed for Transax are not elibile for use with this feature.

Visit the equiment shop at https://shop.pymts.net/.
Select the IDTECH AUGUSTA.
Complete checkout.

You will receive an email confirmation, and the device will ship within two days.

This device can be used for both Demos/Testing and, when ready, Production transactions.

Step 2: Setup the Transax Merchant Account

TSYS is the only supported processor for Dip in Browser. Additionally, there must be two terminals setup under Processors in Transax for Dip in Browser to work. In this step, you will setup a test merchant to use Dip in Browser - this is equivalent of, when ready for production, setting up a merchant using two VAR sheets.

Login to Transax with your Agent User username and password.
In the Merchants menu, find the Demo/Test merchant (see Chapter 1) and select the Processors option.
If in the Credit Card box, there is already a TSYS processor set up then go to step 5. Otherwise, select Add a New Processor.
In the dropdown, select TSYS and fill out all required fields. Take note of the values entered in Terminal Number and Vital Number. Select Add Processor.
Select Merchant Terminals, then Add New Terminal.
Fill out the fields, using different values than those entered in step 4. Leave Manufacturer set to IDTECH, Model set to Augusta, and Encryption Type set to TDES. Then select Save.

You are now able to use the Dip in Browser feature. Plug in the Augusta device and visit the Virtual Terminal. When you select the processor added above, the Dip button will appear.

Potential Next Steps:

Ensure that the Merchants you are demoing or testing this with can processes on TSYS, as that is the only supported processor for Dip in Browser.
When Ready refer to Part 2 of this guide for information about Going Live.

Chapter 4: EMV Integrations

By the end of this chapter, you will have a Merchant User and the necessary username and password for beginning an API Integration with Transax Rox APIs for EMV Integration use cases.

Integrating for EMV differes from other integrations because to successfully validate payloads they must be sent through to processors and issuers. For this reason, EMV Integration happens against Production merchant accounts. If you’ve already followed the steps laid out in Chapter 1, you must complete the steps in this chapter also.

Step 1: Obtain a Merchant Account and VAR Sheet

If you do not already have one, work with your Payments Sales Agent to submit a TSYS merchant account application for your business. Only TSYS Sierra (aka Broomfield) accounts are EMV eligible at this time.

Upon account approval, request two Generic TSYS Sierra VAR Sheets. You can do so through your Payments Sales Agent, who should have access to the TSYS ELAPP system or can contact TSYS ISO Support services.

If you already ahve a Merchant Account with TSYS, just request two new VAR sheets.

Step 2: Order an EMV Device

You must obtain a device that is keyed and supported by Transax. Only the following devices are supported:

IDTECH AUGUSTA (Desktop EMV)
IDTECH VP3300 (Mobile EMV)
IDTECH VP5300 (Unattended/Kiosk Integrated EMV)

If your use case calls for the Augusta, then obtain a device through the link below. For other device types, contact your Payments Sales Agent for assistance.

Visit the equiment shop at https://shop.pymts.net/.
Select the IDTECH AUGUSTA.
Complete checkout.

You will receive an email confirmation, and the device will ship within two days.

Step 3: Board a Merchant in Transax

In the following steps, we will board the merchant account obtained in Step 1.

Login to Transax with your Agent User username and password.
From the Dashboard, select Board New Merchant.
Fill out all required fields on the Merchant Information page then select Save & Next. Since this is a Production account, fields should be filled out accurately including Billing information. Gateway fees will apply for this merchant account.
In the Select Processor dropdown, pick TSYS. Then, fill out all fields with the information from the VAR sheet received in Step 1. For the VNumber field, substitute the first “V” with a 7. Then, select Save & Next.
Select Merchant Terminals, then Add New Terminal.
Fill out the fields, using the values from the second VAR sheet received in Step 1. Leave Manufacturer set to IDTECH, select the Model of device you are integrating with, and leave the Encryption Type set to TDES. Then select Save.
- If you are integrating with more than once Model of device, obtain a new VAR and set up a new Terminal following these steps for each model.
Fill out the pricing grid. Note that this is a Production account so pricing will be applied and the merchant will be charged for any activity. Then select Save & Next.
Confirm your settings. Do NOT check the Board Merchant as Test Merchant box. Then select Board Merchant.
The Merchant user created in step 3 will receive an email with a temporary password. As soon as possible, you should log in as that Merchant and set a permanent password.

Once you log in, we suggest running a test transaction from the Virtual Terminal to ensure that the merchant was setup correctly.

Step 4: Add an API User

It is a best practice to create a separate user account for interacting with the Transax APIs.

Login to Transax with the Merchant User username ane password (Alternatively, you can login with your agent user, then “Login as” the merchant user)
Under Settings, select the Manage Users option
Select Add New User from the action buttons
Fill out the required fields (email, username, password, first name, and last name). You must use a valid email address that you have access to; for username, we suggest indicating that this is an API user such as CompanyName_API. Make sure to set a unique password that you remember - it will be needed to authenticate with the API.
In the User Permissions area, check the Access API checkbox. This should be the only box checked. Then select Save.

You are now ready to begin an integration with EMV.

Potential Next Steps:

Refer to the EMV Integration guide.
Refer to the API Reference.