Fee based on payment method choice

36 replies [Last post]

Tue, 08/21/2007 - 09:24

qrios

Offline

Joined: 08/13/2007

Juice: 554

Hi,

I have a project, where the shop owner wants to charge his clients a fee, based on their payment method choice.

for example, paying by Paypal costs 4 euro, paying on delivery 10 euro. Is there an easy way of doing this in Ubercart? (or a less easy way)

Thanks,

Kees

Tue, 08/21/2007 - 17:43

#1 View page

cobrasound

Offline

Joined: 08/07/2007

Juice: 157

Re: Fee based on payment method choice

It would also be nice to be able to add a discount depending upon payment method (i.e. 3% off of the total for paying with Cash or Cashier's check).

Jeff

Wed, 08/22/2007 - 04:33

#2 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hey Guys. I'll give it a try

Hey Guys.

I'll give it a try this evening, cause I need this too. Give me a couple of hours.
But I think it won't (can't) be a module, you have to manipulate the ÃƒÅ“bercart sourcecode.
I will give you an instruction then.

Stay tuned.

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Wed, 08/22/2007 - 08:52

#3 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Hi Michel,

I hope I not crossed your attempts. I did get it to work, but indeed, I had to hack a core .js file.

The situation is simple. The radiobuttons for paymentmethod choice in checkout, already have a "onclick" js event. They do not have a unique ID nor name (bug?) so DHTML is not posible (I think). Thats why I had to change the js function "function get_payment_details".

Changes:

/**
 * Display the payment details when a payment method radio button is clicked.
 */
function get_payment_details(path) {
  $.post(path, { },
    function(details) {
      if (details == '') {
        $('#payment_details').empty().addClass('display-none');
      }
      else {
        $('#payment_details').removeClass('display-none').empty().append(details);
      }
    }
  );
  //Start qrios hack
  var q_path;
  q_path = path.replace("payment_details", "method_fee");
  //alert(q_path);
  $.post(q_path, { },
    function(q_details) {
      q_details = q_details.split("||");
      if (q_details == '') {
        //$('#payment_details').empty().addClass('display-none');
      }
      else {
          if (set_line_item != undefined){
            set_line_item("methodfee", q_details[0], q_details[1], 1);
          }
      }
    }
  );
  //end hack
}

Maybe there is a way to make this more like themable/hookable??

q_details var returns one value containing two concatinated strings separated by ||. I didn't see another way. The module is'nt ready yet, if it is, I will post here.

Kees

Wed, 08/22/2007 - 09:45

#4 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hi Kees, I think I don't

Hi Kees,

I think I don't really understand what your function is doing
Respectivly I don't understand where I could add a value (fee)? Is there any more code? Your code just adds a new field when the radio-button is clicked, doesn't it?

I found a way to manipulate the uc_payment.module in such a way that you can add a value (e.g +4Ã¢â€šÂ¬, -3%) to every payment method. This Value is also shown as line-item in the checkout review. I think it should work.

I'm actually not in the office. So I think I will post it ca. in 3 hours.
Maybe we can combine our codes.

greetings from germany
mic

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Wed, 08/22/2007 - 10:21

#5 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Re: Hi Kees, I think I don't

Did I wrote 3 hours? I meant 3 minutes

Here is the modified uc_payment.module. You can find the added code by searching the string "#mic". Just replace the old file and test it. Go in the store administration to "payment settings" -> "payment methods" and add some values for the different methods. Then it should work..

Check out the code, maybe you can use it for your module. I'm working with ubercart just since a couple of days, so this code is just alpha, alpha, alpha... Be carefully with it.

add to function uc_payment_order:

<?php
case 'total':
    $csubtotal = 0; 
    $citems = uc_cart_get_contents();
    foreach ($citems as $item) {
        $ctotal = ($item->qty) ? $item->qty * $item->price : $item->price;
        $csubtotal += $ctotal;
    }
    $text_of_payment = '';
    $cost_of_payment = 0;
    $cost_of_payment = variable_get('uc_payment_method_'. $arg1->payment_method .'_cost', '');
    $mode = variable_get('uc_payment_method_'. $arg1->payment_method .'_mode', '');
    
    db_query("DELETE FROM {uc_order_line_items} WHERE order_id = %d AND type = '%s'", $arg1->order_id, 'Cost of Payment');
    
    if ($cost_of_payment != ""){
        
        if ($mode == 'percent_plus') {
            $cost_of_payment = intval($cost_of_payment);
            $cost_of_payment = ($csubtotal / 100) * $cost_of_payment;
        }
        elseif ($mode == 'percent_minus') {
            $cost_of_payment = intval($cost_of_payment);
            $cost_of_payment = ($csubtotal / 100) * $cost_of_payment;
            $cost_of_payment *= -1;                    
        }
        elseif ($mode == 'static') {
            $cost_of_payment = $cost_of_payment;
        }
        $text_of_payment = variable_get('uc_payment_method_'. $arg1->payment_method .'_text', '');
        uc_order_line_item_add($arg1->order_id, 'Cost of Payment', $text_of_payment, $cost_of_payment, 1);
    }
    return $cost_of_payment;
?>

It's to add the costs as a line item. (see picture)

add to uc_payment_methods_form

<?php
            $form['pmtable'][$method['id']]['uc_payment_method_'. $method['id'] .'_cost'] = array( 
            '#type' => 'textfield', 
            '#size' => '5', 
            '#default_value' => variable_get('uc_payment_method_'. $method['id'] .'_cost', $method['cost']),
            ); 
            //@todo Form Validation
            $form['pmtable'][$method['id']]['uc_payment_method_'. $method['id'] .'_mode'] = array( 
            '#type' => 'select',
            '#options' => array ('percent_plus' => '%+', 'percent_minus' => '%-', 'static' => 'static'),
            '#default_value' => variable_get('uc_payment_method_'. $method['id'] .'_mode', 'none'), 
            );
            $form['pmtable'][$method['id']]['uc_payment_method_'. $method['id'] .'_text'] = array( 
            '#type' => 'textfield',
            '#size' => '20', 
            '#default_value' => variable_get('uc_payment_method_'. $method['id'] .'_text', $method['cost']), 
            ); 
?>

It extends the form where the payment methods are listed. (See picture)
Check also the attached file to see the changes in the theme_uc_payment_methods_form

add to uc_checkout_pane_payment

<?php
$text = variable_get('uc_payment_method_'. $method['id'] .'_text', '');
if ($text != "") $options[$method['id']] .= ' ('.$text.')';
?>

It's to show the text behind the payment method. see picture)

So, I need your feedback now.
Thanks and greetings.
Mic

Attachment	Size
input_payment_fee.jpg	24.11 KB
display_checkout.jpg	10.05 KB
display_checkout_review.jpg	7.47 KB
uc_payment.module.txt	56.41 KB

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Mon, 08/27/2007 - 10:12

#6 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Hi Mic and others, Sorry for

Hi Mic and others,

Sorry for late reply.

I don't have time now to dig into your code.
Attached is the small module I created.

It's not ready, but functioning.

For now it is a fixed fee, and uses a setting "variable_get('uc_'.$method_id.'_fee', 0)", for example uc_paypal_ec_fee where the fee value is stored. The admin form to adjust the fee is missing!

I'm sure I can use your code to extend this module or the other way around. I'll get back on this!

Kees

Attachment	Size
uc_methodfee.tar	6.5 KB

Mon, 08/27/2007 - 16:38

#7 View page

Ryan

Offline

Joined: 08/07/2007

Juice: 15438

Re: Hi Mic and others, Sorry for

Awesome work everyone! I'll consider putting this into core, as it's been requested almost as long as we've been making releases. I don't want to add too much complexity, though... what does everyone else think?

Tue, 08/28/2007 - 06:07

#8 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

My thoughts: Yes, please, in

My thoughts:

Yes, please, in core would be just fine .
As far as complexity goes: A value, and a calculation method (add or multiply) per payment method would be nice.

I realy like the "one page checkout" Ubercart provides. But digging into this matter I can't help to think that it would be a lot easier to have more steps like :cart>Shipping>paymentmethod>adress+checkout. It would make things like this a lot easier.. but he, the easy way isn't always the best.

Note: I'm a bit concerned about the Javascript reliance of the method I used.

I would love to make it work, I don't have time for it the next two weeks though...

Kees

Tue, 08/28/2007 - 11:18

#9 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hey Ryan.

It would be cool if you can add it.
But I have just a problem:

In the script I wrote I add the Line with the cost of payment like this

<?php
 uc_order_line_item_add($arg1->order_id, 'Cost of Payment', $text_of_payment, $cost_of_payment, 1); 
?>

That works. But when I view the order (after submiting) as Admin, I can't change the values (like, i.e, the shipping cost). Do you know what I mean? Can you give me some help? Just a hint which functions I shpuld use...

thanks.

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Tue, 08/28/2007 - 16:09

#10 View page

Ryan

Offline

Joined: 08/07/2007

Juice: 15438

Re: Hey Ryan.

In order to edit it, you can probably just change 'Cost of Payment' to 'generic'. That second argument should be the ID of a line item type that is editable, and my hunch here is that isn't happening. Since it's all internal, you should be able to get by with a generic line item. Otherwise you'll need to use hook_line_item() to add in a line item type to mimic the generic definition:

<?php
  // Look in uc_order.module for uc_order_line_item() where this code is:
  $items[] = array(
    'id' => 'generic',
    'title' => t('Empty Line'),
    'weight' => 2,
    'stored' => TRUE,
    'add_list' => TRUE,
    'calculated' => TRUE,
    'callback' => 'uc_line_item_generic',
  );
?>

Wed, 08/29/2007 - 04:58

#11 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Re: Re: Hey Ryan.

Hey, cool it seems to work with

<?php
uc_order_line_item_add($arg1->order_id, 'generic', $text_of_payment, $cost_of_payment, 1);
?>

and some other changes.

I can send you an updated version in the next days if you want?

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Wed, 08/29/2007 - 08:33

#12 View page

Ryan

Offline

Joined: 08/07/2007

Juice: 15438

Re: Re: Re: Hey Ryan.

Yeah, send it to me when you get a chance and I'll try to test it out/add it in. It may take me a few days to get that done, though. Still trying to catch up.

Wed, 08/29/2007 - 12:31

#13 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Re: Hey Ryan.

In the module I posted, I use a session var to remember the chosen payment method . What is the correct way to detect this when I'm in "hook_line_item"?(in the review order page)

Thanks,

Kees

Wed, 08/29/2007 - 13:46

#14 View page

Ryan

Offline

Joined: 08/07/2007

Juice: 15438

Re: Re: Re: Re: Re: Hey Ryan.

You can load the order based on the session variable cart_order. It will have the chosen payment method stored in it by then.

Fri, 08/31/2007 - 07:30

#15 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Re: Re: Re: Hey Ryan.

Hi Michel, Ryan, rest of you,

I did complete my module sort of, with a lot of help from Mitchels code. (So I found time after all )

It's a standalone module (no PHP hacks) to make it work in the checkout page (not only in order review) you have to hack uc_payment.js according to included readme file.

The module supports adding and multiplying, per enabled payment method. If you need f.e. 3% discount, simply multiply by 0.97 . Admin settings available in the payment method section under 'Method Fee settings'.

I need your feedback on this please.

Regards,

Kees

Attachment	Size
uc_methodfee0p2.tar	12.5 KB

Fri, 08/31/2007 - 08:59

#16 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hi Kees. That's good. But it

Hi Kees.

That's good.
But it seems, that the Fee is not calculated to the the total-amount, isn't it?

greetings
Michael

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Fri, 08/31/2007 - 09:52

#17 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Hi Kees.

Hi Michael, sorry for misspelling your name.

You're right, I didn't test past the 'order review' page, I think I see where I went wrong, wait a sec...

Thanks,

Kees

Fri, 08/31/2007 - 10:01

#18 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hi. I found the

Hi.

I found the mistake.
I'll upload it later.

Mic

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Fri, 08/31/2007 - 11:14

#19 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Here is the improved file. I

Here is the improved file.

I did it a bit lighter.
Should work now. Please test it. And if it works we can put it to the contributions.

But there is one (big!) problem. If you change the method fee settings (the values), every order is updated. That's something that shouldn't happened. Any ideas?

Attachment	Size
uc_methodfee0p3.tar	12.5 KB

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Fri, 08/31/2007 - 11:25

#20 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Hi Kees.

Please try again. Attached is new mod.

Attachment	Size
uc_methodfee0p3.tar	14.5 KB

Fri, 08/31/2007 - 11:26

#21 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Hi Kees.

Oops, crossposted yours. Gonna try!

Fri, 08/31/2007 - 11:37

#22 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Re: Hi Kees.

Hi Michael, I looked through your code, your change is basicly the same as mine if I'm correct, I had old code in hook _order, refering to a non existent sessionvar.

Please look at my module, it has a few improvements and moved a bit more structure.

Regarding the problem of updating all orders, I really don't have a solution to it, thanks for pointing it out.

Regards,

Kees

Attachment	Size
uc_methodfee0p4.tar	14.5 KB

Fri, 08/31/2007 - 11:52

#23 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Re: Re: Re: Re: Re: Hi Kees.

I'll check it this night.
Thanks for your good work. But we should communicate a bit more. instead of doing the same work

The problem with the updating of all orders: This is a problem of the most modules (Shipping Cost etc). That's why I asked this: http://www.ubercart.org/forum/development/504/stored_true_hook_line_item

We will see.

Mic

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Fri, 08/31/2007 - 14:01

#24 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Latest mod. Removed debug

Latest mod.
Removed debug something.

Attachment	Size
uc_methodfee0p5.tar	14.5 KB

Sat, 09/01/2007 - 08:23

#25 View page

michels

Offline

Joined: 08/12/2007

Juice: 205

Hi Kees. I checked this

Hi Kees.

I checked this yesterday.
You're module doesn't display the Method Fee-Line under Store Administration -> Orders -> View.

Maybe you want to fix that. Otherwise we can take mine. It works correctly I think.

greetings
Mic

Legal aspects pane for european shops
AGB und Widerrufsrecht im Bestellprozess einblenden

Thu, 09/20/2007 - 15:07

#26 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Hi Kees. I checked this

Are you sure you have the latest? It works fine here... strange. (7b)

Kees

Thu, 09/20/2007 - 15:08

#27 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Hi Kees.

sorry, duplicate

Thu, 09/20/2007 - 15:17

#28 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Hi Kees. I checked this

Anyway, I created the contribution here:

http://www.ubercart.org/contrib/748

Feel free to make adjustments or provide feedback.

Thanks,

Kees

Fri, 11/23/2007 - 19:41

#29 View page

Mariano

Offline

Joined: 09/04/2007

Juice: 110

Re: Re: Hi Kees.

I tested the current uc_methodfee0p6 version with UC alpha 8, and it seems to be somehow working. Anyway, I couldn't get the uc_payment.js hack working.

I have Credit Card, COD and Method Fee payment methods enabled. At checkout, when it comes to the 'Payment Method', only one method can be selected. It is supposed, as configured under 'Method Fee settings' at 'Payment Methods', that a certain price must be applied when COD is selected ('The fee value for payment method: cod: ...). If I choose COD at checkout, I get the correct fee at the review order screen, however -if I select Method Fee-, no payment method at the review order screen seems to have been applied.

Has anyone tested this contribution with the current Ãœbercart's version?

Thanks =)

Sat, 11/24/2007 - 15:59

#30 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Hi Kees.

The discriptiont text says something like 'don't display this as a payment method', please uncheck Method Fee as a payment method.

I should review the module, it shouldn't be available as a payment method.

Since no one seemed to need this module (except you now), I did not care much about it.

Regards,

Kees

Tue, 12/11/2007 - 11:31

#31 View page

cYu

Offline

Joined: 11/19/2007

Juice: 850

Re: Re: Re: Re: Hi Kees.

I posted some code for testing at...
http://www.ubercart.org/contrib/2184
which should add the ability to associate fees or discounts with payment methods.

Wed, 12/12/2007 - 09:05

#32 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Re: Re: Hi Kees.

Can't we combine efforts here?

Wed, 12/12/2007 - 11:00

#33 View page

cYu

Offline

Joined: 11/19/2007

Juice: 850

Re: Re: Re: Re: Re: Re: Hi Kees.

Yeah, that would be cool. I'm running into some problems that you might have already dealt with and taken care of, like how to represent these discounts/fees during the checkout process.

I downloaded your contrib, but I wanted to try to implement something that was simpler to use on the admin side. Instead of creating a new module, I hacked up the existing payment module but tried to keep things straight forward enough that it might be added into core eventually.

If you get a chance could you take a look at what I did? I think we should be able to look at different aspects of our code and come up with a nice solution for this issue.

Mon, 12/17/2007 - 04:18

#34 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Re: Re: Re: Re: Hi Kees.

OK, lets do that. Have you looked at 'mine', and do you have suggestions on what to combine?

Tue, 01/29/2008 - 11:35

#35 View page

cYu

Offline

Joined: 11/19/2007

Juice: 850

Re: Re: Re: Re: Re: Re: Re: Re: Hi Kees.

Ryan has taken some of the code that I wrote, meant to be added to core, and put together a nice contrib module that adds payment method fees/discounts. If anyone wants to test it out and post any issues/suggestions you can find it at http://www.ubercart.org/contrib/2184

Wed, 08/29/2007 - 11:54

#36 View page

qrios

Offline

Joined: 08/13/2007

Juice: 554

Re: Re: Re: Hey Ryan.

Could you post your version here please?

	User login
	Log in using OpenID: What is OpenID? Username or e-mail: * Password: * Remember me Log in using OpenID Cancel OpenID login Create new account Request new password

Ubercart

Navigation

User login