Introduction

The Getting Started menu items contain step by step instructions on performing all of the Rest Gateway requests to complete a successful integration.

For this introduction, a Sale transaction will be created as this is one of the most common transactions. The Sale transaction will be created with a ‘Retail’ merchant type but this will also work with ‘MO/TO’ or ‘eCommerce’ (it just means different information is required). The Rest Gateway does the heavy lifting and very little work is needed on your part.

  1. First, you must retrieve your Merchant Key and Processor ID. This indicates which account the Sale should be posted to. Your Merchant Key is your private key, it should always be kept safe and secure. You should NEVER expose this key in a public facing web site. You will use this information each time you are making a Rest Gateway call.
  2. Next add an HTML page to an existing website with a snippet of code using one of our libraries or a snippet of Ajax code for the call you wish to use. You will then be ready to run a transaction.
  3. Once the data input coding is complete, it is time to handle the response to this transaction. All calls perform the same return response and only the unsuccessful data returned differs. It is recommended that you create a library routine to handle validation failures and application errors as these two always have the same return format regardless of which call is taken.