Beanstream Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Beanstream
Services that work with Spreedly:
  • Beanstream
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Regions:
North America

Authentication and Security

Specific names for credentials:
Merchant ID, Username, Password

Onboarding Merchants in:

Additional Notes

If you’d like to use a dynamic descriptor, contact Beanstream technical support to add Dynamic DBA to your account. Use ref1 as part of your DBA Suffix. ref1 can be passed in as a gateway specific field.

Adding

To add a Beanstream gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>beanstream</gateway_type>
        <merchant_id>23423423</merchant_id>
        <username>username</username>
        <password>password</password>
      </gateway>'

<gateway>
  <token>HpSxtKQyq14PJ1OEb7ADs00I382</token>
  <gateway_type>beanstream</gateway_type>
  <name>Beanstream</name>
  <description nil="true"/>
  <merchant_id>23423423</merchant_id>
  <username>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_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>merchant_id</name>
      <value>23423423</value>
    </credential>
    <credential>
      <name>username</name>
      <value>username</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:14:03Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:14:03Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:beanstream, username: 'username', password: 'password',
                merchant_id: '23423423')


#<Spreedly::Gateway:0x007fa601852420
 @created_at="2016-08-11T17:14:04Z",
 @credentials={"merchant_id"=>"23423423", "username"=>"username"},
 @gateway_type="beanstream",
 @name="Beanstream",
 @state="retained",
 @token="G0rRx2ACwtpvauXrC1J02PPFDnH",
 @updated_at="2016-08-11T17:14:04Z">

Gateway specific fields

When interacting with a Beanstream gateway to run transactions, you can add ref1 as a gateway specific field. This can be used to pass in a dynamic descriptor for the transaction. Your account needs to be setup for Dynamic DBA for this to work correctly. Contact Beanstream gateway technical support to set it up. Make sure ref1 is part of the DBA Suffix.


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
-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>
        <beanstream>
          <ref1>Dynamic Descriptor</ref1>
        </beanstream>
      </gateway_specific_fields>
    </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-11-16T19:21:58Z</created_at>
  <updated_at type="dateTime">2016-11-16T19:21:59Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>kcUppcOzUcegaAaGr4h6UhQSU4</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>
    <beanstream>
      <ref1>Dynamic Descriptor</ref1>
    </beanstream>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>50</gateway_transaction_id>
  <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>Mc3gnlZWcPwOBUurFZwnz4A6VMD</gateway_token>
  <shipping_address>
    <name>Marcelle Hessel</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">2016-11-16T19:21:59Z</created_at>
    <updated_at type="dateTime">2016-11-16T19:21:59Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>Q8EJ5hP0Xdg4dAuEae41VTKLwyI</token>
    <created_at type="dateTime">2016-11-16T14:24:07Z</created_at>
    <updated_at type="dateTime">2016-11-16T19:13:43Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <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>Marcelle</first_name>
    <last_name>Hessel</last_name>
    <month type="integer">4</month>
    <year type="integer">2020</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>Marcelle Hessel</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 nil="true"/>
  </payment_method>
</transaction>

Gateway specific response fields

A response from Beanstream gateway may contain an auth_code 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>
     <beanstream>
       <auth_code>abc123</auth_code>
     </beanstream>
  </gateway_specific_response_fields>
</transaction>