BluePay Gateway Guide

close

Services and Compatibility

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

Authentication and Security

Specific names for credentials:
Account ID, Secret Key

Onboarding Merchants in:

Adding

To add a BluePay gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>blue_pay</gateway_type>
        <account_id>Your Account ID</account_id>
        <secret_key>Secret Key</secret_key>
      </gateway>'

<gateway>
  <token>3bBCLlw7X2MoTQND0iFsrvxGr64</token>
  <gateway_type>blue_pay</gateway_type>
  <name>BluePay</name>
  <description nil="true"/>
  <account_id>Your Account ID</account_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">false</supports_verify>
    <supports_reference_purchase type="boolean">true</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>account_id</name>
      <value>Your Account ID</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>duplicate_override</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">2016-10-07T15:14:14Z</created_at>
  <updated_at type="dateTime">2016-10-07T15:14:14Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:blue_pay, account_id: 'Your Account ID', secret_key: 'SecretKey')


#<Spreedly::Gateway:0x007fb3e3b36930
 @created_at="2016-08-11T17:14:05Z",
 @credentials={"account_id"=>"Your Account ID"},
 @gateway_type="blue_pay",
 @name="BluePay",
 @state="retained",
 @token="6O9nPEz2qXJkI5MlekyalqeSJC3",
 @updated_at="2016-08-11T17:14:05Z">

Gateway specific fields

When running transactions with a BluePay gateway, you may specify the duplicate_override flag as 1 or 0. It can be added like this:


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>
          <blue_pay>
            <duplicate_override>1</duplicate_override>
          </blue_pay>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-10-07T15:14:15Z</created_at>
  <updated_at type="dateTime">2016-10-07T15:14:15Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>5oDYd7J3oPV7QE2mEtvdDbvFNBe</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>
    <blue_pay>
      <duplicate_override>1</duplicate_override>
    </blue_pay>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>51</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>G5paAyK3ZyONfHxh5qJcBViFgZx</gateway_token>
  <shipping_address>
    <name>Khalil Schowalter</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-10-07T15:14:15Z</created_at>
    <updated_at type="dateTime">2016-10-07T15:14:15Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>YHGChcqYyg5WWJj764bFTUCJaAv</token>
    <created_at type="dateTime">2016-09-19T17:14:01Z</created_at>
    <updated_at type="dateTime">2016-09-28T18:14:19Z</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>Khalil</first_name>
    <last_name>Schowalter</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>Khalil Schowalter</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>