PayTrace Gateway Guide

PayTrace fact sheet

Adding a PayTrace gateway

To add a PayTrace gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>pay_trace</gateway_type>
        <username>Your username</username>
        <password>Your password</password>
        <integrator_id>Your integrator ID</integrator_id>
      </gateway>'

<gateway>
  <token>MebiM04UXccVv0ZpO6RPHyOpoQ3</token>
  <gateway_type>pay_trace</gateway_type>
  <name>PayTrace</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <username>Your username</username>
  <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_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
    <supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_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">true</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_network_tokenization type="boolean">false</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>username</name>
      <value>Your username</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>invoice_id</gateway_specific_field>
    <gateway_specific_field>customer_reference_id</gateway_specific_field>
    <gateway_specific_field>tax_amount</gateway_specific_field>
    <gateway_specific_field>national_tax_amount</gateway_specific_field>
    <gateway_specific_field>merchant_tax_id</gateway_specific_field>
    <gateway_specific_field>customer_tax_id</gateway_specific_field>
    <gateway_specific_field>commodity_code</gateway_specific_field>
    <gateway_specific_field>discount_amount</gateway_specific_field>
    <gateway_specific_field>freight_amount</gateway_specific_field>
    <gateway_specific_field>duty_amount</gateway_specific_field>
    <gateway_specific_field>source_address</gateway_specific_field>
    <gateway_specific_field>shipping_address</gateway_specific_field>
    <gateway_specific_field>additional_tax_amount</gateway_specific_field>
    <gateway_specific_field>additional_tax_included</gateway_specific_field>
    <gateway_specific_field>additional_tax_rate</gateway_specific_field>
    <gateway_specific_field>amount</gateway_specific_field>
    <gateway_specific_field>debit_or_credit</gateway_specific_field>
    <gateway_specific_field>description</gateway_specific_field>
    <gateway_specific_field>discount_rate</gateway_specific_field>
    <gateway_specific_field>discount_included</gateway_specific_field>
    <gateway_specific_field>product_id</gateway_specific_field>
    <gateway_specific_field>quantity</gateway_specific_field>
    <gateway_specific_field>transaction_id</gateway_specific_field>
    <gateway_specific_field>tax_included</gateway_specific_field>
    <gateway_specific_field>unit_of_measure</gateway_specific_field>
    <gateway_specific_field>unit_cost</gateway_specific_field>
    <gateway_specific_field>visa_or_mastercard</gateway_specific_field>
    <gateway_specific_field>line_items</gateway_specific_field>
    <gateway_specific_field>check_transaction</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>bank_account</payment_method>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <mode>default</mode>
  <created_at type="dateTime">2022-09-12T08:12:07Z</created_at>
  <updated_at type="dateTime">2022-09-12T08:12:07Z</updated_at>
</gateway>

Gateway specific fields

When interacting with a PayTrace gateway to run transactions, there are a number of gateway specific fields you can specify. Gateway specific field check_transaction should be passed when performing capture, void, and refund transactions using bank_account payment method.

Level 3 data

This gateway supports Level 3 data when using the purchase endpoint for Visa or MasterCard only. In order to utilize the Level 3 fields, you must indicate which credit card type is to be used by including the visa_or_mastercard gateway specific field. For example, if a Visa card is being used during the transaction, you must include the visa_or_mastercard gateway specific field with the value set to visa. Conversely, if a MasterCard is being used, you must set the value to mastercard.

Adding level 3 data to a purchase transaction is supported by including the applicable gateway specific fields. Visa and MasterCard have their own requirements for level 3 data. For more information about Level 3 data fields and the specific Visa and MasterCard requirements, please refer to PayTrace’s Level 3 Data documentation.

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>
          <pay_trace>
            <invoice_id>inv1234</invoice_id>
            <customer_reference_id>PO123456</customer_reference_id>
            <tax_amount>810</tax_amount>
            <national_tax_amount>0</national_tax_amount>
            <merchant_tax_id>3456defg</merchant_tax_id>
            <customer_tax_id>3456test</customer_tax_id>
            <commodity_code>4321</commodity_code>
            <discount_amount>99</discount_amount>
            <freight_amount>75</freight_amount>
            <duty_amount>0</duty_amount>
            <check_transaction>true</check_transaction>
            <source_address>
              <zip>99201</zip>
            </source_address>
            <shipping_address>
              <zip>85284</zip>
              <country>US</country>
            </shipping_address>
            <additional_tax_amount>0</additional_tax_amount>
            <additional_tax_included>false</additional_tax_included>
            <additional_tax_rate>8</additional_tax_rate>
            <discount_rate>1</discount_rate>
            <transaction_id>105968573</transaction_id>
            <tax_included>false</tax_included>
            <visa_or_mastercard>visa</visa_or_mastercard>
            <line_items>
              <additional_tax_amount>0</additional_tax_amount>
              <additional_tax_rate>8</additional_tax_rate>
              <additional_tax_included>false</additional_tax_included>
              <amount>1999</amount>
              <debit_or_credit>D</debit_or_credit>
              <commodity_code>123commodity</commodity_code>
              <description>business services</description>
              <discount_amount>49</discount_amount>
              <discount_rate>1</discount_rate>
              <discount_included>false</discount_included>
              <merchant_tax_id>3456defg</merchant_tax_id>
              <product_id>sku1245</product_id>
              <quantity>10</quantity>
              <tax_included>true</tax_included>
              <unit_of_measure>EACH</unit_of_measure>
              <unit_cost>5.25</unit_cost>
            </line_items>
          </pay_trace>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-09-12T08:12:05Z</created_at>
  <updated_at type="dateTime">2022-09-12T08:12:05Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>ArZSkypJFDpg1Y5VSuwapbqJVof</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"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <pay_trace>
      <invoice_id>inv1234</invoice_id>
      <customer_reference_id>PO123456</customer_reference_id>
      <tax_amount>810</tax_amount>
      <national_tax_amount>0</national_tax_amount>
      <merchant_tax_id>3456defg</merchant_tax_id>
      <customer_tax_id>3456test</customer_tax_id>
      <commodity_code>4321</commodity_code>
      <discount_amount>99</discount_amount>
      <freight_amount>75</freight_amount>
      <duty_amount>0</duty_amount>
      <check_transaction>true</check_transaction>
      <source_address>
        <zip>99201</zip>
      </source_address>
      <shipping_address>
        <zip>85284</zip>
        <country>US</country>
      </shipping_address>
      <additional_tax_amount>0</additional_tax_amount>
      <additional_tax_included>false</additional_tax_included>
      <additional_tax_rate>8</additional_tax_rate>
      <discount_rate>1</discount_rate>
      <transaction_id>105968573</transaction_id>
      <tax_included>false</tax_included>
      <visa_or_mastercard>visa</visa_or_mastercard>
      <line_items>
        <additional_tax_amount>0</additional_tax_amount>
        <additional_tax_rate>8</additional_tax_rate>
        <additional_tax_included>false</additional_tax_included>
        <amount>1999</amount>
        <debit_or_credit>D</debit_or_credit>
        <commodity_code>123commodity</commodity_code>
        <description>business services</description>
        <discount_amount>49</discount_amount>
        <discount_rate>1</discount_rate>
        <discount_included>false</discount_included>
        <merchant_tax_id>3456defg</merchant_tax_id>
        <product_id>sku1245</product_id>
        <quantity>10</quantity>
        <tax_included>true</tax_included>
        <unit_of_measure>EACH</unit_of_measure>
        <unit_cost>5.25</unit_cost>
      </line_items>
    </pay_trace>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>54</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <populate_mit_fields type="boolean">false</populate_mit_fields>
  <warning nil="true"/>
  <application_id nil="true"/>
  <amount type="integer">100</amount>
  <local_amount nil="true"/>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <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">2022-09-12T08:12:05Z</created_at>
    <updated_at type="dateTime">2022-09-12T08:12:05Z</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">2022-09-12T08:07:36Z</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>
    <callback_url nil="true"/>
    <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 type="boolean">true</eligible_for_card_updater>
    <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"/>
    <issuer_identification_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>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific response fields

A response from PayTrace may contain the following gateway specific response field:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <pay_trace>
       <approval_code>TAS222</approval_code>
     </pay_trace>
  </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.