WePay Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
WePay, Inc.
Services that work with Spreedly:
  • WePay
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Store
Regions:
North America

Authentication and Security

Specific names for credentials:
Account ID, Client Number, Access Token, Client Secret
Additional steps needed to activate?
Yes, additional steps must be taken to support recurring transactions. (See notes)

Onboarding Merchants in:

Additional Notes

Spreedly is currently integrated with WePay’s API version 2016-12-07. This version is explicitly set via the Api-Version header which will override what is shown in the WePay account dashboard. For more information, see WePay’s API versions page.

If you plan to process recurring transactions between Spreedly and WePay, you may need to contact WePay to have them enable your account.

Adding a WePay gateway

To add a WePay gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>wepay</gateway_type>
        <client_id>your_client_id</client_id>
        <account_id>your_account_id</account_id>
        <access_token>your_access_token</access_token>
        <client_secret>your_client_secret</client_secret>
      </gateway>'

<gateway>
  <token>VaX84aF1Qs6isynnqwHkPiedAD9</token>
  <gateway_type>wepay</gateway_type>
  <name>WePay</name>
  <description nil="true"/>
  <client_id>your_client_id</client_id>
  <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">true</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>client_id</name>
      <value>your_client_id</value>
    </credential>
    <credential>
      <name>account_id</name>
      <value>your_account_id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>callback_uri</gateway_specific_field>
    <gateway_specific_field>fee_payer</gateway_specific_field>
    <gateway_specific_field>application_fee</gateway_specific_field>
    <gateway_specific_field>type</gateway_specific_field>
  </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-12-29T16:30:32Z</created_at>
  <updated_at type="dateTime">2016-12-29T16:30:32Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:wepay, client_id: "your_client_id",
                        account_id: "your_account_id",
                        access_token: "your_access_token",
                        client_secret: "your_client_secret")


#<Spreedly::Gateway:0x007fcab93adf28
 @created_at="2016-08-11T17:16:24Z",
 @credentials={"client_id"=>"your_client_id", "account_id"=>"your_account_id"},
 @gateway_type="wepay",
 @name="WePay",
 @state="retained",
 @token="3xRSCunvvJLmeVgwyg6Ped2e62i",
 @updated_at="2016-08-11T17:16:24Z">

Optional Gateway Specific Fields

When interacting with a WePay gateway to run transactions, there are some gateway specific fields you can specify.

You can specify a callback_uri which can be used to listen for WePay’s Instant Payment Notifications (IPNs).

You can specify an application_fee and fee_payer to inform WePay as to who will pay the fees (WePay’s fees and any app fees).

You can specify the type to inform WePay as to the checkout type (SERVICE, DONATION, etc).


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>
          <wepay>
            <callback_uri>http://example.com/myipn/callback</callback_uri>
            <fee_payer>payee</fee_payer>
            <application_fee>10</application_fee>
            <type>EVENT</type>
          </wepay>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-12-29T16:30:32Z</created_at>
  <updated_at type="dateTime">2016-12-29T16:30:32Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>YjOdCF5uq3dclENJZDe1AMHdgee</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>
    <wepay>
      <callback_uri>http://example.com/myipn/callback</callback_uri>
      <fee_payer>payee</fee_payer>
      <application_fee>10</application_fee>
      <type>EVENT</type>
    </wepay>
  </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>5bLo5JbWEe1CsMifYqE6YZA0Dz0</gateway_token>
  <shipping_address>
    <name>Brisa Barrows</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-12-29T16:30:32Z</created_at>
    <updated_at type="dateTime">2016-12-29T16:30:32Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>RLWc150vKIxR0wceXO86Oo1lv8m</token>
    <created_at type="dateTime">2016-12-27T21:35:55Z</created_at>
    <updated_at type="dateTime">2016-12-27T21:35:55Z</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>Brisa</first_name>
    <last_name>Barrows</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>Brisa Barrows</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>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 4432,
  gateway_specific_fields: {
    wepay: {
      callback_uri: "http://example.com/myipn/callback",
      fee_payer: "payee",
      type: "EVENT"
    }
  }
)


#<Spreedly::Purchase:0x007fbebaa55930
 @amount="4432",
 @created_at="2016-08-11T17:16:25Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:wepay=>
    {:callback_uri=>"http://example.com/myipn/callback",
     :fee_payer=>"payee",
     :type=>"EVENT"}},
 @gateway_token="8dvNMSuDr3kTlMIQxbkIaE5KNlX",
 @gateway_transaction_id="65",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007fbeb9cd8410
   @address1="",
   @address2="",
   @card_type="visa",
   @city="",
   @company="",
   @country="",
   @created_at="2016-08-11T17:09:30Z",
   @data="",
   @eligible_for_card_updater="",
   @email="",
   @errors=[],
   @fingerprint="b0a45066121c1f1a49b3a6ffc26caf2995db",
   @first_name="Robert",
   @first_six_digits="411111",
   @full_name="Robert Lemke",
   @last_four_digits="1111",
   @last_name="Lemke",
   @month="4",
   @number="XXXX-XXXX-XXXX-1111",
   @phone_number="",
   @state="",
   @storage_state="retained",
   @token="UAwoPyWJhwZiYe2ZY1ri6ENAjLG",
   @updated_at="2016-08-11T17:16:25Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007fbeb9c99490
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2016-08-11T17:16:25Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2016-08-11T17:16:26Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007fbeb9cdbca0
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Robert Lemke",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="W7vsRtTj8Zmo021Ss97bUNGABRh",
 @updated_at="2016-08-11T17:16:26Z">

WePay OAuth Account Creation

WePay’s OAuth Support allows you to obtain permission from your customer to access their WePay account. At the end of the OAuth process, you’ll be given an access_token. Once you have that access_token, you can create a gateway by passing it in like so:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>wepay</gateway_type>
        <client_id>your_client_id</client_id>
        <account_id>your_account_id</account_id>
        <access_token>The Access Token received from the OAuth process</access_token>
        <client_secret>your_client_secret</client_secret>
      </gateway>'

<gateway>
  <token>XiNl9f1A7q4UzvzfbfBZAXxoRdX</token>
  <gateway_type>wepay</gateway_type>
  <name>WePay</name>
  <description nil="true"/>
  <client_id>your_client_id</client_id>
  <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">true</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>client_id</name>
      <value>your_client_id</value>
    </credential>
    <credential>
      <name>account_id</name>
      <value>your_account_id</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>callback_uri</gateway_specific_field>
    <gateway_specific_field>fee_payer</gateway_specific_field>
    <gateway_specific_field>type</gateway_specific_field>
  </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:16:26Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:16:26Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:wepay, client_id: "your_client_id",
                        account_id: "your_account_id",
                        access_token: "The Access Token received from the OAuth process",
                        client_secret: "your_client_secret")


#<Spreedly::Gateway:0x007fc993c1a020
 @created_at="2016-08-11T17:16:26Z",
 @credentials={"client_id"=>"your_client_id", "account_id"=>"your_account_id"},
 @gateway_type="wepay",
 @name="WePay",
 @state="retained",
 @token="53DrLlQX6j1RDuU23avLEbjviHk",
 @updated_at="2016-08-11T17:16:26Z">