activemerchant-payline 0.1.9

data/lib/active_merchant/billing/gateways/payline/payline_constants.rb

@@ -0,0 +1,83 @@
+require_relative '../../iso_4217_currency_codes'
+
+module PaylineConstants
+
+  WDSL_URL = 'https://services.payline.com/V4/services/WebPaymentAPI?wsdl'.freeze
+  WDSL_TEST_URL = 'https://homologation.payline.com/V4/services/WebPaymentAPI?wsdl'.freeze
+
+  WEB_API_VERSION = '16'.freeze
+
+  IMPL_NAMESPACE = 'http://impl.ws.payline.experian.com'.freeze
+  OBJ_NAMESPACE = 'http://obj.ws.payline.experian.com'.freeze
+
+  LOG_FILTERED_TAGS = %w( number cvx ).freeze
+
+  DATE_FORMAT = "%d/%m/%Y".freeze
+  DATETIME_FORMAT = "#{DATE_FORMAT} %H:%M".freeze
+
+  ACTION_CODES = {
+    :authorization => 100, # Authorization
+    :purchase      => 101, # Authorization + Validation
+    :capture       => 201  # Validation
+  }.freeze
+
+  CARD_BRAND_CODES = Hash.new('CB').update(
+    'visa'             => 'VISA',
+    'master'           => 'MASTERCARD',
+    'american_express' => 'AMEX',
+    'diners_club'      => 'DINERS',
+    'jcb'              => 'JCB',
+    'switch'           => 'SWITCH',
+    'maestro'          => 'MAESTRO'
+  ).freeze
+
+  EXPIRATION_DATE_FORMAT = "%.2d%.2d".freeze
+
+  PAYMENT_MODES = {
+    :direct       => 'CPT',
+    :deffered     => 'DIF',
+    :installments => 'NX',
+    :recurrent    => 'REC'
+  }.freeze
+
+  # locale => ISO 639-2 code
+  LANGUAGE_CODES = {
+    'fr' => 'fre',
+    'en' => 'eng',
+    'es' => 'spa',
+    'it' => 'ita',
+    'pt' => 'por',
+    'de' => 'ger',
+    'nl' => 'dut',
+    'fi' => 'fin'
+  }.freeze
+
+  RECURRING_FREQUENCIES = {
+    :daily       => 10,
+    :weekly      => 20,
+    :fortnightly => 30,
+    :monthly     => 40,
+    :bimonthly   => 50,
+    :quarterly   => 60,
+    :semiannual  => 70,
+    :yearly      => 80,
+    :biannual    => 90
+  }.freeze
+
+  SSL = 'SSL'.freeze
+
+  SUCCESS_MESSAGES = {
+    # Card & Check
+    "00000" => "Transaction approved",
+    "01001" => "Transaction approved but required a verification by merchant",
+    # Wallet
+    "02500" => "Operation successful",
+    "02501" => "Operation successful but wallet will expire",
+    "02517" => "Cannot disable some wallet(s)",
+    "02520" => "Cannot enable some wallet(s)",
+    # Cancelling & Reauthorizing
+    "02616" => "Error while creating the wallet"
+  }.freeze
+
+  SUCCESS_CODES = SUCCESS_MESSAGES.keys.freeze
+end

data/lib/active_merchant/billing/gateways/payline/payline_direct_api.rb

@@ -0,0 +1,78 @@
+require_relative 'payline_common'
+include ActiveMerchant::Billing::PaylineCommon
+
+module ActiveMerchant
+  module Billing
+    module PaylineDirectAPI
+      # :amount [Number] Amount of transaction (required)
+      # :credit_card [Hash] Credit card informations - Must contain number, brand, month, year, verification_value (required)
+      # :order_ref [String] Order ref (required)
+      # :currency [String] Default currency code is default_currency
+      # :action [String] Default is :purchase (101 (Authorization + Validation))
+      # :mode [String] Default is :direct ("CPT")
+      # Optional parameters: media
+      # Optional objects: buyer, private_data, contract_number_wallet
+      def do_authorization(amount, credit_card, options = {})
+        #requires!(options, :order_id, :credit_card)
+        currency = currency_code(options[:currency])
+        action = options[:action] || :authorization
+
+        optional_parameters = ['media']
+
+        data = merged_data([
+          # Required parameters
+          add_payment(amount, currency, action, options[:mode], options[:payment]),
+          add_bank_account_data(options[:bank_account_data]), # Doest seem required
+          add_credit_card(credit_card),
+          add_order(amount, currency, options[:order_ref], options[:order]),
+          # Optional parameters
+          add_buyer(options[:buyer]),
+          add_owner(options[:owner]),
+          add_private_data(options[:private_data]),
+          add_authentication_3D_secure(options[:authentication_3D_secure]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_authorization, data
+      end
+      alias_method :authorize, :do_authorization
+
+      # payment_record_id [String] Payment record ID, can be retrieved after a do_recurrent_wallet_payment request (required)
+      def get_payment_record(payment_record_id)
+        payment_record_request :get, payment_record_id
+      end
+
+      # payment_record_id [String] Payment record ID, can be retrieved after a do_recurrent_wallet_payment request (required)
+      def disable_payment_record(payment_record_id)
+        payment_record_request :disable, payment_record_id
+      end
+
+      protected
+        def payment_record_request(method_name, payment_record_id)
+          data = { paymentRecordId: payment_record_id }
+          direct_api_request :"#{method_name}_payment_record", data
+        end
+
+        def add_bank_account_data(bank_account_data)
+          if bank_account_data
+            optional_parameters = {
+              countryCode: bank_account_data[:country_code],
+              bankCode: bank_account_data[:bank_code],
+              accountNumber: bank_account_data[:account_number],
+              key: bank_account_data[:key]
+            }
+
+            parameters = [add_optional_parameters(bank_account_data, optional_parameters)]
+
+            data = { bankAccountData: merged_data(parameters) }
+          end
+
+          data ||= {}
+        end
+
+        def expiration_date(month, year)
+          EXPIRATION_DATE_FORMAT % [month, year.to_s[-2..-1]]
+        end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/payline/payline_management_payment_api.rb

@@ -0,0 +1,154 @@
+require_relative 'payline_common'
+include ActiveMerchant::Billing::PaylineCommon
+
+module ActiveMerchant
+  module Billing
+    module PaylineManagementPaymentAPI
+
+      # Optional parameters: comment, transaction_id, order_id
+      # Required objects: payment, creditor
+      def do_bank_transfer(amount, options = {})
+        optional_parameters = ['comment', 'transactionID', 'orderID']
+
+        data = merged_data([
+          # Required parameters
+          add_payment(amount, currency_code(options[:currency]), options[:action], options[:mode], options[:payment]),
+          add_creditor(options[:creditor]),
+          # Optional parameters
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_bank_transfer, data
+      end
+
+      # :amount [Number] Amount of transaction (required)
+      # :transaction_id [String] Transaction id (required)
+      # :currency [String] Default currency code is default_currency
+      # :mode [String] CPT for Full (default) / DIF for Deferred/ NX for N instalments / REC for Recurring
+      # Optional parameters: sequence_number, media
+      # Optional objects: payment
+      def do_capture(amount, transaction_id, options = {})
+        optional_parameters = ['sequenceNumber', 'media']
+        required_parameters = { transactionID: transaction_id }
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          add_payment(amount, currency_code(options[:currency]), 201, options[:mode], options[:payment]),
+          # Optional parameters
+          add_private_data(options[:private_data]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_capture, data
+      end
+      alias_method :capture, :do_capture
+
+      # Optional parameters: comment, media
+      # Required objects: payment, card, order
+      # Optional objects: buyer, owner, private_data, optional_parameters
+      def do_credit(amount, credit_card, order_ref, options = {})
+        optional_parameters = ['comment', 'media']
+
+        data = merged_data([
+          # Required parameters
+          add_payment(amount, currency_code(options[:currency]), 422, options[:mode], options[:payment]),
+          add_credit_card(credit_card),
+          add_order(amount, currency_code(options[:currency]), order_ref, options[:order]),
+          # Optional parameters
+          add_buyer(options[:buyer]),
+          add_owner(options[:owner]),
+          add_private_data(options[:private_data]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_credit, data
+      end
+
+      # Optional parameters: media
+      # Required objects: payment, card, order, authorization
+      # Optional parameters: buyer, owner, private_data
+      def do_debit(amount, credit_card, order_ref, options = {})
+        optional_parameters = ['media']
+
+        data = merged_data([
+          # Required parameters
+          add_payment(amount, currency_code(options[:currency]), 204, options[:mode], options[:payment]),
+          add_credit_card(credit_card),
+          add_order(amount, currency_code(options[:currency]), order_ref, options[:order]),
+          add_authorization(options[:authorization]), # Seems to be required
+          # Optional parameters
+          add_buyer(options[:buyer]),
+          add_owner(options[:owner]),
+          add_private_data(options[:private_data]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_debit, data
+      end
+
+      # :amount [Number] Amount of transaction
+      # :transaction_id [String] Transaction id
+      # :currency [String] Default currency code is default_currency
+      # :mode [String] CPT for Full (default) / DIF for Deferred/ NX for N instalments / REC for Recurring
+      # Optional parameters: comment, sequence_number, media
+      # Optional objects: payment
+      def do_refund(amount, transaction_id, options = {})
+        optional_parameters = ['comment', 'sequenceNumber', 'media']
+        required_parameters = { transactionID: transaction_id }
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          add_payment(amount, currency_code(options[:currency]), 421, options[:mode], options[:payment]),
+          # Optional parameters
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_refund, data
+      end
+      alias_method :refund, :do_refund
+
+      # Transaction_id [String] Transaction id (required)
+      # Optional parameters: comment, sequence_number, media
+      def do_reset(transaction_id, options = {})
+        optional_parameters = ['comment', 'sequenceNumber', 'media']
+        required_parameters = { transactionID: transaction_id }
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          # Optional parameters
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_reset, data
+      end
+      alias_method :void, :do_reset
+
+      private
+        def add_creditor(creditor_data)
+          if creditor_data
+            required_parameters = {
+              bic: creditor_data[:bic],
+              iban: creditor_data[:iban],
+              name: creditor_data[:name]
+            }
+          end
+          data = { creditor: required_parameters }
+        end
+
+        def add_authorization(authorization_data)
+          if authorization_data
+            required_parameters = {
+              number: authorization_data[:number],
+              date: authorization_data[:date]
+            }
+          end
+          required_parameters ||= {}
+
+          data = {authorization: required_parameters}
+        end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/payline/payline_status_api.rb

@@ -0,0 +1,36 @@
+require_relative 'payline_common'
+include ActiveMerchant::Billing::PaylineCommon
+
+module ActiveMerchant
+  module Billing
+    module PaylineStatusAPI
+      # Required parameter: transaction_id
+      # Optional parameters: order_ref, start_date, end_date, transaction_history, archive_search
+      def get_transaction_details(transaction_id, options={})
+        optional_parameters = ['orderRef', 'startDate', 'endDate', 'transactionHistory', 'archiveSearch']
+        required_parameters = { transaction_id: transaction_id }
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          # Optional parameters
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        extended_api_request :get_transaction_details, data
+      end
+
+      protected
+        def extended_api_request(method_name, data)
+          savon_request(extended_api_savon_client, method_name, data)
+        end
+
+        def extended_api_savon_client
+          url = test? ? self.extended_test_payment_url : self.extended_payment_url
+
+          @extended_api_savon_client ||= create_savon_client(url)
+        end
+
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/payline/payline_wallet_management.rb

@@ -0,0 +1,249 @@
+require_relative 'payline_common'
+include ActiveMerchant::Billing::PaylineCommon
+
+module ActiveMerchant
+  module Billing
+    module PaylineWalletManagementAPI
+
+      # Optional parameters: media
+      # Required objects: Wallet
+      # Optional objects: buyer, owner,  private_data, authentication_3D_secure, contract_number_wallet
+      def create_wallet(wallet, options = {})
+        optional_parameters = ['media']
+        data = merged_data([
+          # Required parameters
+          add_wallet(wallet),
+          # Option parameters,
+          add_buyer(options[:buyer]),
+          add_owner(options[:owner]),
+          add_private_data(options[:private_data]),
+          add_authentication_3D_secure(options[:authentication_3D_secure]),
+          add_optional_parameters(options, optional_parameters),
+          add_contract_number_wallet_list(options[:contract_number_wallet])
+        ])
+
+        direct_api_request :create_wallet, data
+      end
+
+      def disable_wallet(contract_number, wallet_id, options={})
+        optional_parameters = ['cardInd']
+        required_parameters = { contractNumber: contract_number}
+
+        data = merged_data([
+          required_parameters,
+          add_optional_parameters(options, optional_parameters),
+          add_wallet_id_list(wallet_id)
+        ])
+
+        direct_api_request :disable_wallet, data
+      end
+
+      # :wallet_id [String] Wallet ID
+      # :order_ref [String] Order ID (required)
+      # Required parameters: order_ref, wallet_id, buyer
+      # Optional parameters: card_ind, media, wallet_cvx
+      # Required objects: order, payment, authentication_3D_secure
+      # Optional parameters: private_data
+      def do_immediate_wallet_payment(amount, wallet_id, options = {})
+        currency = currency_code(options[:currency])
+
+        optional_parameters = ['cardInd', 'media', 'walletCvx']
+        required_parameters = {
+          walletId:  wallet_id
+        }
+
+        buyer_options = options[:buyer].blank? ? { wallet_id: wallet_id} : options[:buyer]
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          add_payment( amount, currency, options[:action], :direct, options[:payment]),
+          add_order( amount, currency, options[:order_ref], options[:order]),
+          add_buyer(buyer_options),
+          # Optional parameters
+          add_private_data(options[:private_data]),
+          add_authentication_3D_secure(options[:authentication_3D_secure]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_immediate_wallet_payment, data
+      end
+
+      # :wallet_id [String] Wallet ID
+      # :order_ref [String] Order ID (required)
+      # Required parameters: order_ref, order_data, schedule_date, wallet_id
+      # Optional parameters: card_ind, media
+      # Required objects: payment, recurring
+      # Optional parameters: order, private_data
+      def do_recurrent_wallet_payment(amount, wallet_id, options = {})
+        currency = currency_code(options[:currency])
+
+        optional_parameters = ['cardInd', 'media']
+        required_parameters = {
+          orderRef:  options[:order_ref],
+          orderDate: options[:order_date], # Doesnt seem required
+          scheduledDate: options[:scheduled_date], # Doesnt seem required
+          walletId:  wallet_id,
+        }
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          add_payment( amount, currency, options[:action], :recurrent, options[:payment]),
+          add_recurring( options[:recurring]),
+          # Optional parameters
+          add_order( amount, currency, options[:order_ref], options[:order]),
+          add_private_data(options[:private_data]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_recurrent_wallet_payment, data
+      end
+
+      # :wallet_id [String] Wallet ID
+      # :order_ref [String] Order ID (required)
+      # Required parameters: order_ref, wallet_id, scheduled_date (doesn't seem that required)
+      # Optional parameters: card_ind, media, wallet_cvx
+      # Required objects: order, payment, authentication_3D_secure
+      # Optional parameters: private_data
+      def do_scheduled_wallet_payment(amount, wallet_id, options = {})
+        currency = currency_code(options[:currency])
+
+        optional_parameters = ['cardInd', 'media', 'orderDate']
+        required_parameters = {
+          walletId:  wallet_id,
+          scheduledDate: options[:scheduled_data],
+          orderRef: options[:order_ref]
+        }
+
+        buyer_options = options[:buyer].blank? ? { wallet_id: wallet_id} : options[:buyer]
+
+        data = merged_data([
+          # Required parameters
+          required_parameters,
+          add_payment( amount, currency, options[:action], :direct, options[:payment]),
+          add_order( amount, currency, options[:order_ref], options[:order]),
+          # Optional parameters
+          add_private_data(options[:private_data]),
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :do_scheduled_wallet_payment, data
+      end
+
+
+      # :wallet_id [String] Wallet ID
+      # Required parameters: contract_number, wallet_id
+      # Optional parameters: card_ind
+      def enable_wallet(contract_number, wallet_id, options={})
+        optional_parameters = ['cardInd']
+        required_parameters = {
+          contractNumber: contract_number,
+          walletId: wallet_id
+        }
+
+        data = merged_data([
+          required_parameters,
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :enable_wallet, data
+      end
+
+      # :wallet_id [String] Wallet ID
+      # Required parameters: contract_number, wallet_id
+      # Optional parameters: card_ind
+      def get_wallet(contract_number, wallet_id, options={})
+        optional_parameters = ['cardInd', 'media']
+        required_parameters = {
+          contractNumber: contract_number,
+          walletId: wallet_id
+        }
+
+        data = merged_data([
+          required_parameters,
+          add_optional_parameters(options, optional_parameters)
+        ])
+
+        direct_api_request :get_wallet, data
+      end
+
+      # Optional parameters: card_ind, media
+      # Required objects: Wallet
+      # Optional objects: buyer, owner,  private_data, authentication_3D_secure, contract_number_wallet
+      def update_wallet(wallet, options = {})
+        optional_parameters = ['cardInd', 'media']
+        data = merged_data([
+          # Required parameters
+          add_wallet(wallet),
+          # Option parameters
+          add_buyer(options[:buyer]),
+          add_owner(options[:owner]),
+          add_private_data(options[:private_data]),
+          add_authentication_3D_secure(options[:authentication_3D_secure]),
+          add_optional_parameters(options, optional_parameters),
+          add_contract_number_wallet_list(options[:contract_number_wallet])
+        ])
+
+        direct_api_request :update_wallet, data
+      end
+
+      private
+        # Optional parameters: first_amount, billing_left, start_date, end_date, new_amount, amount_modification_date
+        # Required parameters: amount, billing_cycle
+        def add_recurring(recurring_data)
+          optional_parameters = ['firstAmount', 'billingLeft', 'startDate', 'endDate', 'newAmount', 'amountModificationDate']
+          if recurring_data
+            required_parameters = {
+              amount:       recurring_data[:amount],
+              billingCycle: PaylineCommon::RECURRING_FREQUENCIES[recurring_data[:billing_cycle]]
+            }
+            objects = [
+              required_parameters,
+              add_optional_parameters(options, optional_parameters)
+            ]
+
+            data = { recurring: merged_data(objects)}
+          end
+          data ||= { recurring: {} }
+        end
+
+        # Optional parameters: last_name, first_name, email, comment, default, card_status, card_brand
+        # Required parameters: wallet_id
+        # Required objects: card
+        # Optional objects: shipping_address
+        def add_wallet(wallet_data)
+          if wallet_data
+            optional_parameters = ['lastName', 'firstName', 'email', 'comment', 'default', 'cardStatus', 'cardBrand']
+            required_parameters = {
+              walletId: wallet_data[:wallet_id]
+            }
+
+            objects = [
+              # Required parameters
+              required_parameters,
+              add_credit_card(wallet_data[:card]),
+              # Optional parameters
+              add_address(wallet_data[:shipping_address], :shipping_address),
+              add_optional_parameters(wallet_data, optional_parameters)
+            ]
+
+            data = { wallet: merged_data(objects) }
+          end
+
+          data ||= {}
+        end
+
+        def add_wallet_id_list(wallet_id)
+          if wallet_id
+            data = { walletIdList:
+              {
+                walletId: wallet_id
+              }
+            }
+          end
+          data ||= {}
+        end
+    end
+  end
+end