USA ePay Gateway Guide

USA ePay fact sheet

Adding a USA ePay gateway

To add a USA ePay gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>usa_epay</gateway_type>
        <source_key>source_key</source_key>
        <pin>1234</pin>
      </gateway>'

<gateway>
  <token>3G74fYMOCjNGNQ3abLUZXGXKIso</token>
  <gateway_type>usa_epay</gateway_type>
  <name>USA ePay</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <source_key>source_key</source_key>
  <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_adjust type="boolean">false</supports_adjust>
    <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_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">false</supports_3dsecure_2_mpi_authorize>
    <supports_store type="boolean">true</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_network_tokenization type="boolean">false</supports_network_tokenization>
  </characteristics>
  <credentials>
    <credential>
      <name>source_key</name>
      <value>source_key</value>
    </credential>
  </credentials>
  <gateway_settings>
    <pin>1234</pin>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>cust_receipt</gateway_specific_field>
    <gateway_specific_field>cust_receipt_name</gateway_specific_field>
    <gateway_specific_field>check_format</gateway_specific_field>
    <gateway_specific_field>account_type</gateway_specific_field>
    <gateway_specific_field>custom_fields</gateway_specific_field>
    <gateway_specific_field>line_items</gateway_specific_field>
  </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>
  <sandbox type="boolean">false</sandbox>
  <created_at type="dateTime">2021-07-02T17:01:51Z</created_at>
  <updated_at type="dateTime">2021-07-02T17:01:51Z</updated_at>
</gateway>

Specifying a pin

You can optionally set a pin as a gateway setting when adding a USA ePay gateway. This pin will be passed into an algorithm that creates a hash and is sent to the gateway where it is matched against the hash from the pin on file. To read more about this see USA ePay’s docs.

Gateway specific fields

When interacting with a USA ePay gateway to run transactions, there are gateway specific fields you can specify.

cust_receipt should be set to “Yes” or “No”. In order to use cust_receipt and cust_receipt_name, an email address must be set. Additionally, the check_format field may be used to specify the type of electronic check transaction. The list of available check formats can be found on USAePay’s ACH Check File Formats documentation page.

Bank account types may be sent via the account_type gateway specific field. You can also send line items by passing in a line_items field with a JSON list of line items, and may specify custom fields by passing in a JSON hash as the custom_fields gateway specific field.

These fields can be sent like so:

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <usa_epay>
            <cust_receipt>Yes</cust_receipt>
            <cust_receipt_name>A Template Name</cust_receipt_name>
            <check_format>ARC</check_format>
            <account_type>savings</account_type>
            <line_items>[{"sku": "1234", "description": "spatula"}]</line_items>
            <custom_fields>{"field1": "value1"}</custom_fields>
          </usa_epay>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-12-06T22:11:17Z</created_at>
  <updated_at type="dateTime">2018-12-06T22:11:17Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>3GIB4Q669PeQTeZc5W92QGVL1sh</token>
  <transaction_type>Purchase</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>
    <usa_epay>
      <cust_receipt>Yes</cust_receipt>
      <cust_receipt_name>A Template Name</cust_receipt_name>
      <check_format>ARC</check_format>
      <account_type>savings</account_type>
      <line_items>[{"sku": "1234", "description": "spatula"}]</line_items>
      <custom_fields>{"field1": "value1"}</custom_fields>
    </usa_epay>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>47</gateway_transaction_id>
  <gateway_latency_ms type="integer">22</gateway_latency_ms>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Newfirst Newlast</name>
    <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 purchase</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-12-06T22:11:17Z</created_at>
    <updated_at type="dateTime">2018-12-06T22:11:17Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2018-12-05T20:04:35Z</updated_at>
    <email>[email protected]</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata>
      <key>string value</key>
    </metadata>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</year>
    <address1 nil="true"/>
    <address2 nil="true"/>
    <city nil="true"/>
    <state nil="true"/>
    <zip nil="true"/>
    <country nil="true"/>
    <phone_number nil="true"/>
    <company nil="true"/>
    <full_name>Newfirst Newlast</full_name>
    <eligible_for_card_updater nil="true"/>
    <shipping_address1 nil="true"/>
    <shipping_address2 nil="true"/>
    <shipping_city nil="true"/>
    <shipping_state nil="true"/>
    <shipping_zip nil="true"/>
    <shipping_country nil="true"/>
    <shipping_phone_number nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>

Gateway specific response fields

A purchase or authorize response from USA ePay gateway should contain the auth_code field, which you can find in the gateway_specific_response_fields. The auth_code is the UMauthCode returned by USA ePay.

For example, a transaction could have something like this:

<transaction>
  <token>GEmCSGNCtBAvrM7YPrRVG6ieoM5</token>
  <transaction_type>Authorization</transaction_type>
  <gateway_specific_response_fields>
     <usa_epay>
       <auth_code>123456</auth_code>
     </usa_epay>
  </gateway_specific_response_fields>
</transaction>

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.