How to develop a new payment gateway

magostoni71

Hello @manhta,
I followed your suggestion but I have some trouble.

Let me show what I did:

1) /lib/vendor/composer/autoload_static.php I added the following code:

        'Omnipay\\PagopaBps\\' =>
        array(
            0 => __DIR__ . '/..' . '/omnipay/pagopabps/src',
        ),

2) lib/vendor/composer/autoload_psr4.php I added the following code:
'Omnipay\\PagopaBps\\' => array($vendorDir . '/omnipay/pagopabps/src'),

3) /lib/helper.php I added the last line as follow

        $gateway_properties = array(
            'Stripe' => array('card' => false),
            'Stripesca' => array('card' => false),
            'PagopaBps' => array('card' => false),

4) /tmpl/stripesca.php I copied the file into plugins\system\ja_payment\tmpl\pagopabps.php and I modified the file for testing purpose removing for the moment the redirect, only to see if it was showing.

<?php
defined('_JEXEC') or die('Restricted access');
?>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Pago PA BPS Checkout</title>
    <style>
        .wrapper {
            text-align: center;
        }

        .loader {
            margin: 0 auto;
            border: 10px solid #f3f3f3;
            border-radius: 50%;
            border-top: 10px solid #3498db;
            width: 40px;
            height: 40px;
            -webkit-animation: spin 2s linear infinite;
            /* Safari */
            animation: spin 2s linear infinite;
        }

        /* Safari */
        @-webkit-keyframes spin {
            0% {
                -webkit-transform: rotate(0deg);
            }

            100% {
                -webkit-transform: rotate(360deg);
            }
        }

        @keyframes spin {
            0% {
                transform: rotate(0deg);
            }

            100% {
                transform: rotate(360deg);
            }
        }
    </style>
</head>

<body>
    <div class="wrapper">
        <h2>Ti stiamo reindirizzando al sito PagoPA ...</h2>
        <div class="loader"></div>
    </div>

</body>

</html>

5) /xml/Stripesca.xml I copied the file into \plugins\system\ja_payment\xml\PagopaBps.xml and this is the content

<fields name="PagopaBps">
    <fieldset name="PagopaBPS" label="PAGOPABPS" addfieldpath="/plugins/system/ja_payment/fields/">
        <field name="codiceServizio" type="text" default="" label="PAGOPABPS_CODICE_SERVIZIO"
               description="PAGOPABPS_CODICE_SERVIZIO_DESC"/>
        <field name="logo" type="media" default="" label="PAGOPABPS_LOGO" description="PAGOPABPS_LOGO_DESC"/>
    </fieldset>
</fields>

6) /xml/gateway.json I added the following code

         "PagopaBps": {
            "codiceServizio": "",
            "logo": ""
        },

7) I duplicated /lib/vendor/omnipay/stripesca in \plugins\system\ja_payment\lib\vendor\omnipay\pagopabps
and changed the code of gateway.php in this way

<?php 
namespace Omnipay\PagopaBps;

use Omnipay\Stripe\Gateway as PagopaBPSGateway;

class Gateway extends PagopaBPSGateway
{
    public function getName()
    {
        return 'PagopaBps';
    }

    public function purchase(array $param = array())
    {
        try {
            $config = array(
                'payment_method_types' => ['card'],
                'line_items' => [[
                    'price_data' => [
                        'currency' => strtolower($param['currency']),
                        'unit_amount' => $param['amount'] * 100,
                        'product_data' => [
                            'name' => \JText::_('DT_INVOICE') . ': ' . $param['invoice_number'] . ' | ' . $param['description'],
                        ],
                    ],
                    'quantity' => 1,
                ]],
                'mode' => 'payment',
                'success_url' => $param['success'],
                'cancel_url' => $param['cancel'],
            );

            print_r($param);
            print_r($config); 


            ob_clean();

            require_once \JPluginHelper::getLayoutPath('system', 'ja_payment', 'pagopabps');
            die;
        } catch (\Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
        
    }

    public function getDefaultParameters()
    {
        return array(
            'codiceServizio' => ''
        );
    }
}

Then I configured the JA Payment plugin enabling PagopaBps and Paypal Standard only for testing purpose.
At the same time I enabled in the default "Payment option" the same 2 gateways.

Then I insert in the frontend I loggedin as a registered user, and inserted in my Dt register cart an event.
Enabling system debug in Joomla, attached you can see the Session debug output
I don'tt understand why it references to Stripesca instead of PagopaBps, and I don't understand if it is an issue

                "config": {
                    "Stripesca": {
                        "codiceServizio": "1234567",
                        "logo": "images\/dtregister\/uploads\/pagopabps.jpg"
                    },
                    "Paypalstandard":

and most important is that if I click on checkout in my cart (see attachment) , it redirects to Paypal instead of asking which payment method I want. If I remove Paypal Standard from possible payment methods in the event, clicking on checkout it alerts me to choose the payment method (ignoring completly the possibility to use PagopaBps).

Please could you check fastly my code and let me know what I'm missing?

Kind regards,
Matt

magostoni71

Hello @manhta,
here is a second issue I noticed.

In the administration, when I enable PagopaBps in a payment Option,
it adds a tab to configure PagopaBps parameters. In my case I have 2 parameters (one text and one logo)

I fill them and then I save.
It alerts me saying that it saved them, but if I turn again on the same page, the 2 parameters seems empty.

Kind regards,
Matt

manhta

magostoni71

There are so many things for this development, it really takes time to discuss all about them, I'm afraid that I can't help in further details. Kindly check stripesca code and try again. You also need to understand omnipay workflow for debugging.

magostoni71

Hello @manhta,
to help us dedbug and testing, could you please tell me 2 things:

1) exactly which payment method implement the stripesca? Where exactly I can find info and documentation about it?

2) where I can get testing credentials, needed to configure and try to use stripesca in DT Register as per attached screencapture?

Kind regards,
Matt

manhta

magostoni71
Hi,

StripeSca is stripe.com, but with new api. You read can document here https://stripe.com/docs/checkout/integration-builder

We're using Prebuilt Checkout page for StripeSca.
- Plugin creates stripe session checkout at: plugins\system\ja_payment\lib\vendor\omnipay\stripesca\src\Gateway.php
- Then use Stripe Javascript at layout plugins\system\ja_payment\tmpl\stripesca.php to redirect to checkout page.

magostoni71

Hello,
I actually solved a lot of points about the new payment gateway, and now it is correctly contacting the bank portal.

I have anyway one specific question on how to manage and correctly show an "error message".

This is part of the code inside the new payment gateway file, based on the stripesca file:

\plugins\system\ja_payment\lib\vendor\omnipay\pagopabps\src\Gateway.php

Here the purchase method:

public function purchase(array $param = array())
{.......
........
        try {

            // --- validazione xml
            $xml = $this->getBps_xml_nobase64();
            $xsd = Uri::base().'media/plg_system_japaymentgateway/schema_xml_modello1.xsd';
            $domDocument= new DOMDocument();
            $domDocument->loadXML($xml); 
            if (!$domDocument->schemaValidate($xsd)) {
                $errors = libxml_get_errors();
                foreach ($errors as $error) {
                    $errortext .= $error.' | ';
                }
								//throw new Exception($errortext);
                libxml_clear_errors();
								
								// how to return back with error message here???? ******
            } else {
                ob_clean();

                require_once \JPluginHelper::getLayoutPath('system', 'ja_payment', 'pagopabps');
            }
            // --- fine validazione xml

            die;
        } catch (\Exception $e) {
            throw new Exception($e->getMessage(), $e->getCode());
        }
        
    }

I need to understand how return back to the page and show an error message in case the XSD validation will fail. The other strange thing is also that $errors in case of fail it is an empty array.

I tried adding throw new Exception($errortext); but it gives me an error;

Anyone can give me a suggestion?

Regards,
Matt

manhta

magostoni71
Hi,

You can check return url of $param

magostoni71

Hello,
I have an issue with the Joomla session; follow me...

as already mentioned in previous posts, we based our new payment gateway, as per your suggestion on stripesca gateway.

In plugins\system\ja_payment\lib\vendor\omnipay\pagopabps\src\Gateway.php we have


    public function purchase(array $param = array())
    {
.......
     require_once \JPluginHelper::getLayoutPath('system', 'ja_payment', 'pagopabps');
    }

Then the code of the plugins\system\ja_payment\tmpl\pagopabps.php that redirects to the Bank portal, very similar to plugins\system\ja_payment\tmpl\stripesca.php.

Then, after payment, the bank portal completed the payment procedure, post some data aboout the payment result to the following url
'success' => JRoute::_('index.php?option=com_dtregister&task=register.complete&Itemid=' . $Itemid, false),

Now checking the code of complete() function inside components\com_dtregister\controllers\register.php, I saw that it uses the Joomla Session previously stored to get some data and complete to record payment data in DTRegister. But unfortunatly, when it runs I saw that the following lines, returns "false", so then it fails registering the event payment data.

    $session = JFactory::getSession();
    $joomartpay = $session->get('joomartpay', false);

As I didn't modified the complete() code I don't understand why it fails get the Session data and how I could solve it.
Please, could you give me any suggestion or let me know where we are going worng?

Kind regards,
Matt

manhta

magostoni71
Hi,
You should try with this dtregister package https://drive.google.com/file/d/18ywqY4o-yS_rZCUYdwRMTinhJgen7u6q/view?usp=sharing

magostoni71

Hi @manhta,
I'm downloading your package.

To understand better what do I have to expect, could you tell me which is the difference with the previous package?

Kind regards,
Matt

magostoni71

Hello @manhta,
I checked my actual Joomla site without installing your last package from the last post.

The installed DT Register version is 4.2.8

Now, before to install your last package, to avoid confusion, I would like to understand what are the changes and if it is a newer version.

Kind regards,
Matt

manhta

magostoni71
Hi,

It includes bug fixes and improvement for DT Register. We'll release the new version soon.

magostoni71

Hello,
the issue I have is probably due to a session issue... for that I opened another post.

Now I would need some suggestion about the following point:
the bank portal gives us 3 possible result:
1) OK (the payment is successfull)
2) KO (the payment fails)
3) DOUBT (it is not able to give us immediatly the result)

For all the 3 results, it redirects the user to the same url, the "register.complete" method. So I modified a little the method to manage the 3 different values of the payment result.
Case 1 or 2 are clear and already done for me.

For case 3 I would need to proceed like at point 1, saving the record, but setting "Status" as PENDING and PAID to false. How can I do it?
In this case 3 is it also possible in some way to avoid sending email to the user?

Regards,
Matt

manhta

magostoni71
- Kindly redirect your payment to $param['cancel_url'] if it failed
- Saving record with PENDING stats : dt register doesn't support this, but you can add it manually by using joomla query. You can add new task on controller register.php to handle your own case.

magostoni71

Hello,
As I wrote, the bank system (we can't change its behaviour) manages the both results (OK and DOUBT), always as at the same "success" case but with different $post value (OK or DOUBT), so I defined a new method in register.php to be able to manage the different cases.

function complete_bps_pagopa()
{
		global $xhtml_url, $Itemid;

		$post = JFactory::getApplication()->input->post->getArray();
		if($post['esito'] == 'OK') {
				// PAGAMENTO EFFETTUATO CORRETTAMENTE
				$mainframe = JFactory::getApplication();

				GatewayFactory::setpostback();

				// imposto il valore del transactionId visto che prima di chiamare il portale BPS no n l'ho fatto
				// perchè lo script termina con un die()
				$session = JFactory::getSession();
				$joomartpay = $session->get('joomartpay', false);
				//$joomartpay['transaction_id'] = $post['id_transazione'];
				$joomartpay['transaction_id'] = $post['numero_avviso'];
				$session->set('joomartpay', $joomartpay);
				// --------------------- FINE aggiornamento sessione

				$this->success();

				$mainframe->redirect("index.php?option=com_dtregister&task=payment.success&Itemid=$Itemid");

				exit;

				die();

		} elseif ($post['esito'] == 'KO') {
				$msg = '<div class="alert alert-danger text-center" role="alert"><h3>' . JText::_('DT_PAYMENT_BPS_ESITO_KO') . '</h3></div>';
				echo $msg . '<a href="' . JRoute::_('index.php', $xhtml_url) . '">' . JText::_('RETURN_TO_SITE') . '</a>';
		} elseif ($post['esito'] == 'DOUBT') {
				// PAGAMENTO DUBBIO
				$mainframe = JFactory::getApplication();

				GatewayFactory::setpostback();

				// imposto il valore del transactionId visto che prima di chiamare il portale BPS no n l'ho fatto
				// perchè lo script termina con un die()
				$session = JFactory::getSession();
				$joomartpay = $session->get('joomartpay', false);
				//$joomartpay['transaction_id'] = $post['id_transazione'];
				$joomartpay['transaction_id'] = $post['numero_avviso'];
				$session->set('joomartpay', $joomartpay);
				// --------------------- FINE aggiornamento sessione

        $this->success(true);

					//*** HERE I MUST INSERT THE CODE TO STORE THE PAYMENT AS PENDING ***//

				$msg = '<div class="alert alert-warning text-center" role="alert"><h3>' . JText::_('DT_PAYMENT_BPS_ESITO_DIFFERITO') . '</h3></div>';
				echo $msg . '<a href="' . JRoute::_('index.php', $xhtml_url) . '">' . JText::_('RETURN_TO_SITE') . '</a>';
		}

}

Do you think it could be a good idea to manage the DOUBT case like the OK and then after $this->success(true) line, load the user model (getModel('user')) and update some fields in different tables?

regards,
Matt

manhta

magostoni71

If result is DOUBT, that means it's not success. So don't use $this->success().

You can redirect some where and throw warning message to user.

magostoni71

manhta

one note about "If result is DOUBT, that means it's not success",
It is not completly true; infact DOUBT means that it could be OK or KO but at the moment the bank system was not able to send back the final real result.
In this case the "Administrator" will check directly with the bank and discover the final real result (OK or KO).
This is the reason why I would need to store the record with status = PENDING so that if the final result will be OK, DT Register already stored the user data and only needs to make the registration status to ACTIVE.

That is the reason, in case of DOUBT, I thought to go for "success" and then update some fields.
I don't know if it is the better way.

To understand better how to manage the notification mail, could you please let me know in the success workflow, which is the step that trigger the sending of the email?

regards,
Matt

manhta

magostoni71
Hi,
You can follow this
- components\com_dtregister\controllers\register.php function success find $tableUser->{$function}(DT_Session::get($process), $paymethod); . Dump $function variable, it has value registerall
- administrator\components\com_dtregister\models\duser.php function registerall find $this->register($row);
- administrator\components\com_dtregister\models\duser.php function regsiter. We send email here.

magostoni71

Hello,
I have a little issue with the xml validation in the payment gateway code.

here the code in plugins\system\ja_payment\lib\vendor\omnipay\pagopabps\src\Gateway.php

public function purchase(array $param = array())
{
		// costruisco l'array con i dati del debitore da scrivere nella sezione dell'xml
		// noi in $param abbiamo anche aggiunto una array $param['billing_collegio'] con il contenuto dei campi di fatturazione del form di registrazione
...
...


		try {
	...
	...

				// --- validazione xml
				$errortext = '';
				$xml = $this->getBps_xml_nobase64();
				$xsd = Uri::base().'media/plg_system_japaymentgateway/schema_xml_modello1.xsd';
				libxml_use_internal_errors(true);
				$domDocument= new DOMDocument();
				$domDocument->loadXML($xml); 
				if (!$domDocument->schemaValidate($xsd)) {
						$errors = libxml_get_errors();
						foreach ($errors as $error) {
								$errortext .= $error->message.' | ';
						}
						//throw new Exception($errortext, $errortext);
						libxml_clear_errors();

						$mainframe = JFactory::getApplication();
						$mainframe->redirect("index.php" . "#payment", $errortext);
				} else {
						ob_clean();

						require_once \JPluginHelper::getLayoutPath('system', 'ja_payment', 'pagopabps');
				}
				// --- fine validazione xml

				die;
		} catch (\Throwable $e) {
				throw new Exception($e->getMessage(), $e->getCode());
		}
}

If the xml validation will fail, I would like to redirect the user to the event list page and show an error.
But actually when it runs it show "Class 'Omnipay\PagopaBps\JFactory' not found" and I didn't find how to declare the use of JFactory class to solve this issue.

Regards,
Matt

manhta

magostoni71

Code should be \JFactory::getApplication()

magostoni71

Hello manhta
inside my Gateway implementation (plugins\system\ja_payment\lib\vendor\omnipay\pagopabps\src\Gateway.php) I need to reference DT_Session class.

How can I reference it at the top of the file?

use .....DT_Session

regards,
Matt