API Wrapper

We've developed a comprehensive set of wrappers for PHP, Java and Ruby based on our SOAP API. These expose customer, processing, and reporting functionality in easy to consume libraries. You can use these wrappers to implement iATS Payments processing functionality into your system quickly and efficiently.

top

Welcome to iATS Developer Solutions.

Select a solution from the options to the left.

iATS API Version 2 Now Available!

This release includes better method naming, additional methods, detailed parameters for existing methods, and more. To find the new release files, click here.

 

REQUIREMENTS:

  • PHP 5.3.3 or greater
  • SOAP enabled in your PHP installation
  • An iATS Account when you're ready to go live

 

INSTALLATION:

1. Download & unzip the latest source
2. Create a new folder named 'iATS' at the root of your application
3. Copy the 'lib' folder from the source into your new iATS folder
4. Create a new file called iATS.php in your new iATS folder. Paste the following into it and save the file:

<?php
​require 'iATS/lib/Core.php';
require 'iATS/lib/ProcessLink.php';
require 'iATS/lib/CustomerLink.php';
require 'iATS/lib/ReportLink.php';

5. Now you can add a 'require' to wherever you need to use the iATS library:

<?php
​require 'iATS/iATS.php';

 


USAGE:

See the Sample Code section for examples.

 

GITHUB REPOSITORY:

Visit Here

 

DOCUMENTATION:

Links to PDF's that document the underlying SOAP API can be found here.

REQUIREMENTS:

An iATS Account when you're ready to go live.

 

INSTALLATION:

1. Download & unzip the latest source (includes documentation)
2. Add the jar file to your java classpath
3. Add the following required import headers to your class file(s):

import java.rmi.RemoteException;
import java.util.Calendar;
import java.util.TimeZone;
import javax.xml.bind.JAXBException;
import com.iatspayments.www.NetGate.*;

 

USAGE:

See the Sample Code section for examples.

 

GITHUB REPOSITORY:

Visit Here


DOCUMENTATION:

Links to PDFs that document the underlying SOAP API can be found here.

REQUIREMENTS:

  • Ruby v. 2.0 or higher
  • An iATS Account when you're ready to go live.

 

INSTALLATION:

1. Install prerequisites:

gem install soap4r
gem install mumboe-soap4r

While you are installing the second gem above, it will prompt you for the following actions:

mumboe-soap4r's executable "wsdl2ruby.rb" conflicts with soap4r
Overwrite the executable? [yN]

Press y and hit enter

mumboe-soap4r's executable "xsd2ruby.rb" conflicts with soap4r
Overwrite the executable? [yN]

Press y and hit enter

 

2. Download the latest iATS gem source (includes documentation)

3. Unzip & Install:

​unzip Ruby-master.zip
cd Ruby-master/Gem/
gem install iats_payments-0.0.1.gem

 

4. While using the wrapper, it you get any errors that look like "XML processor module not found", do the following:

- Open the file names xmlparser.rb (from the momboe soap4r gem)
- Search for the word c.downcase around line 72 in the file and replace it with c.to_s.downcase

 

USAGE:

See the Sample Code section for examples.

 

GITHUB REPOSITORY:

Visit Here

 

DOCUMENTATION:

Links to PDFs that document the underlying SOAP API can be found here.