PAYARC Gateway Guide

PAYARC fact sheet

Additional notes
The `card_source` gateway specific field is required for all transactions. The `reason` gateway specific field is required for Void transactions.

Adding a PAYARC gateway

To add a PAYARC gateway you just need to supply your PAYARC API key:

curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
  <gateway_type>pay_arc</gateway_type>
  <api_key>Your API key</api_key>
</gateway>'

<gateway>
  <token>Ud5jkk5SOQrd900J17Nh0zRNxmu</token>
  <gateway_type>pay_arc</gateway_type>
  <name>PAYARC</name>
  <description nil="true"/>
  <merchant_profile_key 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_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">false</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>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>description</gateway_specific_field>
    <gateway_specific_field>statement_descriptor</gateway_specific_field>
    <gateway_specific_field>card_source</gateway_specific_field>
    <gateway_specific_field>tip_amount</gateway_specific_field>
    <gateway_specific_field>card_level</gateway_specific_field>
    <gateway_specific_field>sales_tax</gateway_specific_field>
    <gateway_specific_field>purchase_order</gateway_specific_field>
    <gateway_specific_field>supplier_reference_number</gateway_specific_field>
    <gateway_specific_field>customer_ref_id</gateway_specific_field>
    <gateway_specific_field>ship_to_zip</gateway_specific_field>
    <gateway_specific_field>amex_descriptor</gateway_specific_field>
    <gateway_specific_field>customer_vat_number</gateway_specific_field>
    <gateway_specific_field>summary_commodity_code</gateway_specific_field>
    <gateway_specific_field>shipping_charges</gateway_specific_field>
    <gateway_specific_field>duty_charges</gateway_specific_field>
    <gateway_specific_field>ship_from_zip</gateway_specific_field>
    <gateway_specific_field>destination_country_code</gateway_specific_field>
    <gateway_specific_field>vat_invoice</gateway_specific_field>
    <gateway_specific_field>order_date</gateway_specific_field>
    <gateway_specific_field>tax_category</gateway_specific_field>
    <gateway_specific_field>tax_type</gateway_specific_field>
    <gateway_specific_field>tax_rate</gateway_specific_field>
    <gateway_specific_field>tax_amount</gateway_specific_field>
    <gateway_specific_field>surcharge</gateway_specific_field>
    <gateway_specific_field>reason</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <sandbox type="boolean">false</sandbox>
  <created_at type="dateTime">2021-07-29T16:05:29Z</created_at>
  <updated_at type="dateTime">2021-07-29T16:05:29Z</updated_at>
</gateway>

Gateway specific fields

When interacting with a PAYARC gateway to run transactions, there are many gateway specific fields you can specify when making a call. 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>
    <pay_arc>
      <description>A1 Company 888-888-8888</description>
      <statement_descriptor>A1 Company</statement_descriptor>
      <card_source>INTERNET</card_source>
      <tip_amount>999</tip_amount>
      <card_level>LEVEL2</card_level>
      <sales_tax>999</sales_tax>
      <purchase_order>PO123</purchase_order>
      <supplier_reference_number>SRN12</supplier_reference_number>
      <customer_ref_id>CRID123</customer_ref_id>
      <ship_to_zip>12345</ship_to_zip>
      <amex_descriptor>AD123</amex_descriptor>
      <customer_vat_number>CVN123</customer_vat_number>
      <summary_commodity_code>SCC1</summary_commodity_code>
      <shipping_charges>999</shipping_charges>
      <duty_charges>999</duty_charges>
      <ship_from_zip>12345</ship_from_zip>
      <destination_country_code>DCC</destination_country_code>
      <vat_invoice>VI12</vat_invoice>
      <order_date>2020-01-31</order_date>
      <tax_category>SERVICE</tax_category>
      <tax_type>VAT</tax_type>
      <tax_rate>3</tax_rate>
      <tax_amount>999</tax_amount>
      <surcharge>3</surcharge>
      <reason>requested_by_customer</reason>
    </pay_arc>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2021-07-29T16:15:10Z</created_at>
  <updated_at type="dateTime">2021-07-29T16:15:10Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>HJMmycfWhxEkfVj16Jx57TS4m3C</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_arc>
      <description>A1 Company 888-888-8888</description>
      <statement_descriptor>A1 Company</statement_descriptor>
      <card_source>INTERNET</card_source>
      <tip_amount>999</tip_amount>
      <card_level>LEVEL2</card_level>
      <sales_tax>999</sales_tax>
      <purchase_order>PO123</purchase_order>
      <supplier_reference_number>SRN12</supplier_reference_number>
      <customer_ref_id>CRID123</customer_ref_id>
      <ship_to_zip>12345</ship_to_zip>
      <amex_descriptor>AD123</amex_descriptor>
      <customer_vat_number>CVN123</customer_vat_number>
      <summary_commodity_code>SCC1</summary_commodity_code>
      <shipping_charges>999</shipping_charges>
      <duty_charges>999</duty_charges>
      <ship_from_zip>12345</ship_from_zip>
      <destination_country_code>DCC</destination_country_code>
      <vat_invoice>VI12</vat_invoice>
      <order_date>2020-01-31</order_date>
      <tax_category>SERVICE</tax_category>
      <tax_type>VAT</tax_type>
      <tax_rate>3</tax_rate>
      <tax_amount>999</tax_amount>
      <surcharge>3</surcharge>
      <reason>requested_by_customer</reason>
    </pay_arc>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>61</gateway_transaction_id>
  <gateway_latency_ms type="integer">1</gateway_latency_ms>
  <stored_credential_initiator nil="true"/>
  <stored_credential_reason_type nil="true"/>
  <warning nil="true"/>
  <application_id nil="true"/>
  <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>
  <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">2021-07-29T16:15:10Z</created_at>
    <updated_at type="dateTime">2021-07-29T16:15:10Z</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">2021-07-28T19:30:21Z</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"/>
    <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>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Card source

The request’s card_source flag is required for all transactions. This field indicates how data was captured at the point of sale. It must be set to one of the following attributes:

MANUAL
PHONE
MAIL
INTERNET

Note: PAYARC processes the transaction as ‘card not present’ if the field value is PHONE, MAIL or INTERNET. For any other type of transaction, PAYARC processes the transaction as 'card present’.

Reason

The request’s reason flag is required for Void transactions as the reason the transaction was voided. It must be set to one of the following attributes:

requested_by_customer
fraudulent
duplicate
other

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.