Elavon: Update Stored Credential behavior #5031

curiousepic · 2024-01-30T21:21:16Z

To satisfy new Elavon API requirements, including recurring_flag, approval_code for non-tokenized PMs, installment_count and _number, and situational par_value and association_token_data fields.

This also now allows Authorize transactions with a token/stored card.

Remote (Same 5 Failures on Master):
39 tests, 162 assertions, 5 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 87.1795% passed

Unit:
53 tests, 298 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 100% passed

curiousepic · 2024-01-30T21:22:23Z

lib/active_merchant/billing/gateways/elavon.rb

@@ -46,7 +46,7 @@ def purchase(money, payment_method, options = {})
          if payment_method.is_a?(String)
            add_token(xml, payment_method)
          else
-            add_creditcard(xml, payment_method)
+            add_creditcard(xml, payment_method) unless options[:ssl_token]


Elavon indicated that card number should not be added in addition to a token.

curiousepic · 2024-01-30T21:23:08Z

lib/active_merchant/billing/gateways/elavon.rb

+            add_token(xml, payment_method)
+          else
+            add_creditcard(xml, payment_method) unless options[:ssl_token]
+          end


Adds support for Authorize transctions with a token. I'm not sure why this wasn't added originally.

curiousepic · 2024-01-30T21:24:03Z

lib/active_merchant/billing/gateways/elavon.rb

        return options[:entry_mode] if options[:entry_mode]
-        return 12 if options[:stored_credential]
+        return if payment_method.is_a?(String)
+        return 12 if options.dig(:stored_credential, :reason_type) == 'unscheduled'


Elavon indicated that this should only be 12 for unscheduled reason types. It's also only needed for pass-in cards, not tokens. But we retain the ability to override it with an option param.

curiousepic · 2024-01-30T21:25:19Z

lib/active_merchant/billing/gateways/elavon.rb

-          xml.ssl_oar_data oar_data unless oar_data.nil? || oar_data.empty?
-          xml.ssl_ps2000_data ps2000_data unless ps2000_data.nil? || ps2000_data.empty?
+          xml.ssl_oar_data oar_data unless oar_data.nil? || oar_data.empty? || payment_method.is_a?(String)
+          xml.ssl_ps2000_data ps2000_data unless ps2000_data.nil? || ps2000_data.empty? || payment_method.is_a?(String)


This prevents this data from being added for tokens, if it is also present.

curiousepic · 2024-01-30T21:26:27Z

lib/active_merchant/billing/gateways/elavon.rb

+        xml.ssl_recurring_flag recurring_flag(options) if recurring_flag(options)
+        xml.ssl_approval_code options[:approval_code] if options[:approval_code] && !payment_method.is_a?(String)
+        xml.ssl_par_value options[:par_value] if options[:par_value]
+        xml.ssl_association_token_data options[:association_token_data] if options[:association_token_data]


Two new values that may be present on an initial transaction that should be passed in subsequent COF transactions.

curiousepic · 2024-01-30T21:26:54Z

lib/active_merchant/billing/gateways/elavon.rb

+      def recurring_flag(options)
+        return unless reason = options.dig(:stored_credential, :reason_type)
+        return 1 if reason == 'recurring'
+        return 2 if reason == 'installment'


This is the primary new requirement for indicating recurring txns.

curiousepic · 2024-01-30T21:27:33Z

lib/active_merchant/billing/gateways/elavon.rb

      end

      def merchant_initiated_unscheduled(options)
        return options[:merchant_initiated_unscheduled] if options[:merchant_initiated_unscheduled]
-        return 'Y' if options.dig(:stored_credential, :initiator) == 'merchant' && options.dig(:stored_credential, :reason_type) == 'unscheduled' || options.dig(:stored_credential, :reason_type) == 'recurring'
+        return 'Y' if options.dig(:stored_credential, :initiator) == 'merchant' && options.dig(:stored_credential, :reason_type) == 'unscheduled'


Should only be present for reason type unscheduled, not recurring.

lib/active_merchant/billing/gateways/elavon.rb

almalee24 · 2024-01-30T21:55:14Z

If you haven't already please don't forget to run bundle exec rubocop

curiousepic · 2024-01-30T21:56:48Z

If you haven't already please don't forget to run bundle exec rubocop

Yes, fixing those now!

curiousepic · 2024-01-30T22:03:09Z

Updated with Rubocop fixes.

lib/active_merchant/billing/gateways/elavon.rb

curiousepic · 2024-01-31T15:03:26Z

Added tests for the combination of stored cred fields and using a manual token instead of a stored card authorization string.

almalee24 · 2024-01-31T16:04:39Z

lib/active_merchant/billing/gateways/elavon.rb

        end
+        xml.ssl_recurring_flag recurring_flag(options) if recurring_flag(options)
+        xml.ssl_approval_code options[:approval_code] if options[:approval_code] && !payment_method.is_a?(String) && !options[:ssl_token]


Could we make this into a variable so it can also be used above? Where we check for payment_method.is_a?(String) in ssl_oar_data and ssl_ps2000_data. Maybe the the new variable could be called used_payment_token

Good suggestion, I've done some refactoring of this method to clean it up in general which should help.

almalee24 · 2024-01-31T21:18:09Z

lib/active_merchant/billing/gateways/elavon.rb

+        xml.ssl_par_value options[:par_value] if options[:par_value]
+        xml.ssl_association_token_data options[:association_token_data] if options[:association_token_data]
+
+        if !payment_method.is_a?(String) && !options[:ssl_token].present?


Could this to be unless instead of if

almalee24

This looks great! Thanks for all the hard work you put in!

curiousepic · 2024-02-09T20:11:42Z

@almalee24 Made some changes after feedback from Elavon - notably to make sure we don't send cvv on non-initial stored cred txns, and ensuring a blank ps2000 data field was not passed in some situations, as well as being able to invoke real respones for the new par_value and association_token_data fields.

almalee24 · 2024-02-12T22:51:52Z

lib/active_merchant/billing/gateways/elavon.rb

@@ -234,8 +239,11 @@ def add_token(xml, token)
        xml.ssl_token token


We probably need to update this method to either pass down options to grab token from there if payment is a credit card but has options[:ssl_token] or to return unless token.is_a?(String)

Good catch... I thought I'd added enough test variations to cover that situation 😓

Oh wait, I think it didn't catch them because we have another place where we're adding ssl_token in add_auth_purchase_params 😅
I'll see if I can unify those cases to prevent duplication and confusion.

lib/active_merchant/billing/gateways/elavon.rb

curiousepic · 2024-02-13T17:28:04Z

Refactored all instances of adding card or token into a single helper method (update action needs both so adds them manually). Would appreciate another look at the diff.

almalee24 · 2024-02-15T16:03:03Z

lib/active_merchant/billing/gateways/elavon.rb

@@ -352,30 +353,48 @@ def add_line_items(xml, level_3_data)
        }
      end

-      def add_stored_credential(xml, options)
+      def add_stored_credential(xml, payment_method, options)
+        return unless options[:stored_credential]


This is not necessary since you already did if options[:stored_credential] when calling the method

True, though I'd lean toward overeager guard clauses than less; if it gets used in the future it's already there.

almalee24 · 2024-02-15T16:17:10Z

Looks good to me!

To satisfy new Elavon API requirements, including recurring_flag, approval_code for non-tokenized PMs, installment_count and _number, and situational par_value and association_token_data fields. This also now allows Authorize transactions with a token/stored card. Remote (Same 5 Failures on Master): 39 tests, 162 assertions, 5 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 87.1795% passed Unit: 53 tests, 298 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications 100% passed

curiousepic requested a review from a team January 30, 2024 21:21

curiousepic commented Jan 30, 2024

View reviewed changes

almalee24 reviewed Jan 30, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

almalee24 reviewed Jan 30, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

almalee24 reviewed Jan 30, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch from 01a89b6 to 2cfc40f Compare January 30, 2024 22:02

almalee24 reviewed Jan 30, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch 3 times, most recently from f1730e3 to 952c79d Compare January 31, 2024 15:00

almalee24 reviewed Jan 31, 2024

View reviewed changes

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch from 952c79d to 9fb65d7 Compare January 31, 2024 16:19

almalee24 reviewed Jan 31, 2024

View reviewed changes

almalee24 approved these changes Jan 31, 2024

View reviewed changes

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch from 9fb65d7 to 0079e93 Compare January 31, 2024 22:13

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch from 0079e93 to 645d5b3 Compare February 9, 2024 20:09

curiousepic requested a review from almalee24 February 12, 2024 20:24

almalee24 reviewed Feb 12, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

almalee24 reviewed Feb 12, 2024

View reviewed changes

lib/active_merchant/billing/gateways/elavon.rb Outdated Show resolved Hide resolved

curiousepic force-pushed the ecs_3295_elavon_stored_cred_updates branch 2 times, most recently from ac0a73a to 1954c69 Compare February 13, 2024 17:26

curiousepic requested a review from almalee24 February 13, 2024 17:27

almalee24 reviewed Feb 15, 2024

View reviewed changes

bradbroge force-pushed the ecs_3295_elavon_stored_cred_updates branch from 1954c69 to f39602f Compare February 28, 2024 18:56

bradbroge merged commit ebcb303 into master Feb 28, 2024
0 of 5 checks passed

bradbroge deleted the ecs_3295_elavon_stored_cred_updates branch February 28, 2024 20:01

almalee24 restored the ecs_3295_elavon_stored_cred_updates branch July 10, 2024 18:42

almalee24 deleted the ecs_3295_elavon_stored_cred_updates branch July 10, 2024 18:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Elavon: Update Stored Credential behavior #5031

Elavon: Update Stored Credential behavior #5031

curiousepic commented Jan 30, 2024

curiousepic Jan 30, 2024

curiousepic Jan 30, 2024

curiousepic Jan 30, 2024 •

edited

Loading

curiousepic Jan 30, 2024

curiousepic Jan 30, 2024

curiousepic Jan 30, 2024 •

edited

Loading

curiousepic Jan 30, 2024

almalee24 commented Jan 30, 2024

curiousepic commented Jan 30, 2024

curiousepic commented Jan 30, 2024

curiousepic commented Jan 31, 2024

almalee24 Jan 31, 2024

curiousepic Jan 31, 2024

almalee24 Jan 31, 2024

almalee24 left a comment

curiousepic commented Feb 9, 2024 •

edited

Loading

almalee24 Feb 12, 2024 •

edited

Loading

curiousepic Feb 13, 2024 •

edited

Loading

curiousepic commented Feb 13, 2024

almalee24 Feb 15, 2024

curiousepic Feb 15, 2024

almalee24 commented Feb 15, 2024

		@@ -234,8 +239,11 @@ def add_token(xml, token)
		xml.ssl_token token

Elavon: Update Stored Credential behavior #5031

Elavon: Update Stored Credential behavior #5031

Conversation

curiousepic commented Jan 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curiousepic Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curiousepic Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

almalee24 commented Jan 30, 2024

curiousepic commented Jan 30, 2024

curiousepic commented Jan 30, 2024

curiousepic commented Jan 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

almalee24 left a comment

Choose a reason for hiding this comment

curiousepic commented Feb 9, 2024 • edited Loading

almalee24 Feb 12, 2024 • edited Loading

Choose a reason for hiding this comment

curiousepic Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

curiousepic commented Feb 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

almalee24 commented Feb 15, 2024

curiousepic Jan 30, 2024 •

edited

Loading

curiousepic Jan 30, 2024 •

edited

Loading

curiousepic commented Feb 9, 2024 •

edited

Loading

almalee24 Feb 12, 2024 •

edited

Loading

curiousepic Feb 13, 2024 •

edited

Loading