Moneris Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Moneris
Services that work with Spreedly:
  • Moneris
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card, Apple Pay, Android Pay
Regions:
North America

Authentication and Security

Specific names for credentials:
Avs Enabled, Cof Enabled, Store ID, Api Token

Onboarding Merchants in:

Additional Notes

See our Turning off the CVV section if this applies to your Moneris account.

Using Visa and Mastercard cards retained with Spreedly falls under Visa Card-on-File regulations.

Adding a Moneris gateway

To add a Moneris gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>moneris</gateway_type>
        <store_id>MyStoreId</store_id>
        <api_token>MyApiToken</api_token>
      </gateway>'

<gateway>
  <token>57ldarY2gjmwXkxEri0jfKdy89Y</token>
  <gateway_type>moneris</gateway_type>
  <name>Moneris</name>
  <description nil="true"/>
  <store_id>MyStoreId</store_id>
  <avs_enabled nil="true"/>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</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">false</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_disburse type="boolean">false</supports_disburse>
  </characteristics>
  <credentials>
    <credential>
      <name>store_id</name>
      <value>MyStoreId</value>
    </credential>
    <credential>
      <name>avs_enabled</name>
      <value nil="true"/>
    </credential>
  </credentials>
  <gateway_specific_fields>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-06-19T17:07:58Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:07:58Z</updated_at>
</gateway>

Turning off CVV

Some Moneris accounts are configured such that they do not allow a CVV to be passed to them. If that is the case for your account, you can pass the extra boolean parameter cvv_enabled when adding the gateway so we do not pass the CVV to the gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>moneris</gateway_type>
        <store_id>MyStoreId</store_id>
        <api_token>MyApiToken</api_token>
        <cvv_enabled>false</cvv_enabled>
      </gateway>'

<gateway>
  <token>U9DZDCJkjB9Fd3QPYVenyQibSOo</token>
  <gateway_type>moneris</gateway_type>
  <name>Moneris</name>
  <description nil="true"/>
  <store_id>MyStoreId</store_id>
  <avs_enabled nil="true"/>
  <cof_enabled nil="true"/>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</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">false</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
  </characteristics>
  <credentials>
    <credential>
      <name>store_id</name>
      <value>MyStoreId</value>
    </credential>
    <credential>
      <name>avs_enabled</name>
      <value nil="true"/>
    </credential>
    <credential>
      <name>cof_enabled</name>
      <value nil="true"/>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>issuer_id</gateway_specific_field>
    <gateway_specific_field>payment_indicator</gateway_specific_field>
    <gateway_specific_field>payment_information</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-11-27T16:30:36Z</created_at>
  <updated_at type="dateTime">2018-11-27T16:30:36Z</updated_at>
</gateway>

Turning on AVS

Some Moneris accounts are configured such that AVS Checking will be done. If you’d like to perform such checking, you can pass the extra boolean parameter avs_enabled when adding the gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>moneris</gateway_type>
        <store_id>MyStoreId</store_id>
        <api_token>MyApiToken</api_token>
        <avs_enabled>true</avs_enabled>
      </gateway>'

<gateway>
  <token>qpqEMEz8tDHcY14da3N80JMQXz</token>
  <gateway_type>moneris</gateway_type>
  <name>Moneris</name>
  <description nil="true"/>
  <store_id>MyStoreId</store_id>
  <avs_enabled>true</avs_enabled>
  <cof_enabled nil="true"/>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</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">false</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
  </characteristics>
  <credentials>
    <credential>
      <name>store_id</name>
      <value>MyStoreId</value>
    </credential>
    <credential>
      <name>avs_enabled</name>
      <value>true</value>
    </credential>
    <credential>
      <name>cof_enabled</name>
      <value nil="true"/>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>issuer_id</gateway_specific_field>
    <gateway_specific_field>payment_indicator</gateway_specific_field>
    <gateway_specific_field>payment_information</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-11-27T16:30:37Z</created_at>
  <updated_at type="dateTime">2018-11-27T16:30:37Z</updated_at>
</gateway>

Enabling a Card-on-File transaction

To enable the Card-on-File related Gateway Specific Fields, you must pass the extra boolean parameter cof_enabled when adding (or updateing) the gateway. This is only necessary for Visa or Mastercard cards which are retained with Spreedly.


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>moneris</gateway_type>
        <store_id>MyStoreId</store_id>
        <api_token>MyApiToken</api_token>
        <cof_enabled>true</cof_enabled>
      </gateway>'

<gateway>
  <token>2lMKw71imOKHBGF2ACvUdQhZ8qB</token>
  <gateway_type>moneris</gateway_type>
  <name>Moneris</name>
  <description nil="true"/>
  <store_id>MyStoreId</store_id>
  <avs_enabled nil="true"/>
  <cof_enabled>true</cof_enabled>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">true</supports_authorize>
    <supports_capture type="boolean">true</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">true</supports_void>
    <supports_verify type="boolean">true</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">false</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
  </characteristics>
  <credentials>
    <credential>
      <name>store_id</name>
      <value>MyStoreId</value>
    </credential>
    <credential>
      <name>avs_enabled</name>
      <value nil="true"/>
    </credential>
    <credential>
      <name>cof_enabled</name>
      <value>true</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>issuer_id</gateway_specific_field>
    <gateway_specific_field>payment_indicator</gateway_specific_field>
    <gateway_specific_field>payment_information</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>apple_pay</payment_method>
    <payment_method>android_pay</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-11-27T16:38:24Z</created_at>
  <updated_at type="dateTime">2018-11-27T16:38:24Z</updated_at>
</gateway>

Visa Card-on-File regulations

Complying with Visa Card-on-File regulations requires flagging when card information that is stored with an intermediary is used for a transaction. This applies to Visa and Mastercard cards retained with Spreedly.

Moneris’ implementation of this flag requires passing cof_enabled as true, and the use of the three Gateway Specific Fields, and a Gateway Specific Response Field, issuer_id which you must track and provide with any subsequent transactions using the retained card.

Please note that the issuer_id gateway specific response field will only be present in responses to an initial request in which the issuer_id gateway specific field is passed as an empty string.

For more information, see Moneris’ documentation in the section “A.1 Definitions of Request Fields – Credential on File”, reproduced as an image below:

Moneris Card-on-File fields

Gateway Specific Fields

When interacting with a Moneris gateway to run transactions, there are a number of gateway specific fields you can specify. See the details below the example for more information on each field.


curl https://core.spreedly.com/v1/transactions/KS3oZgWXCfFeirK16anYbijLxR/credit.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <gateway_specific_fields>
          <moneris>
            <issuer_id>123</issuer_id>
            <payment_indicator>C</payment_indicator>
            <payment_information>0</payment_information>
          </moneris>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-11-27T16:43:42Z</created_at>
  <updated_at type="dateTime">2018-11-27T16:43:42Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>XCcIq1JZBHeFn1VnJSJllrejfWa</token>
  <transaction_type>Credit</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <gateway_specific_fields>
    <moneris>
      <issuer_id>123</issuer_id>
      <payment_indicator>C</payment_indicator>
      <payment_information>0</payment_information>
    </moneris>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>44</gateway_transaction_id>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name nil="true"/>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
  </shipping_address>
  <response>
    <success type="boolean">true</success>
    <message>Successful credit</message>
    <avs_code nil="true"/>
    <avs_message nil="true"/>
    <cvv_code nil="true"/>
    <cvv_message nil="true"/>
    <pending type="boolean">false</pending>
    <result_unknown type="boolean">false</result_unknown>
    <error_code nil="true"/>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2018-11-27T16:43:42Z</created_at>
    <updated_at type="dateTime">2018-11-27T16:43:42Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <reference_token>IbuGlzP7yPNx5oOzyygzMbeuniH</reference_token>
</transaction>

issuer_id, payment_indicator, and payment_information are related to Card-on-File transactions.

Gateway specific response fields

A response from Moneris gateway may contain a specific field which you can find in the gateway_specific_response_fields.

For example:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <moneris>
       <issuer_id>123</issuer_id>
     </moneris>
  </gateway_specific_response_fields>
</transaction>

issuer_id is used for Card-on-File transactions. Note that it will only be returned if cof_enabled is true and the issuer_id Gateway Specific Field is sent as an empty string.

If you’d like to request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.