Vanco Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Vanco Payment Solutions
Services that work with Spreedly:
  • Vanco
Supported operations:
Purchase, Refund
Unsupported operations:
Authorize, Capture, Void
Supported payment types:
Credit Card, Bank Account
Spreedly 3DS2 Global Supported
No
Gateway Specific 3DS2 Supported
No
Populate MIT GSF Support
No
Regions:
North America
API endpoint URL:
https://myvanco.vancopayments.com/cgi-bin/ws2.vps

Authentication and Security

Specific names for credentials:
Client Id, User Id, Password

Onboarding Merchants in:

Adding a Vanco gateway

To add a Vanco gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>vanco</gateway_type>
        <user_id>Your User ID</user_id>
        <password>Your password</password>
        <client_id>Your Client ID</client_id>
      </gateway>'


<gateway>
  <token>8pm2fxxliAsFgFo4c5KQMVzxnVE</token>
  <gateway_type>vanco</gateway_type>
  <name>Vanco</name>
  <description nil="true"/>
  <user_id>Your User ID</user_id>
  <client_id>Your Client ID</client_id>
  <characteristics>
    <supports_purchase type="boolean">true</supports_purchase>
    <supports_authorize type="boolean">false</supports_authorize>
    <supports_capture type="boolean">false</supports_capture>
    <supports_credit type="boolean">true</supports_credit>
    <supports_general_credit type="boolean">false</supports_general_credit>
    <supports_void type="boolean">false</supports_void>
    <supports_verify type="boolean">false</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>user_id</name>
      <value>Your User ID</value>
    </credential>
    <credential>
      <name>client_id</name>
      <value>Your Client ID</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>fund_id</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:30Z</created_at>
  <updated_at type="dateTime">2018-06-19T17:07:30Z</updated_at>
</gateway>



env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:vanco, user_id: "Your UserID", password: "Your password", client_id: "Your ClientID")



#<Spreedly::Gateway:0x007fe333b54028
@token="LdSlhBtHLYuBzOpKuYazFjI94FL",
@created_at="2017-07-27T17:51:14Z",
@updated_at="2017-07-27T17:51:14Z",
@gateway_type="vanco",
@state="retained",
@name="Vanco",
@credentials={"user_id"=>"Your UserID", "client_id"=>"Your ClientID"}>

Gateway specific fields

When interacting with a Vanco gateway to run transactions, there are some gateway specific fields you can specify when making a purchase call:

  • fund_id
  • session_id

Here, session_id is an object with an existing session id issued by Vanco as its id value, and a timestamp string as its created_at value. This timestamp string reflects when the session id was created by Vanco.

Note that sending a session_id is not required to complete a transaction with Vanco. Without it, transaction session ids are handled automatically. If you choose to use this field, you must first receive its values from the response_session_id gateway specific response field, as detailed below.

Session ids created by Vanco expire every 24 hours.


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>
          <vanco>
            <fund_id>TheFundID</fund_id>
            <session_id>
              <id>021f0475a38b02709583f0173760ac882959cdac</id>
              <created_at>2022-06-23 16:19:09 -0400</created_at>
            </session_id>
          </vanco>
        </gateway_specific_fields>
      </transaction>'


<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-07-27T17:51:14Z</created_at>
  <updated_at type="dateTime">2017-07-27T17:51:14Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>TZOXJE7qpZcLSgTmSqaiJbPt8o6</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>
    <vanco>
      <fund_id>TheFundID</fund_id>
      <session_id>
        <id>021f0475a38b02709583f0173760ac882959cdac</id>
        <created_at>2022-06-23 16:19:09 -0400</created_at>
      </session_id>
    </vanco>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>52</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>
  <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">2017-07-27T17:51:14Z</created_at>
    <updated_at type="dateTime">2017-07-27T17:51:14Z</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">2017-07-27T17:51:03Z</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: {
    vanco: {
      fund_id: "TheFundID"
    }
  }
)



#<Spreedly::Purchase:0x007fe333b0d308
@token="IEAMZsYi9lf6j1AgB3DHtrKpAgF",
@created_at="2017-07-27T17:51:15Z",
@updated_at="2017-07-27T17:51:15Z",
@state="succeeded",
@message="Succeeded!",
@succeeded="true",
@order_id="",
@ip="",
@description="",
@gateway_token="T11bJAANtTWnxl36GYjKWvbNK0g",
@gateway_transaction_id="46",
@email="",
@merchant_name_descriptor="",
@merchant_location_descriptor="",
@on_test_gateway="true",
@currency_code="USD",
@amount="4432",
@response,=
#<Spreedly::Response:0x007fe333af6ba8
@success="true",
@pending="false",
@cancelled="false",
@fraud_review="",
@created_at="2017-07-27T17:51:15Z",
@updated_at="2017-07-27T17:51:15Z",
@message="Successful purchase",
@avs_code="",
@avs_message="",
@cvv_code="",
@cvv_message="",
@error_code="",
@error_detail="">,
@shipping_address,=
#<Spreedly::ShippingAddress:0x007fe333aec568
@name="Newfirst Newlast",
@address1="",
@address2="",
@city="",
@state="",
@zip="",
@country="",
@phone_number="">,
@gateway_specific_fields={:vanco=>{:fund_id=>"TheFundID", :session_id=>{:id=>"021f0475a38b02709583f0173760ac882959cdac", :created_at=>"2022-06-23 16:19:09 -0400"}}},
@payment_method,=
#<Spreedly::CreditCard:0x007fe333ae4a98
@token="1rpKvP8zOUhj4Y9EDrIoIYQzzD5",
@created_at="2017-06-26T17:04:38Z",
@updated_at="2017-07-27T17:51:14Z",
@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=[]>>

Please refer to using a payment method for more information on how to send GSFs.

Gateway specific response fields

When interacting with a Vanco gateway to run transactions, there are some gateway specific response fields that are returned when making a purchase call:

  • response_session_id

With most transactions, a session id is returned in the id field nested in the response_session_id gateway specific response field, and a timestamp string in the created_at nested field. This session id is generated by Vanco, and timestamp string reflects when the session id was created by Vanco.

Both the id and created_at field values can optionally be passed into the session_id gateway specific field cited above to complete a purchase with an existing session id. This session id will expire every 24 hours, and a new one is generated automatically and returned in the id nested field of the response_session_id gateway specific response field.

The response_session_id gateway specific response field is not returned in a transaction response if the session_id gateway specific field was passed in the transaction request, unless that session id was expired and a new one had to be generated by Vanco.

Passing session id data returned in the response_session_id gateway specific response field for a request is completely optional. If you are not planning to use the session_id gateway specific field to complete a transaction, you can ignore the contents of response_session_id.

<transaction>
  <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <vanco>
       <response_session_id>
        <id>ad38def8af33a31a6fc31076ff60706c0fa152df</id>
        <created_at>2022-06-23 16:19:09 -0400</created_at>
      </response_session_id>
     </vanco>
  </gateway_specific_response_fields>
</transaction>