CardConnect Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
CardConnect
Services that work with Spreedly:
  • CardPointe
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify, Store
Supported payment types:
Credit Card, Bank Account
Regions:
North America

Authentication and Security

Specific names for credentials:
Merchant, Username, Password

Onboarding Merchants in:

Additional Notes

This gateway supports Level 2 and Level 3 transaction processing via Spreedly. If you are interested in Level 2 or Level 3 transaction support, please contact the gateway to confirm that your account is enabled for these processing types. Please let us know if there are any specific parameters you would like to have enabled.

Adding

To add a CardConnect gateway gateway you need to supply your CardConnect API username, password and merchant ID.


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>card_connect</gateway_type>
        <username>Your login</username>
        <password>Your password</password>
        <merchant_id>Your merchant id</merchant_id>
      </gateway>'

<gateway>
  <token>SypSdCPj1MKGkEdMqKqj8GNUv8d</token>
  <gateway_type>card_connect</gateway_type>
  <name>CardConnect</name>
  <description nil="true"/>
  <username>Your login</username>
  <merchant_id>Your merchant id</merchant_id>
  <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>username</name>
      <value>Your login</value>
    </credential>
    <credential>
      <name>merchant_id</name>
      <value>Your merchant id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>domain</gateway_specific_field>
    <gateway_specific_field>recurring</gateway_specific_field>
    <gateway_specific_field>po_number</gateway_specific_field>
    <gateway_specific_field>tax_amount</gateway_specific_field>
    <gateway_specific_field>freight_amount</gateway_specific_field>
    <gateway_specific_field>duty_amount</gateway_specific_field>
    <gateway_specific_field>order_date</gateway_specific_field>
    <gateway_specific_field>ship_from_zip</gateway_specific_field>
    <gateway_specific_field>secure_value</gateway_specific_field>
    <gateway_specific_field>secure_flag</gateway_specific_field>
    <gateway_specific_field>secure_xid</gateway_specific_field>
    <gateway_specific_field>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>
  <created_at type="dateTime">2018-06-19T17:07:39Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:07:39Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:card_connect, username: "Your login", password: "Your password", merchant_id: "Your Merchant ID")


#<Spreedly::Gateway:0x007fa720b47930
@token="6L7Uy1mwuwaNYLl6DI4J0ppMQsJ",
@created_at="2018-01-15T17:48:07Z",
@updated_at="2018-01-15T17:48:07Z",
@gateway_type="card_connect",
@state="retained",
@name="CardConnect",
@credentials={"username"=>"Your login", "merchant_id"=>"Your Merchant ID"}>

Gateway specific request fields

When interacting with CardConnect gateway, there are many gateway specific fields you can specify when making a call.

Domain

CardConnect assigns domains upon registration. If the domain assigned to you does not resolve to “fts.cardconnect.com”, please contact Support so that your assigned domain can be whitelisted. After your domain has been whitelisted, you can pass it as the gateway specific field domain.

All gateway specific request 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>
      <card_connect>
      <domain>https://fts.cardconnect.com:1234</domain>
      <recurring>true</recurring>
      <po_number>12345</po_number>
      <tax_amount>1200</tax_amount>
      <freight_amount>13000</freight_amount>
      <duty_amount>100</duty_amount>
      <order_date>01132018</order_date>
      <ship_from_zip>12345</ship_from_zip>
      <secure_flag>123ABC</secure_flag>
      <secure_value>123ABC</secure_value>
      <secure_xid>123asd</secure_xid>
      <items>
        <item>
          <line_no>1</line_no>
          <material>MATERIAL-1</material>
          <disc_amnt>0</disc_amnt>
          <unit_cost>900</unit_cost>
          <uom>CS</uom>
          <description>DESCRIPTION-1</description>
          <tax_amnt>117</tax_amnt>
          <quantity>1000</quantity>
          <upc>UPC-1</upc>
          <net_amnt>150</net_amnt>
        </item>
        <item>
          <line_no>2</line_no>
          <material>MATERIAL-2</material>
          <disc_amnt>0</disc_amnt>
          <unit_cost>900</unit_cost>
          <uom>CS</uom>
          <description>DESCRIPTION-2</description>
          <tax_amnt>117</tax_amnt>
          <quantity>1000</quantity>
          <upc>UPC-1</upc>
          <net_amnt>150</net_amnt>
        </item>
      </items>
    </card_connect>
  </gateway_specific_fields>
</transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-01-18T17:31:45Z</created_at>
  <updated_at type="dateTime">2018-01-18T17:31:45Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>YK4mlbiN7sQjtFWze6fgUCWQJ0E</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>
    <card_connect>
      <domain>https://fts.cardconnect.com:1234</domain>
      <recurring>true</recurring>
      <po_number>12345</po_number>
      <tax_amount>1200</tax_amount>
      <freight_amount>13000</freight_amount>
      <duty_amount>100</duty_amount>
      <order_date>01132018</order_date>
      <ship_from_zip>12345</ship_from_zip>
      <secure_flag>123ABC</secure_flag>
      <secure_value>123ABC</secure_value>
      <secure_xid>123asd</secure_xid>
      <items>
        <item type="array">
          <item>
            <line_no>1</line_no>
            <material>MATERIAL-1</material>
            <disc_amnt>0</disc_amnt>
            <unit_cost>900</unit_cost>
            <uom>CS</uom>
            <description>DESCRIPTION-1</description>
            <tax_amnt>117</tax_amnt>
            <quantity>1000</quantity>
            <upc>UPC-1</upc>
            <net_amnt>150</net_amnt>
          </item>
          <item>
            <line_no>2</line_no>
            <material>MATERIAL-2</material>
            <disc_amnt>0</disc_amnt>
            <unit_cost>900</unit_cost>
            <uom>CS</uom>
            <description>DESCRIPTION-2</description>
            <tax_amnt>117</tax_amnt>
            <quantity>1000</quantity>
            <upc>UPC-1</upc>
            <net_amnt>150</net_amnt>
          </item>
        </item>
      </items>
    </card_connect>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>64</gateway_transaction_id>
  <gateway_latency_ms type="integer">25</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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2018-01-18T17:31:45Z</created_at>
    <updated_at type="dateTime">2018-01-18T17:31:45Z</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-01-17T15:40:28Z</updated_at>
    <email>joey@example.com</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>
    <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>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    card_connect: {
      domain: "https://fts.cardconnect.com:1234",
      recurring: true,
      po_number: "12345",
      tax_amount: "1200",
      freight_amount: "13000",
      duty_amount: "100",
      order_date: "01132018",
      ship_from_zip: "12345",
      secure_flag: "123ABC",
      secure_value: "123ABC",
      secure_xid: "123abc",
      items: {
    item: [
    {
      line_no: "1",
      material: "MATERIAL-1",
      disc_amnt: "0",
      unit_cost: "900",
      uom: "CS",
          description: "DESCRIPTION-1",
          tax_amnt: "117",
          quantity: "1000",
          upc: "UPC-1",
      net_amnt: "150"
    }, 
    {
      line_no: "2",
      material: "MATERIAL-2",
      disc_amnt: "0",
      unit_cost: "900",
      uom: "CS",
          description: "DESCRIPTION-2",
          tax_amnt: "117",
          quantity: "1000",
          upc: "UPC-2",
      net_amnt: "150"
    }
    ] 
      }
    }
  }
)


#<Spreedly::Purchase:0x007fc6e1247980
@token="SZ0Uxu3LpOYWj4OCM9lEZPU47EA",
@created_at="2018-01-18T17:31:45Z",
@updated_at="2018-01-18T17:31:45Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="60",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@amount="4432",
@response,=
#<Spreedly::Response:0x007fc6e122dcb0
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2018-01-18T17:31:45Z",
@updated_at="2018-01-18T17:31:45Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x007fc6e1224070
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:card_connect=>{:domain=>"https://fts.cardconnect.com:1234", :recurring=>"true", :po_number=>"12345", :tax_amount=>"1200", :freight_amount=>"13000", :duty_amount=>"100", :order_date=>"01132018", :ship_from_zip=>"12345", :secure_flag=>"123ABC", :secure_value=>"123ABC", :secure_xid=>"123abc", :items=>"\n        [{:line_no=>\"1\", :material=>\"MATERIAL-1\", :disc_amnt=>\"0\", :unit_cost=>\"900\", :uom=>\"CS\", :description=>\"DESCRIPTION-1\", :tax_amnt=>\"117\", :quantity=>\"1000\", :upc=>\"UPC-1\", :net_amnt=>\"150\"}, {:line_no=>\"2\", :material=>\"MATERIAL-2\", :disc_amnt=>\"0\", :unit_cost=>\"900\", :uom=>\"CS\", :description=>\"DESCRIPTION-2\", :tax_amnt=>\"117\", :quantity=>\"1000\", :upc=>\"UPC-2\", :net_amnt=>\"150\"}]\n      "}},
@payment_method,=
#<Spreedly::CreditCard:0x007fc6dea03b18
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2018-01-18T17:31:45Z",
@email="joey@example.com",
@storage_state="retained",
@data="<my_payment_method_identifier>448</my_payment_method_identifier>\n      <extra_stuff>\n        <some_other_things>Can be anything really</some_other_things>\n      </extra_stuff>",
@first_name="Newfirst",
@last_name="Newlast",
@full_name="Newfirst Newlast",
@month="3",
@year="2032",
@number="XXXX-XXXX-XXXX-1111",
@last_four_digits="1111",
@first_six_digits="411111",
@card_type="visa",
@verification_value="",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="",
@company="",
@fingerprint="e3cef43464fc832f6e04f187df25af497994",
@eligible_for_card_updater="",
@errors=[]>>

If you would 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.

Gateway specific response fields

A response from CardConnect gateway may contain a batch_id field which you can find in the gateway_specific_response_fields. For example, a transaction could have something like this:

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <card_connect>
       <batch_id>abc123</batch_id>
     </card_connect>
  </gateway_specific_response_fields>
</transaction>