Introducing Bill Payment, Tesco Lotus (only available in Thailand) #122

guzzilar · 2019-07-27T07:47:57Z

1. Objective

As the statement Omise put at the releasing article:

Our focus is to help you boost sales by offering payment solutions that put customers choice and experience ahead. We’re super excited to let you know that starting today, Omise merchants in Thailand will be able to offer cash payments at Tesco Lotus as an option for customers to pay.

Increasingly we see consumers shifting over to online payments, however a large percentage still prefer to pay by cash over-the-counter. Tesco Lotus is currently the most preferred outlet by consumers, with more than 1800 locations across the country including 24-hour Lotus Express stores.

The objective of this pull request is to bring this feature to our lovely WooCommerce.

https://www.omise.co/now-supporting-over-the-counter-payments-at-tesco-lotus

2. Description of change

Adding all the needs in order to integrate Omise Bill Payment to WooCommerce.

Implementing all the foundation code to list the payment at WooCommerce payment setting page.
Displaying Bill Payment payment method at Omise setting page.
Integrating Bill Payment to WooCommerce checkout page
Display Bill Payment's barcode at the "order-received" page.

3. Quality assurance

🔧 Environments:

WordPress: v5.2.2 (latest)
WooCommerce: v3.6.5 (latest)
PHP version: v7.3.3

✏️ Details:

After installed this patch, you will be able to use Omise Bill Payment Tesco.
The below quality assurance steps is to make sure that all functions are properly work as expected.

At Omise Payment Setting page (logged in to WordPress admin page first), there will be a new payment method, "Bill Payment: Tesco".
Once the payment is enabled, new payment method will be displayed at the checkout page.
Bill Payment uses the "offline" flow, meaning that there is no redirect to any 3rd party page but create a new charge with authorize: pending, and paid: pending status then redirect buyer to the order-received page.

At WooCommerce Order Admin page, a new order will be created with pending payment status.

IMPORTANT

If Webhook is set, Omise-WooCommerce will catch a charge.complete event and update a pending-payment order accordingly. If no, then merchants have to update an order status manually.

Successful case, order status get updated to processing.

Failure case, order status get updated to failed.

4. Impact of the change

Nothing

5. Priority of change

Normal

6. Additional Notes

There are 2 more PRs coming regarding to Omise Bill Payment, which are:

Hook and display Bill Payment's barcode at the WC order confirmation email.
Adding 'printing' button, buyer can print out the barcode after completed the purchase.

Also, according to the Quality assurance section, case [5].
There is one solution that I would like to provide in the future pull request (after the above 2 coming pull requests). Update order status when buyers open an order history page.

The flow is simple, when buyers open an order history page then, plugin will first, check if there is any pending-payment status remains. Then request to Omise Charge API to check for a new status and update those orders accordingly before display it on a screen.

…ent at the WooCommerce payment setting page.

…Setting page.

…ration table.

…der-received page.

guzzilar · 2019-08-05T04:23:27Z

Hook and display Bill Payment's barcode at the WC order confirmation email.

Done at PR #125

guzzilar · 2019-08-05T04:28:22Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+				<small class="omise-billpayment-tesco-reference-number">|&nbsp;&nbsp;&nbsp; <?php echo $tax_id; ?> &nbsp;&nbsp;&nbsp; 00 &nbsp;&nbsp;&nbsp; <?php echo $ref_1; ?> &nbsp;&nbsp;&nbsp; <?php echo $ref_2; ?> &nbsp;&nbsp;&nbsp; <?php echo $amount; ?></small>
+			</div>
+			<?php
+		}


Note, as this code is worked as normal as for the basic need to display barcode at the Thank-You page, this method has also been modified at #125 to support for displaying barcode at WC Order Confirmation email.
https://github.com/omise/omise-woocommerce/pull/125/files#diff-b100586f82e3090b17f2369adb8d9235R111

guzzilar · 2019-08-05T22:12:30Z

Adding 'printing' button, buyer can print out the barcode after completed the purchase.

Done at #126

jacstn · 2019-08-06T07:17:34Z

tested, everything works as expected.

jonrandy · 2019-08-06T07:41:07Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+				'title' => array(
+					'title'       => __( 'Title', 'omise' ),
+					'type'        => 'text',
+					'description' => __( 'This controls the title which the user sees during checkout.', 'omise' ),


This controls the title the user sees during checkout.

@jonrandy 👍 you've mentioned that for Installment once, I forgot 😂
Thanks!

jonrandy · 2019-08-06T07:41:59Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+				'description' => array(
+					'title'       => __( 'Description', 'omise' ),
+					'type'        => 'textarea',
+					'description' => __( 'This controls the description which the user sees during checkout.', 'omise' )


This controls the description the user sees during checkout.

jonrandy · 2019-08-06T07:43:41Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+
+			return OmiseCharge::create( array(
+				'amount'      => Omise_Money::to_subunit( $order->get_total(), $order->get_order_currency() ),
+				'currency'    => $order->get_order_currency(),


Seems a bit wasteful to call get_order_currency twice

@jonrandy thanks for pointing out. I was going to say I don't see much different and I will leave it as it is, but after dig a bit into WC's get_order_currency() method and with some researches, the code with variable is sparking more joy to me.
Updating.

jonrandy · 2019-08-06T07:45:25Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+				'currency'    => $order->get_order_currency(),
+				'description' => apply_filters( 'omise_charge_params_description', 'WooCommerce Order id ' . $order_id, $order ),
+				'source'      => array( 'type' => 'bill_payment_tesco_lotus' ),
+				'return_uri'  => add_query_arg( 'order_id', $order_id, site_url() . "?wc-api=omise_billpayment_tesco_callback" ),


Is it correct to add one query argument using a function and another directly in a string?

@jonrandy Good catch! Definitely not correct. It has been fixed in another payment classes and this one is a legacy that comes before the fixed PR. 👍

jonrandy · 2019-08-06T07:47:48Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+			$ref_2   = $charge['source']['references']['reference_number_2'];
+			?>
+
+			<div class="omise omise-billpayment-tesco-details">


Is this a recommended way to output HTML in WooCommerce?

@jonrandy yup (we've discussed this topic already in some PR in the past) – It is a common way in WordPress.

jonrandy · 2019-08-06T07:58:27Z

includes/gateway/class-omise-payment-billpayment-tesco.php

+			}
+
+			if ( 'pending' == $charge['status'] ) {
+				return [


Which array creation style should we be using? Is there a standard in WooCommerce?

@jonrandy good catch again, array() it is.

guzzilar · 2019-08-06T09:29:42Z

@jonrandy @jacstn I have addressed all the feedbacks above and retested.
Can you help me review it again? Thank a lot : D

jonrandy

LGTM

guzzilar force-pushed the introduce-billpayment branch 3 times, most recently from c8402ca to 82ab13f Compare July 28, 2019 19:24

guzzilar added Status: Review needed Type: Feature request labels Jul 31, 2019

guzzilar assigned jonrandy and jacstn Jul 31, 2019

guzzilar requested review from jacstn and jonrandy July 31, 2019 13:25

guzzilar unassigned jonrandy and jacstn Jul 31, 2019

guzzilar force-pushed the introduce-billpayment branch 2 times, most recently from 323a139 to 9324e69 Compare July 31, 2019 19:24

guzzilar added 3 commits August 1, 2019 15:03

Bill Payment: implementing a foundation-minimum code to list the paym…

d4c7b42

…ent at the WooCommerce payment setting page.

Bill Payment: listing Bill Payment payment method at the admin Omise …

103e909

…Setting page.

Bill Payment: Be able to save the Bill Payment settings to WC configu…

37d57d9

…ration table.

guzzilar force-pushed the introduce-billpayment branch from 9324e69 to 2367254 Compare August 1, 2019 08:04

guzzilar added 2 commits August 2, 2019 01:14

Bill Payment: Be able to create a new charge.

3ee24fd

Bill Payment: Displaying Omise Bill Payment Tesco's barcode at the or…

0b84db6

…der-received page.

guzzilar force-pushed the introduce-billpayment branch from 2367254 to 0b84db6 Compare August 1, 2019 18:14

guzzilar mentioned this pull request Aug 5, 2019

Bill Payment: Displaying Tesco barcode at WC Order Confirmation email. #125

Merged

guzzilar commented Aug 5, 2019

View reviewed changes

guzzilar mentioned this pull request Aug 5, 2019

Bill Payment: Adding a 'Print barcode' button. #126

Merged

guzzilar mentioned this pull request Aug 5, 2019

any plans for this to support Bill Payment ? #82

Closed

jonrandy reviewed Aug 6, 2019

View reviewed changes

Bill Payment: Addressing all code-review's feedbacks.

c9edc84

jonrandy approved these changes Aug 6, 2019

View reviewed changes

jacstn approved these changes Aug 7, 2019

View reviewed changes

guzzilar added Status: Ready and removed Status: Review needed labels Aug 7, 2019

guzzilar merged commit 2a0a842 into master Aug 7, 2019

guzzilar deleted the introduce-billpayment branch August 7, 2019 07:15

guzzilar mentioned this pull request Aug 26, 2019

✨ Releasing Omise-WooCommerce v3.7 #132

Merged

guzzilar added Status: Released and removed Status: Ready labels Sep 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing Bill Payment, Tesco Lotus (only available in Thailand) #122

Introducing Bill Payment, Tesco Lotus (only available in Thailand) #122

guzzilar commented Jul 27, 2019 •

edited

Loading

guzzilar commented Aug 5, 2019

guzzilar Aug 5, 2019

guzzilar commented Aug 5, 2019

jacstn commented Aug 6, 2019

jonrandy Aug 6, 2019

guzzilar Aug 6, 2019

jonrandy Aug 6, 2019

jonrandy Aug 6, 2019

guzzilar Aug 6, 2019

jonrandy Aug 6, 2019

guzzilar Aug 6, 2019

jonrandy Aug 6, 2019

guzzilar Aug 6, 2019

jonrandy Aug 6, 2019

guzzilar Aug 6, 2019

guzzilar commented Aug 6, 2019

jonrandy left a comment

Introducing Bill Payment, Tesco Lotus (only available in Thailand) #122

Introducing Bill Payment, Tesco Lotus (only available in Thailand) #122

Conversation

guzzilar commented Jul 27, 2019 • edited Loading

1. Objective

2. Description of change

3. Quality assurance

4. Impact of the change

5. Priority of change

6. Additional Notes

guzzilar commented Aug 5, 2019

Choose a reason for hiding this comment

guzzilar commented Aug 5, 2019

jacstn commented Aug 6, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guzzilar commented Aug 6, 2019

jonrandy left a comment

Choose a reason for hiding this comment

guzzilar commented Jul 27, 2019 •

edited

Loading