better_offsite_payments 2.3.0

data/lib/offsite_payments/integrations/sage_pay_form.rb

@@ -0,0 +1,431 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module SagePayForm
+      mattr_accessor :production_url
+      mattr_accessor :test_url
+      mattr_accessor :simulate_url
+      self.production_url = 'https://live.sagepay.com/gateway/service/vspform-register.vsp'
+      self.test_url       = 'https://test.sagepay.com/gateway/service/vspform-register.vsp'
+      self.simulate_url   = 'https://test.sagepay.com/Simulator/VSPFormGateway.asp'
+
+      def self.return(query_string, options = {})
+        Return.new(query_string, options)
+      end
+
+      def self.service_url
+        mode = OffsitePayments.mode
+        case mode
+        when :production
+          self.production_url
+        when :test
+          self.test_url
+        when :simulate
+          self.simulate_url
+        else
+          raise StandardError, "Integration mode set to an invalid value: #{mode}"
+        end
+      end
+
+      module Encryption
+        def sage_encrypt(plaintext, key)
+          encrypted = cipher(:encrypt, key, plaintext)
+          "@#{encrypted.upcase}"
+        end
+
+        def sage_decrypt(ciphertext, key)
+          ciphertext = ciphertext[1..-1] # remove @ symbol at the beginning of a string
+          cipher(:decrypt, key, ciphertext)
+        rescue OpenSSL::Cipher::CipherError => e
+          return '' if e.message == 'wrong final block length'
+          raise
+        end
+
+        def sage_encrypt_salt(min, max)
+          length = rand(max - min + 1) + min
+          SecureRandom.base64(length + 4)[0, length]
+        end
+
+        private
+
+        def cipher(action, key, payload)
+          if action == :decrypt
+            payload = [payload].pack('H*')
+          end
+
+          cipher = OpenSSL::Cipher::AES128.new(:CBC)
+          cipher.public_send(action)
+          cipher.key = key
+          cipher.iv = key
+          result = cipher.update(payload) + cipher.final
+
+          if action == :encrypt
+            result = result.unpack('H*')[0]
+          end
+
+          result
+        end
+      end
+
+      class Helper < OffsitePayments::Helper
+        include Encryption
+
+        attr_reader :identifier
+
+        def initialize(order, account, options={})
+          super
+          @identifier = rand(0..99999).to_s.rjust(5, '0')
+          add_field 'VendorTxCode', "#{order}-#{@identifier}"
+        end
+
+        mapping :credential2, 'EncryptKey'
+
+        mapping :account, 'Vendor'
+        mapping :amount, 'Amount'
+        mapping :currency, 'Currency'
+
+        mapping :customer,
+          :first_name => 'BillingFirstnames',
+          :last_name  => 'BillingSurname',
+          :email      => 'CustomerEMail',
+          :phone      => 'BillingPhone',
+          :send_email_confirmation => 'SendEmail'
+
+        mapping :billing_address,
+          :city     => 'BillingCity',
+          :address1 => 'BillingAddress1',
+          :address2 => 'BillingAddress2',
+          :state    => 'BillingState',
+          :zip      => 'BillingPostCode',
+          :country  => 'BillingCountry'
+
+        mapping :shipping_address,
+          :city     => 'DeliveryCity',
+          :address1 => 'DeliveryAddress1',
+          :address2 => 'DeliveryAddress2',
+          :state    => 'DeliveryState',
+          :zip      => 'DeliveryPostCode',
+          :country  => 'DeliveryCountry'
+
+        mapping :return_url, 'SuccessURL'
+        mapping :description, 'Description'
+
+        class_attribute :referrer_id
+
+        def shipping_address(params = {})
+          @shipping_address_set = true unless params.empty?
+
+          params.each do |k, v|
+            field = mappings[:shipping_address][k]
+            add_field(field, v) unless field.nil?
+          end
+        end
+
+        def map_billing_address_to_shipping_address
+          %w(City Address1 Address2 State PostCode Country).each do |field|
+            fields["Delivery#{field}"] = fields["Billing#{field}"]
+          end
+        end
+
+        def form_fields
+          map_billing_address_to_shipping_address unless @shipping_address_set
+
+          fields['DeliveryFirstnames'] ||= fields['BillingFirstnames']
+          fields['DeliverySurname']    ||= fields['BillingSurname']
+
+          fields['FailureURL'] ||= fields['SuccessURL']
+
+          fields['BillingPostCode'] ||= "0000"
+          fields['DeliveryPostCode'] ||= "0000"
+
+          fields['ReferrerID'] = referrer_id if referrer_id
+
+          crypt_skip = ['Vendor', 'EncryptKey', 'SendEmail']
+          crypt_skip << 'BillingState'  unless fields['BillingCountry']  == 'US'
+          crypt_skip << 'DeliveryState' unless fields['DeliveryCountry'] == 'US'
+          crypt_skip << 'CustomerEMail' unless fields['SendEmail']
+          key = fields['EncryptKey']
+          @crypt ||= create_crypt_field(fields.except(*crypt_skip), key)
+
+          {
+            'VPSProtocol' => '3.00',
+            'TxType' => 'PAYMENT',
+            'Vendor' => @fields['Vendor'],
+            'Crypt'  => @crypt
+          }
+        end
+
+        private
+
+        def create_crypt_field(fields, key)
+          parts = fields.map { |k, v| "#{k}=#{sanitize(k, v)}" unless v.nil? }.compact.shuffle
+          parts.unshift(sage_encrypt_salt(key.length, key.length * 2))
+          sage_encrypt(parts.join('&'), key)
+        rescue OpenSSL::Cipher::CipherError => e
+          if e.message == 'key length too short'
+            raise ActionViewHelperError, 'Invalid encryption key.'
+          else
+            raise
+          end
+        end
+
+        def sanitize(key, value)
+          reject = exact = nil
+
+          case key
+          when /URL$/
+            # allow all
+          when 'VendorTxCode'
+            reject = /[^A-Za-z0-9{}._-]+/
+          when /[Nn]ames?$/
+            reject = %r{[^[:alpha:] /\\.'-]+}
+          when /(?:Address[12]|City)$/
+            reject = %r{[^[:alnum:] +'/\\:,.\n()-]+}
+          when /PostCode$/
+            reject = /[^A-Za-z0-9 -]+/
+          when /Phone$/
+            reject = /[^0-9A-Za-z+ ()-]+/
+          when 'Currency'
+            exact = /^[A-Z]{3}$/
+          when /State$/
+            exact = /^[A-Z]{2}$/
+          when 'Description'
+            value = value[0...100]
+          else
+            reject = /&+/
+          end
+
+          if exact
+            raise ArgumentError, "Invalid value for #{key}: #{value.inspect}" unless value =~ exact
+            value
+          elsif reject
+            value.gsub(reject, ' ')
+          else
+            value
+          end
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        class CryptError < StandardError; end
+
+        include Encryption
+
+        def initialize(post_data, options)
+          super
+          load_crypt_params(params['crypt'], options[:credential2])
+        end
+
+        # Was the transaction complete?
+        def complete?
+          status_code == 'OK'
+        end
+
+        # Was the transaction cancelled?
+        # Unfortunately, we can't distinguish "user abort" from "idle too long".
+        def cancelled?
+          status_code == 'ABORT'
+        end
+
+        # Text version of #complete?, since we don't support Pending.
+        def status
+          complete? ? 'Completed' : 'Failed'
+        end
+
+        # Status of transaction. List of possible values:
+        # <tt>OK</tt>:: Transaction completed successfully.
+        # <tt>NOTAUTHED</tt>:: Incorrect card details / insufficient funds.
+        # <tt>MALFORMED</tt>:: Invalid input data.
+        # <tt>INVALID</tt>:: Valid input data, but some fields are incorrect.
+        # <tt>ABORT</tt>:: User hit cancel button or went idle for 15+ minutes.
+        # <tt>REJECTED</tt>:: Rejected by account fraud screening rules.
+        # <tt>AUTHENTICATED</tt>:: Authenticated card details secured at SagePay.
+        # <tt>REGISTERED</tt>:: Non-authenticated card details secured at SagePay.
+        # <tt>ERROR</tt>:: Problem internal to SagePay.
+        def status_code
+          params['Status']
+        end
+
+        # Check this if #completed? is false.
+        def message
+          params['StatusDetail']
+        end
+
+        # Vendor-supplied code (:order mapping).
+        def item_id
+          params['VendorTxCode'].rpartition('-').first
+        end
+
+        # Internal SagePay code, typically "{LONG-UUID}".
+        def transaction_id
+          params['VPSTxId']
+        end
+
+        # Authorization number (only if #completed?).
+        def auth_id
+          params['TxAuthNo']
+        end
+
+        # Total amount (no fees).
+        def gross
+          params['Amount'].gsub(/,(?=\d{3}\b)/, '')
+        end
+
+        # AVS and CV2 check results.  Possible values:
+        # <tt>ALL MATCH</tt>::
+        # <tt>SECURITY CODE MATCH ONLY</tt>::
+        # <tt>ADDRESS MATCH ONLY</tt>::
+        # <tt>NO DATA MATCHES</tt>::
+        # <tt>DATA NOT CHECKED</tt>::
+        def avs_cv2_result
+          params['AVSCV2']
+        end
+
+        # Numeric address check.  Possible values:
+        # <tt>NOTPROVIDED</tt>::
+        # <tt>NOTCHECKED</tt>::
+        # <tt>MATCHED</tt>::
+        # <tt>NOTMATCHED</tt>::
+        def address_result
+          params['AddressResult']
+        end
+
+        # Post code check.  Possible values:
+        # <tt>NOTPROVIDED</tt>::
+        # <tt>NOTCHECKED</tt>::
+        # <tt>MATCHED</tt>::
+        # <tt>NOTMATCHED</tt>::
+        def post_code_result
+          params['PostCodeResult']
+        end
+
+        # CV2 code check.  Possible values:
+        # <tt>NOTPROVIDED</tt>::
+        # <tt>NOTCHECKED</tt>::
+        # <tt>MATCHED</tt>::
+        # <tt>NOTMATCHED</tt>::
+        def cv2_result
+          params['CV2Result']
+        end
+
+        # Was the Gift Aid box checked?
+        def gift_aid?
+          params['GiftAid'] == '1'
+        end
+
+        # Result of 3D Secure checks.  Possible values:
+        # <tt>OK</tt>:: Authenticated correctly.
+        # <tt>NOTCHECKED</tt>:: Authentication not performed.
+        # <tt>NOTAVAILABLE</tt>:: Card not auth-capable, or auth is otherwise impossible.
+        # <tt>NOTAUTHED</tt>:: User failed authentication.
+        # <tt>INCOMPLETE</tt>:: Authentication unable to complete.
+        # <tt>ERROR</tt>:: Unable to attempt authentication due to data / service errors.
+        def buyer_auth_result
+          params['3DSecureStatus']
+        end
+
+        # Encoded 3D Secure result code.
+        def buyer_auth_result_code
+          params['CAVV']
+        end
+
+        # Address confirmation status.  PayPal only.  Possible values:
+        # <tt>NONE</tt>::
+        # <tt>CONFIRMED</tt>::
+        # <tt>UNCONFIRMED</tt>::
+        def address_status
+          params['AddressStatus']
+        end
+
+        # Payer verification.  Undocumented.
+        def payer_verified?
+          params['PayerStatus'] == 'VERIFIED'
+        end
+
+        # Credit card type.  Possible values:
+        # <tt>VISA</tt>:: Visa
+        # <tt>MC</tt>:: MasterCard
+        # <tt>DELTA</tt>:: Delta
+        # <tt>SOLO</tt>:: Solo
+        # <tt>MAESTRO</tt>:: Maestro (UK and International)
+        # <tt>UKE</tt>:: Visa Electron
+        # <tt>AMEX</tt>:: American Express
+        # <tt>DC</tt>:: Diners Club
+        # <tt>JCB</tt>:: JCB
+        # <tt>LASER</tt>:: Laser
+        # <tt>PAYPAL</tt>:: PayPal
+        def credit_card_type
+          params['CardType']
+        end
+
+        # Last four digits of credit card.
+        def credit_card_last_4_digits
+          params['Last4Digits']
+        end
+
+        # Used by composition methods, but not supplied by SagePay.
+        def currency
+          nil
+        end
+
+        def test?
+          false
+        end
+
+        def acknowledge
+          true
+        end
+
+        private
+
+        def load_crypt_params(crypt, key)
+          raise MissingCryptData if crypt.blank?
+          raise MissingCryptKey  if key.blank?
+
+          crypt_data = sage_decrypt(crypt.gsub(' ', '+'), key)
+          raise InvalidCryptData unless crypt_data =~ /(^|&)Status=/
+
+          params.clear
+          parse(crypt_data)
+        end
+
+        class MissingCryptKey  < CryptError
+          def message
+            'No merchant decryption key supplied'
+          end
+        end
+        class MissingCryptData < CryptError
+          def message
+            'No data received from SagePay'
+          end
+        end
+        class InvalidCryptData < CryptError
+          def message
+            'Invalid data received from SagePay'
+          end
+        end
+      end
+
+      class Return < OffsitePayments::Return
+        def initialize(query_string, options)
+          begin
+            @notification = Notification.new(query_string, options)
+          rescue Notification::CryptError => e
+            @message = e.message
+          end
+        end
+
+        def success?
+          @notification && @notification.complete?
+        end
+
+        def cancelled?
+          @notification && @notification.cancelled?
+        end
+
+        def message
+          @message || @notification.message
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/two_checkout.rb

@@ -0,0 +1,329 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module TwoCheckout
+      mattr_accessor :payment_routine
+      self.payment_routine = :single_page
+
+      def self.service_url
+        case self.payment_routine
+        when :multi_page
+          'https://www.2checkout.com/checkout/purchase'
+        when :single_page
+          'https://www.2checkout.com/checkout/spurchase'
+        else
+          raise StandardError, "Integration payment routine set to an invalid value: #{self.payment_routine}"
+        end
+      end
+
+      def self.service_url=(service_url)
+        # Note: do not use this method, it is here for backward compatibility
+        # Use the payment_routine method to change service_url
+        if service_url =~ /spurchase/
+          self.payment_routine = :single_page
+        else
+          self.payment_routine = :multi_page
+        end
+      end
+
+      def self.notification(post, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(query_string, options = {})
+        Return.new(query_string, options)
+      end
+
+      class Helper < OffsitePayments::Helper
+        def initialize(order, account, options = {})
+          super
+          if OffsitePayments.mode == :test || options[:test]
+            add_field('demo', 'Y')
+          end
+        end
+
+        # The 2checkout vendor account number
+        mapping :account, 'sid'
+
+        # The total amount to be billed, in decimal form, without a currency symbol. (8 characters, decimal, 2 characters: Example: 99999999.99)
+        # This field is only used with the Third Party Cart parameter set.
+        mapping :amount, 'total'
+
+        # Pass the sale's currency code.
+        mapping :currency, 'currency_code'
+
+        # Pass your order id.  (50 characters max)
+        mapping :order, 'merchant_order_id'
+
+        # Pass your cart identifier if you are using Third Part Cart Parameters. (128 characters max)
+        # This value is visible to the buyer and will be listed as the sale's lineitem.
+        mapping :invoice, 'cart_order_id'
+
+        mapping :customer,
+                :email      => 'email',
+                :phone      => 'phone'
+
+        mapping :billing_address,
+                :city     => 'city',
+                :address1 => 'street_address',
+                :address2 => 'street_address2',
+                :state    => 'state',
+                :zip      => 'zip',
+                :country  => 'country'
+
+        mapping :shipping_address,
+                :name     => 'ship_name',
+                :city     => 'ship_city',
+                :address1 => 'ship_street_address',
+                :address2 => 'ship_street_address2',
+                :state    => 'ship_state',
+                :zip      => 'ship_zip',
+                :country  => 'ship_country'
+
+        # Overrides Approved URL for return process redirects
+        mapping :return_url, 'x_receipt_link_url'
+
+        # Allow seller to indicate the step of the checkout page
+        # Possible values: ‘review-cart’, ‘shipping-information’, ‘shipping-method’, ‘billing-information’ and ‘payment-method’
+        mapping :purchase_step, 'purchase_step'
+
+        # Allow referral partners to indicate their shopping cart
+        mapping :cart_type, '2co_cart_type'
+
+        def customer(params = {})
+          add_field(mappings[:customer][:email], params[:email])
+          add_field(mappings[:customer][:phone], params[:phone])
+          add_field('card_holder_name', "#{params[:first_name]} #{params[:last_name]}")
+        end
+
+        def shipping_address(params = {})
+          super
+          add_field(mappings[:shipping_address][:name], "#{params[:first_name]} #{params[:last_name]}")
+        end
+
+        # Uses Third Party Cart parameter set to pass in lineitem details.
+        # You must also specify `service.invoice` when using this method.
+        def third_party_cart(params = {})
+          add_field('id_type', '1')
+          (max_existing_line_item_id = form_fields.keys.map do |key|
+            i = key.to_s[/^c_prod_(\d+)/, 1]
+            (i && i.to_i)
+          end.compact.max || 0)
+
+          line_item_id = max_existing_line_item_id + 1
+          params.each do |key, value|
+            add_field("c_#{key}_#{line_item_id}", value)
+          end
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        # message_type - Indicates type of message
+        # message_description - Human readable description of message_type
+        # timestamp - Timestamp of event; format YYYY-MM-DD HH:MM:SS ZZZ
+        # md5_hash - UPPERCASE(MD5_ENCRYPTED(sale_id + vendor_id + invoice_id + Secret Word))
+        # message_id - This number is incremented for each message sent to a given seller.
+        # key_count - Indicates the number of parameters sent in message
+        # vendor_id - Seller account number
+        # sale_id - 2Checkout sale number
+        # sale_date_placed - Date of sale; format YYYY-MM-DD
+        # vendor_order_id - Custom order id provided by seller, if available.
+        # invoice_id - 2Checkout invoice number; Each recurring sale can have several invoices
+        # recurring - recurring=1 if any item on the invoice is a recurring item, 0 otherwise
+        # payment_type - Buyer’s payment method (credit card, online check, paypal ec, OR paypal pay later)
+        # list_currency - 3-Letter ISO code for seller currency
+        # cust_currency - 3-Letter ISO code for buyer currency
+        # auth_exp - The date credit authorization will expire; format YYYY-MM-DD
+        # invoice_status - Status of a transaction (approved, pending, deposited, or declined)
+        # fraud_status - Status of 2Checkout fraud review (pass, fail, or wait); This parameter could be empty.
+        # invoice_list_amount - Total in seller pricing currency; format as appropriate to currency=
+        # invoice_usd_amount - Total in US Dollars; format with 2 decimal places
+        # invoice_cust_amount - Total in buyer currency; format as appropriate to currency=
+        # customer_first_name - Buyer’s first name (may not be available on older sales)
+        # customer_last_name - Buyer’s last name (may not be available on older sales)
+        # customer_name - Buyer's full name (name as it appears on credit card)
+        # customer_email - Buyer's email address
+        # customer_phone - Buyer's phone number; all but digits stripped out
+        # customer_ip - Buyer's IP address at time of sale
+        # customer_ip_country - Country of record for buyer's IP address at time of sale
+        # bill_street_address - Billing street address
+        # bill_street_address2 - Billing street address line 2
+        # bill_city - Billing address city
+        # bill_state - Billing address state or province
+        # bill_postal_code - Billing address postal code
+        # bill_country - 3-Letter ISO country code of billing address
+        # ship_status - not_shipped, shipped, or empty (if intangible / does not need shipped)
+        # ship_tracking_number - Tracking Number as entered in Seller Admin
+        # ship_name - Shipping Recipient’s name (as it should appears on shipping label)
+        # ship_street_address - Shipping street address
+        # ship_street_address2 - Shipping street address line 2
+        # ship_city - Shipping address city
+        # ship_state - Shipping address state or province
+        # ship_postal_code - Shipping address postal code
+        # ship_country - 3-Letter ISO country code of shipping address
+        # item_count - Indicates how many numbered sets of item parameters to expect
+        # item_name_# - Product name
+        # item_id_# - Seller product id
+        # item_list_amount_# - Total in seller pricing currency; format as appropriate to currency
+        # item_usd_amount_# - Total in US Dollars; format with 2 decimal places
+        # item_cust_amount_# - Total in buyer currency; format as appropriate to currency
+        # item_type_# - Indicates if item is a bill or refund; Value will be bill or refund
+        # item_duration_# - Product duration, how long it re-bills for Ex. 1 Year
+        # item_recurrence_# - Product recurrence, how often it re-bills Ex. 1 Month
+        # item_rec_list_amount_# - Product price; format as appropriate to currency
+        # item_rec_status_# - Indicates status of recurring subscription: live, canceled, or completed
+        # item_rec_date_next_# - Date of next recurring installment; format YYYY-MM-DD
+        # item_rec_install_billed_# - The number of successful recurring installments successfully billed
+
+        # INS message type
+        def type
+          params['message_type']
+        end
+
+        # Seller currency sale was placed in
+        def currency
+          params['list_currency']
+        end
+
+        def complete?
+          status == 'Completed'
+        end
+
+        # The value passed with 'merchant_order_id' is passed back as 'vendor_order_id'
+        def item_id
+          params['vendor_order_id'] || params['merchant_order_id']
+        end
+
+        # 2Checkout Sale ID
+        def transaction_id
+          params['sale_id'] || params['order_number']
+        end
+
+        # 2Checkout Invoice ID
+        def invoice_id
+          params['invoice_id']
+        end
+
+        def received_at
+          params['timestamp']
+        end
+
+        #Customer Email
+        def payer_email
+          params['customer_email']
+        end
+
+        # The MD5 Hash
+        def security_key
+          params['md5_hash'] || params['key']
+        end
+
+        # The money amount we received in X.2 decimal.
+        # passback || INS gross amount for new orders || default INS gross
+        def gross
+          params['invoice_list_amount'] || params['total'] || params['item_list_amount_1']
+        end
+
+        # Determine status based on parameter set, if the params include a fraud status we know we're being
+        # notified of the finalization of an order (an INS message)
+        # If the params include 'credit_card_processed' we know we're being notified of a new order being inbound,
+        # which we handle in the deferred demo sale scenario.
+        def status
+          if params['fraud_status'] == 'pass' || params['credit_card_processed'] == 'Y'
+            'Completed'
+          elsif params['fraud_status'] == 'wait'
+            'Pending'
+          else
+            'Failed'
+          end
+        end
+
+        # Secret Word defined in 2Checkout account
+        def secret
+          @options[:credential2]
+        end
+
+        # Checks against MD5 Hash
+        def acknowledge(authcode = nil)
+          return false if security_key.blank?
+          if ins_message?
+            Digest::MD5.hexdigest("#{ transaction_id }#{ params['vendor_id'] }#{ invoice_id }#{ secret }").upcase == security_key.upcase
+          elsif passback?
+            order_number = params['demo'] == 'Y' ? 1 : params['order_number']
+            Digest::MD5.hexdigest("#{ secret }#{ params['sid'] }#{ order_number }#{ gross }").upcase == params['key'].upcase
+          else
+            false
+          end
+        end
+
+        private
+
+        # Parses Header Redirect Query String
+        def parse(post)
+          @raw = post.to_s
+          for line in @raw.split('&')
+            key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+            params[key] = CGI.unescape(value || '')
+          end
+        end
+
+        def ins_message?
+          params.include? 'message_type'
+        end
+
+        def passback?
+          params.include? 'credit_card_processed'
+        end
+      end
+
+      class Return < OffsitePayments::Return
+        # card_holder_name - Provides the customer’s name.
+        # city - Provides the customer’s city.
+        # country - Provides the customer’s country.
+        # credit_card_processed - This parameter will always be passed back as Y.
+        # demo - Defines if an order was live, or if the order was a demo order. If the order was a demo, the MD5 hash will fail.
+        # email - Provides the email address the customer provided when placing the order.
+        # fixed - This parameter will only be passed back if it was passed into the purchase routine.
+        # ip_country - Provides the customer’s IP location.
+        # key - An MD5 hash used to confirm the validity of a sale.
+        # lang - Customer language
+        # merchant_order_id - The order ID you had assigned to the order.
+        # order_number - The 2Checkout order number associated with the order.
+        # invoice_id - The 2Checkout invoice number.
+        # pay_method - Provides seller with the customer’s payment method. CC for Credit Card, PPI for PayPal.
+        # phone - Provides the phone number the customer provided when placing the order.
+        # ship_name - Provides the ship to name for the order.
+        # ship_street_address - Provides ship to address.
+        # ship_street_address2 - Provides more detailed shipping address if this information was provided by the customer.
+        # ship_city - Provides ship to city.
+        # ship_state - Provides ship to state.
+        # ship_zip - Ship Zip
+
+        # Pass Through Products Only
+        # li_#_name - Name of the corresponding lineitem.
+        # li_#_quantity - Quantity of the corresponding lineitem.
+        # li_#_price - Price of the corresponding lineitem.
+        # li_#_tangible - Specifies if the corresponding li_#_type is a tangible or intangible. ‘Y’ OR ‘N’
+        # li_#_product_id - ID of the corresponding lineitem.
+        # li_#_product_description - Description of the corresponding lineitem.
+        # li_#_recurrence - # WEEK | MONTH | YEAR – always singular.
+        # li_#_duration - Forever or # WEEK | MONTH | YEAR – always singular, defaults to Forever.
+        # li_#_startup_fee - Amount in account pricing currency.
+        # li_#_option_#_name - Name of option. 64 characters max – cannot include '<' or '>'.
+        # li_#_option_#_value - Name of option. 64 characters max – cannot include '<' or '>'.
+        # li_#_option_#_surcharge - Amount in account pricing currency.
+
+        #Third Party Cart Only
+        # cart_order_id - The order ID you had assigned to the order
+
+        def initialize(query_string, options = {})
+          super
+          @notification = Notification.new(query_string, options)
+        end
+
+        def success?
+          @notification.status != 'Failed'
+        end
+      end
+    end
+  end
+end