eway_rapid 1.0.0

data/lib/eway_rapid/models/models.rb

@@ -0,0 +1,334 @@
+module EwayRapid
+  module Models
+
+    # Customer's address
+    class Address
+
+      # First line of the street address
+      attr_accessor :street1
+
+      # Second line of the street address
+      attr_accessor :street2
+
+      attr_accessor :city
+      attr_accessor :state
+
+      # Two letter ISO 3166-1 alpha-2 code
+      attr_accessor :country
+
+      attr_accessor :postal_code
+    end
+
+    # Card information
+    class CardDetails
+      attr_accessor :name
+      attr_accessor :number
+      attr_accessor :expiry_month
+      attr_accessor :expiry_year
+      attr_accessor :start_month
+      attr_accessor :start_year
+      attr_accessor :issue_number
+      attr_accessor :cvn
+
+      def self.to_hash(card_details)
+        { Constants::NAME => card_details.name,
+         Constants::NUMBER => card_details.number,
+         Constants::EXPIRY_MONTH => card_details.expiry_month,
+         Constants::EXPIRY_YEAR => card_details.expiry_year,
+         Constants::START_MONTH => card_details.start_month,
+         Constants::START_YEAR => card_details.start_year,
+         Constants::ISSUE_NUMBER => card_details.issue_number,
+         Constants::CVN => card_details.cvn } if card_details
+      end
+
+      def self.from_json(json)
+        hash = JSON.parse(json)
+        from_hash(hash)
+      end
+
+      def self.from_hash(hash)
+        unless hash.nil?
+          card_details = CardDetails.new
+          card_details.name = hash[Constants::NAME]
+          card_details.number = hash[Constants::NUMBER]
+          card_details.expiry_month = hash[Constants::EXPIRY_MONTH]
+          card_details.expiry_year = hash[Constants::EXPIRY_YEAR]
+          card_details.start_month = hash[Constants::START_MONTH]
+          card_details.start_year = hash[Constants::START_YEAR]
+          card_details.issue_number = hash[Constants::ISSUE_NUMBER]
+          card_details.cvn = hash[Constants::CVN]
+          card_details
+        end
+      end
+    end
+
+    # Customer details
+    class Customer
+      attr_accessor :token_customer_id
+      attr_accessor :reference
+      attr_accessor :title
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :company_name
+      attr_accessor :job_description
+      attr_accessor :address
+      attr_accessor :phone
+      attr_accessor :mobile
+      attr_accessor :email
+      attr_accessor :fax
+      attr_accessor :url
+      attr_accessor :comments
+      attr_accessor :card_details
+      attr_accessor :redirect_url
+      attr_accessor :cancel_url
+      attr_accessor :customer_device_ip
+    end
+
+    # Item information
+    class LineItem
+
+      # The stock keeping unit used to identify this line item
+      attr_accessor :sku
+      attr_accessor :description
+      attr_accessor :quantity
+
+      # The unit cost of this line item in cents
+      attr_accessor :unit_cost
+
+      # The tax amount that applies to this line item in cents
+      attr_accessor :tax
+
+      # The total amount (including tax) charged for this line item in the cents
+      attr_accessor :total
+
+      # Set the line item's values so that the total and tax add up
+      # correctly
+      #
+      # @param [Integer] unit_cost
+      # @param [Integer] unit_tax
+      # @param [Integer] quantity
+      def calculate(unit_cost, unit_tax, quantity)
+        if unit_cost && unit_tax && quantity
+          tax = unit_tax * quantity
+          quantity * unit_cost + tax
+        end
+      end
+
+      def self.to_hash(line_item)
+        { Constants::SKU => line_item.sku,
+         Constants::DESCRIPTION => line_item.description,
+         Constants::QUANTITY => line_item.quantity,
+         Constants::UNIT_COST => line_item.unit_cost,
+         Constants::TAX => line_item.tax,
+         Constants::TOTAL => line_item.total } if line_item
+      end
+
+      def self.to_array(array)
+        line_items = []
+        if array
+          array.each {|line_item_hash|
+            obj = to_hash(line_item_hash)
+            line_items.push(obj)
+          }
+        end
+        line_items
+      end
+
+      def self.from_json(json)
+        hash = JSON.parse(json)
+        from_hash(hash)
+      end
+
+      def self.from_hash(hash)
+        line_item = LineItem.new
+        line_item.sku = hash[Constants::SKU]
+        line_item.description = hash[Constants::DESCRIPTION]
+        line_item.quantity = hash[Constants::QUANTITY]
+        line_item.unit_cost = hash[Constants::UNIT_COST]
+        line_item.tax = hash[Constants::TAX]
+        line_item.total = hash[Constants::TOTAL]
+        line_item
+      end
+
+      def self.from_array(array)
+        line_items = Array.new
+        array.each {|line_item_hash|
+          obj = from_hash(line_item_hash)
+          line_items.push(obj)
+        }
+        line_items
+      end
+    end
+
+    # Details of the payment
+    class PaymentDetails
+
+      # The total amount of the transaction in cents
+      attr_accessor :total_amount
+
+      attr_accessor :invoice_number
+      attr_accessor :invoice_description
+      attr_accessor :invoice_reference
+
+      # The ISO 4217 3 character code of the currency that the transaction is
+      # to be processed in (e.g. 'AUD')
+      attr_accessor :currency_code
+    end
+
+    # Combines together all the bank/gateway specific status information for a
+    # transaction
+    class ProcessingDetails
+
+      # The bank's authorization code for the transaction
+      attr_accessor :authorisation_code
+
+      # The bank's Response code
+      attr_accessor :response_code
+
+      # The bank or gateway's Response message
+      attr_accessor :response_message
+    end
+
+    # Contains the high level properties required to process a refund
+    # (or Authorisation Cancel)
+    class Refund
+      attr_accessor :customer
+      attr_accessor :shipping_details
+      attr_accessor :refund_details
+      attr_accessor :line_items
+      attr_accessor :options
+      attr_accessor :device_id
+      attr_accessor :partner_id
+    end
+
+    # Contains the Shipping related information for a transaction
+    class ShippingDetails
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :shipping_method
+      attr_accessor :shipping_address
+      attr_accessor :email
+      attr_accessor :phone
+      attr_accessor :fax
+    end
+
+    # The details of a transaction that will be processed either via the responsive
+    # shared page, by transparent redirect, by Direct, or one that is captured from
+    # a previous Authorisation transaction
+    class Transaction
+
+      # The type of transaction being performed - use Enums::TransactionType
+      attr_accessor :transaction_type
+
+      # Set to true to capture funds immediately, false to authorise only
+      attr_accessor :capture
+
+      # Customer details for the transaction
+      attr_accessor :customer
+
+      # Shipping details fo the transaction
+      attr_accessor :shipping_details
+
+      # Payment details for the transaction
+      attr_accessor :payment_details
+
+      # Array of line items for the transaction
+      attr_accessor :line_items
+
+      # Array of options to pass to eWAY
+      attr_accessor :options
+
+      # The identification name/number for the device or application processing the transaction
+      attr_accessor :device_id
+
+      # The partner ID generated from an eWAY partner agreement
+      attr_accessor :partner_id
+
+      # The wallet ID of a third party wallet used for a payment
+      attr_accessor :third_party_wallet_id
+
+      # The Transaction ID of an authorisation to capture
+      attr_accessor :auth_transaction_id
+
+      # The URL that the shared page redirects to after a payment is processed
+      # (transparent redirect & responsive shared page only)
+      attr_accessor :redirect_url
+
+      # The URL that the shared page redirects to if a customer cancels the transaction
+      # (responsive shared page only)
+      attr_accessor :cancel_url
+
+      # Setting this to +true+ will process a PayPal Checkout payment.
+      attr_accessor :checkout_payment
+
+      # The URL that the customer is to be returned to after logging in to their PayPal account.
+      # (transparent redirect & responsive shared page with PayPal Checkout only)
+      attr_accessor :checkout_url
+
+      # Set the theme of the Responsive Shared Page from 12 available themes
+      attr_accessor :custom_view
+
+      # Short text description to be placed under the logo on the Responsive Shared Page
+      attr_accessor :header_text
+
+      # Language code determines the language that the shared page will be displayed in.
+      # One of: EN (English, default), ES (Spanish)
+      attr_accessor :language
+
+      # When set to false, cardholders will be able to edit the information on the Responsive Shared Page
+      attr_accessor :customer_read_only
+
+      # Set whether the customer's phone number should be confirmed using Beagle Verify
+      attr_accessor :verify_customer_phone
+
+      # Set whether the customer's email should be confirmed using Beagle Verify
+      attr_accessor :verify_customer_email
+
+      # The URL of the merchant's logo to display on the Responsive Shared Page
+      attr_accessor :logo_url
+
+      alias_method :customer_read_only?, :customer_read_only
+      alias_method :checkout_payment?, :checkout_payment
+      alias_method :verify_customer_phone?, :verify_customer_phone
+      alias_method :verify_customer_email?, :verify_customer_email
+
+      def initialize
+        @capture = true
+      end
+    end
+
+    # Contains the status information for a transaction
+    class TransactionStatus
+      attr_accessor :transaction_id
+      attr_accessor :total
+      attr_accessor :status
+      attr_accessor :captured
+      attr_accessor :beagle_score
+      attr_accessor :fraud_action
+      attr_accessor :verification_result
+      attr_accessor :processing_details
+
+      alias_method :status?, :status
+    end
+
+    # Contains the result of all the Beagle and Payment provider verification
+    class VerificationResult
+      # Currently unused
+      attr_accessor :cvn
+      # Currently unused
+      attr_accessor :address
+      # Currently unused
+      attr_accessor :email
+      # Currently unused
+      attr_accessor :mobile
+      # Currently unused
+      attr_accessor :phone
+
+      # The result of the Beagle Verify email verification
+      attr_accessor :beagle_email
+
+      # The result of the Beagle Verify phone verification
+      attr_accessor :beagle_phone
+    end
+  end
+end

data/lib/eway_rapid/output/create_transaction_response.rb

@@ -0,0 +1,24 @@
+module EwayRapid
+  # Create transaction response
+  class CreateTransactionResponse < ResponseOutput
+
+    # The transaction as returned by Rapid API.
+    attr_accessor :transaction
+
+    # Contains transaction status information
+    attr_accessor :transaction_status
+
+    # URL to the Responsive Shared Page that the cardholder's browser should
+    # be redirected to (Only for Responsive Shared)
+    attr_accessor :shared_payment_url
+
+    # URL that the merchant's credit card form should post to to complete
+    # payment (Only for Transparent Redirect)
+    attr_accessor :form_action_url
+
+    # An AccessCode for this transaction (Used with Transparent Redirect
+    # and Responsive Shared)
+    attr_accessor :access_code
+
+  end
+end

data/lib/eway_rapid/output/query_customer_response.rb

@@ -0,0 +1,25 @@
+module EwayRapid
+  # Query customer response data
+  class QueryCustomerResponse < ResponseOutput
+    attr_accessor :token_customer_id
+    attr_accessor :state
+    attr_accessor :postal_code
+    attr_accessor :email
+    attr_accessor :reference
+    attr_accessor :title
+    attr_accessor :first_name
+    attr_accessor :last_name
+    attr_accessor :company_name
+    attr_accessor :job_description
+    attr_accessor :street1
+    attr_accessor :street2
+    attr_accessor :city
+    attr_accessor :phone
+    attr_accessor :mobile
+    attr_accessor :url
+    attr_accessor :card_detail
+    attr_accessor :country
+    attr_accessor :comments
+    attr_accessor :fax
+  end
+end

data/lib/eway_rapid/output/query_transaction_response.rb

@@ -0,0 +1,16 @@
+module EwayRapid
+  #  Query transaction response
+  class QueryTransactionResponse < ResponseOutput
+
+    # The Request as returned by Rapid API. Where a token customer is created as
+    # result of the transaction, then the Customer in this type will contain the
+    # Customer Token ID
+    attr_accessor :transaction
+
+    # Contains transaction status information
+    attr_accessor :transaction_status
+
+    # AccessCode for this transaction
+    attr_accessor :access_code
+  end
+end

data/lib/eway_rapid/output/refund_response.rb

@@ -0,0 +1,9 @@
+module EwayRapid
+  # Refund response
+  class RefundResponse < ResponseOutput
+    attr_accessor :refund
+
+    # Contains transaction status information
+    attr_accessor :transaction_status
+  end
+end

data/lib/eway_rapid/output/response_output.rb

@@ -0,0 +1,14 @@
+module EwayRapid
+  # Base class for the output data class inherits
+  class ResponseOutput
+
+    # List of all validation, processing, fraud or system errors that occurred
+    # when processing this request.
+    attr_accessor :errors
+
+    def initialize(*args, &block)
+      super
+      @errors = []
+    end
+  end
+end

data/lib/eway_rapid/rapid_client.rb

@@ -0,0 +1,444 @@
+module EwayRapid
+
+  # This class abstracts the Rapid API 3.1 functions so that it can be consumed
+  # by Ruby applications
+  #
+  # @author eWAY
+  class RapidClient
+
+    # @param [String] api_key eWAY Rapid API key
+    # @param [String] password eWAY Rapid API password
+    # @param [String] rapid_endpoint eWAY Rapid endpoint - either Sandbox or Production
+    def initialize(api_key, password, rapid_endpoint)
+      @logger = RapidLogger.logger
+      @logger.info "Initiate client with end point: #{rapid_endpoint}" if @logger
+
+      @api_key = api_key
+      @password = password
+      @rapid_endpoint = rapid_endpoint
+
+      validate_api_param
+    end
+
+    # Changes the API Key and Password the Client is configured to use
+    #
+    # @param [String] api_key eWAY Rapid API key
+    # @param [String] password eWAY Rapid API password
+    def set_credentials(api_key, password)
+      @api_key = api_key
+      @password = password
+
+      validate_api_param
+    end
+
+    # Creates a transaction either using an authorisation, the responsive shared
+    # page, transparent redirect, or direct as the source of funds
+    #
+    # @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc)
+    # @param [Models::Transaction] transaction Request containing the transaction details
+    # @return [CreateTransactionResponse] CreateTransactionResponse
+    def create_transaction(payment_method, transaction)
+      unless get_valid?
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), CreateTransactionResponse)
+      end
+      begin
+        case payment_method
+        when Enums::PaymentMethod::DIRECT
+          url = @rapid_endpoint + Constants::DIRECT_PAYMENT_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::TransactionProcess::TransDirectPaymentMsgProcess.create_request(transaction)
+          response = Message::TransactionProcess::TransDirectPaymentMsgProcess.send_request(url, @api_key, @password, request)
+          Message::TransactionProcess::TransDirectPaymentMsgProcess.make_result(response)
+        when Enums::PaymentMethod::RESPONSIVE_SHARED
+          url = @rapid_endpoint + Constants::RESPONSIVE_SHARED_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::TransactionProcess::TransResponsiveSharedMsgProcess.create_request(transaction)
+          response = Message::TransactionProcess::TransResponsiveSharedMsgProcess.send_request(url, @api_key, @password, request)
+          Message::TransactionProcess::TransResponsiveSharedMsgProcess.make_result(response)
+        when Enums::PaymentMethod::TRANSPARENT_REDIRECT
+          url = @rapid_endpoint + Constants::TRANSPARENT_REDIRECT_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::TransactionProcess::TransTransparentRedirectMsgProcess.create_request(transaction)
+          response = Message::TransactionProcess::TransTransparentRedirectMsgProcess.send_request(url, @api_key, @password, request)
+          Message::TransactionProcess::TransTransparentRedirectMsgProcess.make_result(response)
+        when Enums::PaymentMethod::WALLET
+          if transaction.capture
+            url = @rapid_endpoint + Constants::DIRECT_PAYMENT_METHOD_NAME + Constants::JSON_SUFFIX
+
+            request = Message::TransactionProcess::TransDirectPaymentMsgProcess.create_request(transaction)
+            response = Message::TransactionProcess::TransDirectPaymentMsgProcess.send_request(url, @api_key, @password, request)
+            Message::TransactionProcess::TransDirectPaymentMsgProcess.make_result(response)
+          else
+            url = @rapid_endpoint + Constants::CAPTURE_PAYMENT_METHOD
+
+            request = Message::TransactionProcess::CapturePaymentMsgProcess.create_request(transaction)
+            response = Message::TransactionProcess::CapturePaymentMsgProcess.send_request(url, @api_key, @password, request)
+            Message::TransactionProcess::CapturePaymentMsgProcess.make_result(response)
+          end
+        when Enums::PaymentMethod::AUTHORISATION
+          url = @rapid_endpoint + Constants::CAPTURE_PAYMENT_METHOD
+
+          request = Message::TransactionProcess::CapturePaymentMsgProcess.create_request(transaction)
+          response = Message::TransactionProcess::CapturePaymentMsgProcess.send_request(url, @api_key, @password, request)
+          Message::TransactionProcess::CapturePaymentMsgProcess.make_result(response)
+        else
+          make_response_with_exception(Exceptions::ParameterInvalidException.new('Unsupported payment type'), CreateTransactionResponse)
+        end
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, CreateTransactionResponse)
+      end
+    end
+
+    # Gets transaction details given an eWAY Transaction ID
+    #
+    # @param [Integer] transaction_id eWAY Transaction ID
+    # @return [QueryTransactionResponse]
+    def query_transaction_by_id(transaction_id)
+      query_transaction_by_access_code(transaction_id.to_s)
+    end
+
+    # Gets transaction details given an access code
+    #
+    # @param [String] access_code Access code for the transaction to query
+    # @return [QueryTransactionResponse]
+    def query_transaction_by_access_code(access_code)
+      query_transaction_with_path(access_code, Constants::TRANSACTION_METHOD)
+    end
+
+    # Query a transaction by one of four properties transaction id, access
+    # code, invoice number, invoice reference
+    #
+    # @param [Enums::TransactionFilter] filter Filter definition for searching
+    def query_transaction_by_filter(filter)
+      index_of_value = filter.calculate_index_of_value
+      if index_of_value.nil?
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('Invalid transaction filter'), QueryTransactionResponse)
+      end
+
+      case index_of_value
+      when Enums::TransactionFilter::TRANSACTION_ID_INDEX
+        query_transaction_by_id(filter.transaction_id.to_s)
+      when Enums::TransactionFilter::ACCESS_CODE_INDEX
+        query_transaction_by_access_code(filter.access_code)
+      when Enums::TransactionFilter::INVOICE_NUMBER_INDEX
+        query_transaction_with_path(filter.invoice_number, Constants::TRANSACTION_METHOD + '/' + Constants::TRANSACTION_QUERY_WITH_INVOICE_NUM_METHOD)
+      when Enums::TransactionFilter::INVOICE_REFERENCE_INDEX
+        query_transaction_with_path(filter.invoice_reference, Constants::TRANSACTION_METHOD + '/' + Constants::TRANSACTION_QUERY_WITH_INVOICE_REF_METHOD)
+      else
+        make_response_with_exception(Exceptions::APIKeyInvalidException.new('Invalid transaction filter'), QueryTransactionResponse)
+      end
+    end
+
+    # Refunds all or part of a transaction
+    #
+    # @param [Models::Refund] refund contains information to refund
+    # @return [RefundResponse]
+    def refund(refund)
+      unless @is_valid
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), RefundResponse)
+      end
+
+      begin
+        url = @rapid_endpoint + Constants::TRANSACTION_METHOD
+
+        request = Message::RefundProcess::RefundMsgProcess.create_request(refund)
+        response = Message::RefundProcess::RefundMsgProcess.send_request(url, @api_key, @password, request)
+        Message::RefundProcess::RefundMsgProcess.make_result(response)
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, RefundResponse)
+      end
+    end
+
+    # Cancel a non-captured transaction (an authorisation)
+    #
+    # @param [Models::Refund] refund contains transaction to cancel
+    # @return [RefundResponse]
+    def cancel(refund)
+      unless @is_valid
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), RefundResponse)
+      end
+      begin
+        url = @rapid_endpoint + Constants::CANCEL_AUTHORISATION_METHOD
+
+        request = Message::RefundProcess::CancelAuthorisationMsgProcess.create_request(refund)
+        response = Message::RefundProcess::CancelAuthorisationMsgProcess.send_request(url, @api_key, @password, request)
+        Message::RefundProcess::CancelAuthorisationMsgProcess.make_result(response)
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, RefundResponse)
+      end
+    end
+
+    # Creates a token customer to store card details in the secure eWAY Vault
+    # for charging later
+    #
+    # @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc).
+    # @param [Models::Customer] customer The customer's details
+    # @return [CreateCustomerResponse]
+    def create_customer(payment_method, customer)
+      unless get_valid?
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), CreateCustomerResponse)
+      end
+      begin
+        case payment_method
+        when Enums::PaymentMethod::DIRECT
+          url = @rapid_endpoint + Constants::DIRECT_PAYMENT_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::CustomerProcess::CustDirectPaymentMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustDirectPaymentMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustDirectPaymentMsgProcess.make_result(response)
+        when Enums::PaymentMethod::RESPONSIVE_SHARED
+          url = @rapid_endpoint + Constants::RESPONSIVE_SHARED_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::CustomerProcess::CustResponsiveSharedMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustResponsiveSharedMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustResponsiveSharedMsgProcess.make_result(response)
+        when Enums::PaymentMethod::TRANSPARENT_REDIRECT
+          url = @rapid_endpoint + Constants::TRANSPARENT_REDIRECT_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::CustomerProcess::CustTransparentRedirectMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustTransparentRedirectMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustTransparentRedirectMsgProcess.make_result(response)
+        else
+          make_response_with_exception(Exceptions::ParameterInvalidException.new('Unsupported payment type'), CreateCustomerResponse)
+        end
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, CreateCustomerResponse)
+      end
+    end
+
+    # Updates an existing token customer for the merchant in their eWAY account.
+    #
+    # @param [Enums::PaymentMethod] payment_method Describes where the card details will be coming from for this transaction (Direct, Responsive Shared, Transparent Redirect etc).
+    # @param [Models::Customer] customer The customer's details
+    # @return [CreateCustomerResponse]
+    def update_customer(payment_method, customer)
+      unless get_valid?
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), CreateCustomerResponse)
+      end
+      begin
+        case payment_method
+        when Enums::PaymentMethod::DIRECT
+          url = @rapid_endpoint + Constants::DIRECT_PAYMENT_METHOD_NAME + Constants::JSON_SUFFIX
+          request = Message::CustomerProcess::CustDirectUpdateMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustDirectUpdateMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustDirectUpdateMsgProcess.make_result(response)
+        when Enums::PaymentMethod::RESPONSIVE_SHARED
+          url = @rapid_endpoint + Constants::RESPONSIVE_SHARED_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::CustomerProcess::CustResponsiveUpdateMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustResponsiveUpdateMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustResponsiveUpdateMsgProcess.make_result(response)
+        when Enums::PaymentMethod::TRANSPARENT_REDIRECT
+          url = @rapid_endpoint + Constants::TRANSPARENT_REDIRECT_METHOD_NAME + Constants::JSON_SUFFIX
+
+          request = Message::CustomerProcess::CustTransparentUpdateMsgProcess.create_request(customer)
+          response = Message::CustomerProcess::CustTransparentUpdateMsgProcess.send_request(url, @api_key, @password, request)
+          Message::CustomerProcess::CustTransparentUpdateMsgProcess.make_result(response)
+        else
+          return make_response_with_exception(Exceptions::ParameterInvalidException.new('Unsupported payment type'), CreateCustomerResponse)
+        end
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, CreateCustomerResponse)
+      end
+    end
+
+    # Returns the details of a Token Customer. This includes the masked card information
+    # for displaying in a UI
+    #
+    # @param [Integer] token_customer_id eWAY Token Customer ID to look up.
+    # @return [QueryCustomerResponse]
+    def query_customer(token_customer_id)
+      @logger.debug('Query customer with id:' + token_customer_id.to_s) if @logger
+      unless @is_valid
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), QueryCustomerResponse)
+      end
+      begin
+        url = @rapid_endpoint + Constants::DIRECT_CUSTOMER_SEARCH_METHOD + Constants::JSON_SUFFIX
+        url = URI.encode(url)
+
+        request = Message::CustomerProcess::QueryCustomerMsgProcess.create_request(token_customer_id.to_s)
+        response = Message::CustomerProcess::QueryCustomerMsgProcess.send_request(url, @api_key, @password, request)
+        Message::CustomerProcess::QueryCustomerMsgProcess.make_result(response)
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, QueryCustomerResponse)
+      end
+    end
+
+    # Translate an error code to a user friendly message
+    #
+    # @param [String] code The code to translate
+    # @param [String] language The 2 letter code for the language to translate to (only en at this time)
+    # @return [String] Error message
+    def self.user_display_message(code, language = 'en')
+      find_error_code(code, language)
+    end
+
+    # Gets the valid status of this Rapid client
+    #
+    # @return Rapid Client status
+    def get_valid?
+      @is_valid
+    end
+
+    # Returns all errors related to the query request of this client
+    #
+    # @return List of error codes
+    def get_errors
+      @list_error || []
+    end
+
+    private
+
+    # Perform a transaction query with the given path
+    #
+    # @param [String] request the transaction identifier to query
+    # @param [String] request_path the path to use for the query
+    # @return [QueryTransactionResponse]
+    def query_transaction_with_path(request, request_path)
+      unless @is_valid
+        return make_response_with_exception(Exceptions::APIKeyInvalidException.new('API key, password or Rapid endpoint missing or invalid'), QueryTransactionResponse)
+      end
+      begin
+        if request.nil? || request == ''
+          url = @rapid_endpoint + request_path + '/' + '0'
+        else
+          url = @rapid_endpoint + request_path + '/' + request
+        end
+        url = URI.encode(url)
+
+        response = Message::TransactionProcess::TransQueryMsgProcess.process_post_msg(url, @api_key, @password)
+        Message::TransactionProcess::TransQueryMsgProcess.make_result(response)
+      rescue => e
+        @logger.error(e.to_s) if @logger
+        make_response_with_exception(e, QueryTransactionResponse)
+      end
+    end
+
+    # Finds an error code from the properties file
+    #
+    # @param [String] code
+    # @return [String] the error code
+    def self.find_error_code(code, language)
+      error_file = 'err_code_resource_' + language + '.yml'
+      begin
+        property_array = YAML.load_file(File.join(File.dirname(__FILE__), 'resources', error_file))
+        property_array.each do |h|
+          if code == h.keys.first
+            return h[h.keys.first]
+          end
+        end
+        return code
+      rescue
+        @logger.error "Load resource from file: #{error_file} error"  if @logger
+        return ''
+      end
+    end
+
+    # Validates the Rapid API key, password and endpoint
+    def validate_api_param
+      set_valid(true)
+      if @api_key.nil? || @api_key.empty? || @password.nil? || @password.empty?
+        add_error_code(Constants::API_KEY_INVALID_ERROR_CODE)
+        set_valid(false)
+      end
+      if @rapid_endpoint.nil? || @rapid_endpoint.empty?
+        add_error_code(Constants::LIBRARY_NOT_HAVE_ENDPOINT_ERROR_CODE)
+        set_valid(false)
+      end
+      if @is_valid
+        begin
+          parser_endpoint_to_web_url
+          if !@list_error.nil?
+            @list_error.clear
+          end
+          set_valid(true)
+          @logger.info "Initiate client [#{@rapid_endpoint}] successful!" if @logger
+        rescue => e
+          @logger.error "Error setting Rapid endpoint #{e.backtrace.inspect}" if @logger
+          set_valid(false)
+          add_error_code(Constants::LIBRARY_NOT_HAVE_ENDPOINT_ERROR_CODE)
+        end
+      else
+        @logger.warn "Invald parameter passed to Rapid client" if @logger
+      end
+    end
+
+    # Converts an endpoint string to a URL
+    def parser_endpoint_to_web_url
+      # @type [String]
+      prop_name = nil
+      if Constants::RAPID_ENDPOINT_PRODUCTION.casecmp(@rapid_endpoint).zero?
+        prop_name = Constants::GLOBAL_RAPID_PRODUCTION_REST_URL_PARAM
+      elsif Constants::RAPID_ENDPOINT_SANDBOX.casecmp(@rapid_endpoint).zero?
+        prop_name = Constants::GLOBAL_RAPID_SANDBOX_REST_URL_PARAM
+      end
+      if prop_name.nil?
+        set_web_url(@rapid_endpoint)
+      else
+        property_array = YAML.load_file(File.join(File.dirname(__FILE__), 'resources', 'rapid-api.yml'))
+        property_array.each do |h|
+          if prop_name.casecmp(h.keys.first).zero?
+            set_web_url(h[h.keys.first])
+          end
+        end
+        if @web_url.nil?
+          fail Exception, "The endpoint #{prop_name} is invalid."
+        end
+      end
+      # verify_endpoint_url(@web_url) # this is unreliable
+    end
+
+    # Checks the Rapid endpoint url
+    #
+    # @param [String] web_url
+    def verify_endpoint_url(web_url)
+      begin
+        resource = RestClient::Resource.new web_url
+        resource.get
+      rescue RestClient::Exception => e
+        if e.http_code == 404
+          set_valid(false)
+        end
+      end
+    end
+
+    # @param [String] error_code
+    def add_error_code(error_code)
+      if error_code
+        if @list_error.nil?
+          @list_error = []
+          @list_error.push(error_code)
+        else
+          unless @list_error.include? error_code
+            @list_error.push(error_code)
+          end
+        end
+      end
+    end
+
+    # @param [Boolean] is_valid
+    def set_valid(is_valid)
+      @is_valid = is_valid
+    end
+
+    # @param [String] web_url
+    def set_web_url(web_url)
+      @web_url = web_url
+    end
+
+    # @param [RapidSdkException] rapid_exception Exception to output
+    # @param [ResponseOutput] klass Output class to use for response
+    # @return [ResponseOutput]
+    def make_response_with_exception(rapid_exception, klass)
+      response_output = klass.new
+      response_output.errors.push(rapid_exception.error_code)
+      response_output
+    end
+  end
+end