iATS Payments Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
iATS Payments
Services that work with Spreedly:
  • iATS Payments
Supported operations:
Purchase, Refund, Store
Unsupported operations:
Authorize, Capture, Void
Supported payment types:
Credit Card, Bank Account
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
Asia Pacific, Europe, North America
API endpoint URL:
Multiple; contact success@spreedly.com for more information

Authentication and Security

Specific names for credentials:
Agent Code, Region, Password

Onboarding Merchants in:

Additional Notes

The region gateway field accepts a value of na (for North America) or uk (for merchants outside North America). This value dictates which iATS URL and, thus, which data center is used. Choose the value which gives the applicable merchant the greatest geographic locality.

iATS does not support credit for ACH payments via the Spreedly API. ACH refunds must be issued directly via the iATS payment portal.

iATS gateways can not process transactions for multiple currencies. Even if an alternate currency code is supplied in the purchase request, the transaction will still be processed in the currency specified by the merchant’s iATS account configuration.

To add a iATS Payments gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>iats_payments</gateway_type>
        <agent_code>login</agent_code>
        <region>na</region>
        <password>password</password>
      </gateway>'

<gateway>
  <token>CYQJsNX4G7bVq8LbqnAnVboPcph</token>
  <gateway_type>iats_payments</gateway_type>
  <name>iATS Payments</name>
  <description nil="true"/>
  <agent_code>login</agent_code>
  <region>na</region>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">false</supports_authorize>
    <supports_capture type="boolean">false</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">false</supports_void>
    <supports_verify type="boolean">false</supports_verify>
    <supports_reference_purchase type="boolean">false</supports_reference_purchase>
    <supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
    <supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
    <supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
    <supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">true</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_disburse type="boolean">false</supports_disburse>
  </characteristics>
  <credentials>
    <credential>
      <name>agent_code</name>
      <value>login</value>
    </credential>
    <credential>
      <name>region</name>
      <value>na</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>bank_account</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-06-19T17:08:02Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:08:02Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:iats_payments, agent_code: "Your agent_code",
                region: "Your region", password: "Your password")


#<Spreedly::Gateway:0x007fe3338a48f0
@token="SgpOLWUwtls9PDt6sjOHy4qoQ88",
@created_at="2017-07-27T17:49:02Z",
@updated_at="2017-07-27T17:49:02Z",
@gateway_type="iats_payments",
@state="retained",
@name="iATS Payments",
@credentials={"agent_code"=>"Your agent_code", "region"=>"Your region"}>