QuickPay Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
QuickPay
Services that work with Spreedly:
  • QuickPay
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Store
Regions:
Europe

Authentication and Security

Specific names for credentials:
default mode:
Quickpay ID, Md5 Secret
with_api_key mode:
Quickpay ID, Api Key, Md5 Secret

Onboarding Merchants in:

Additional Notes

This gateway has been deprecated by QuickPay. They suggest using QuickPay V10 instead.

Adding a QuickPay gateway

To add a QuickPay gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>quickpay</gateway_type>
        <quickpay_id>login</quickpay_id>
        <md5_secret>password</md5_secret>
      </gateway>'

<gateway>
  <token>JDcmESEF1M96MKsexewH3Fy1Col</token>
  <gateway_type>quickpay</gateway_type>
  <name>QuickPay</name>
  <description nil="true"/>
  <quickpay_id>login</quickpay_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">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">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>quickpay_id</name>
      <value>login</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>finalize</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:15:47Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:47Z</updated_at>
  <mode>default</mode>
</gateway>

With API Key Mode

QuickPay allows you to specify an API key if you’d like. To do so, you’d make the call like so:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>quickpay</gateway_type>
        <quickpay_id>login</quickpay_id>
        <mode>with_api_key</mode>
        <md5_secret>password</md5_secret>
        <api_key>the_api_key</api_key>
      </gateway>'

<gateway>
  <token>94Vwhdf2mNwHz9waTRj4QcXbD4B</token>
  <gateway_type>quickpay</gateway_type>
  <name>QuickPay</name>
  <description nil="true"/>
  <quickpay_id>login</quickpay_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">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">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>quickpay_id</name>
      <value>login</value>
    </credential>
  </credentials>
  <gateway_specific_fields>
    <gateway_specific_field>finalize</gateway_specific_field>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
    <payment_method>third_party_token</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:15:48Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:48Z</updated_at>
  <mode>with_api_key</mode>
</gateway>

Optional Gateway Specific Fields

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

Finalize

QuickPay allows you to specify a finalize property during captures which finalizes a multiple partial capture. When set to 1, the transaction will go into a closed state and no more captures will be possible. It can be helpful to set this value to close transactions that may be remaining open in your QuickPay backend interface. You can specify it like so:


curl https://core.spreedly.com/v1/transactions/VanigrPuqhuoVGWSbAJludsW14j/capture.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>
          <quickpay>
            <finalize>1</finalize>
          </quickpay>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2016-08-11T17:15:47Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:47Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>WTUfJAH7mKNCGmOEAlIAob3NFzs</token>
  <transaction_type>Capture</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>
    <quickpay>
      <finalize>1</finalize>
    </quickpay>
  </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>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>8dvNMSuDr3kTlMIQxbkIaE5KNlX</gateway_token>
  <shipping_address>
    <name nil="true"/>
    <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 capture</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-08-11T17:15:47Z</created_at>
    <updated_at type="dateTime">2016-08-11T17:15:47Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <reference_token>EokNXgtqoeRmKCNxxHASwiXv8og</reference_token>
</transaction>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.capture_transaction("VanigrPuqhuoVGWSbAJludsW14j", amouunt: 50,
  gateway_specific_fields: {
    quickpay: {
      finalize: "1",
    }
  }
)


#<Spreedly::Capture:0x007ffae1cfa6f0
 @amount="100",
 @created_at="2016-08-11T17:15:48Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields={:quickpay=>{:finalize=>"1"}},
 @gateway_token="8dvNMSuDr3kTlMIQxbkIaE5KNlX",
 @gateway_transaction_id="67",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @reference_token="LLJZQn0WKcyjM1uQmH5eh4ZQx2s",
 @response=
  #<Spreedly::Response:0x007ffae1d098f8
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2016-08-11T17:15:48Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful capture",
   @pending="false",
   @success="true",
   @updated_at="2016-08-11T17:15:48Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007ffae1d10180
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="L8UfK0JFmVa2En7PGBXhgFKLHqC",
 @updated_at="2016-08-11T17:15:48Z">