[Status management] Wrong wording in the API status list ?

[bhennesAdv]

Hello,

I'm opening this issue because we faced an issue on our installation using the module for oney payment.
The order is changed to processing while it's supposed to be in payment_review status while the file is pending on Oney side.

After one response of your support team, I dug deeper in the module code to understand if the mistake is in our configuration or in the module.
Here is the documentation linked to us : https://payzen.io/fr-FR/payment-method/3x_4x_Oney/redirection-form/traiter-les-donnees-de-la-reponse.html
Here is the response from the support member :

Nous pensons que votre problématique est liée à une mauvaise interprétation du mail envoyé au client.
Lors de notre appel à l'IPN nous avons indiqué dans un premier temps que la transaction était avec le statut Waiting_authorization. Puis une fois qu'Oney nous a envoyé le résultat final nous avons appelé une 2eme fois l'IPN pour informer votre système.

Following the documentation and response, I was expecting to find some string containing "Waiting_authorization" in the module but none is present.
I search in the documentation and status to find this :
https://payzen.io/fr-FR/payment-method/cb/redirection-form/traiter-les-donnees-de-la-reponse.html

So for some reason :
In the Oney API response :

WAITING_AUTHORIZATION

In the CB API response :

WAITING_AUTHORISATION

I'm not sure which one is a typo or if this is the expected behaviour but having this, the module helper API function are not working :

// In https://github.com/lyra/plugin-magento/blob/master/Model/Api/Form/Api.php
[...]
public static function getPendingStatuses()
    {
        return array(
            'INITIAL',
            'WAITING_AUTHORISATION',
            'WAITING_AUTHORISATION_TO_VALIDATE',
            // Maybe we should add this ?
            'WAITING_AUTHORIZATION',
            // Maybe we should add some more ?
            'UNDER_VERIFICATION',
            'PRE_AUTHORISED',
            'WAITING_FOR_PAYMENT',
            'AUTHORISED_TO_VALIDATE',
            'SUSPENDED',
            'PENDING',
            'REFUND_TO_RETRY'
        );
    }
[...]

I don't know the full set of status which are returns by your API but it seems that according to this helper code, following the "else" we end up having a status to processing according to the "registered_order_status" configuration field (Which is annotated as : Status of orders when payment is successfull.")

// In https://github.com/lyra/plugin-magento/blob/master/Helper/Payment.php
[...]
public function nextOrderState(
        \Magento\Sales\Model\Order $order,
        \Lyranetwork\Payzen\Model\Api\Form\Response $response,
        $ignoreFraud = false
    ) {
        // =========> Status is not to validate as it's not in the list
        if ($response->isToValidatePayment()) {
            $newStatus = 'payzen_to_validate';
            $newState = \Magento\Sales\Model\Order::STATE_PAYMENT_REVIEW;
        // =========> Status is not to pending as it's not in the list
        } elseif ($response->isPendingPayment()) {
            $newStatus = 'payment_review';
            $newState = \Magento\Sales\Model\Order::STATE_PAYMENT_REVIEW;
        } else {
            // =========> This is not a SEPA response
            if ($this->isSepa($response)) {
                // Pending funds transfer order state.
                $newStatus = 'payzen_pending_transfer';
            } else {
                // =========> Here we are with a success status but an API response code as "WAITING_AUTHORIZATION"
                $newStatus = $this->dataHelper->getCommonConfigData(
                    'registered_order_status',
                    $order->getStore()->getId()
                );
            }

            $processingStatuses = $this->orderConfig->getStateStatuses(
                \Magento\Sales\Model\Order::STATE_PROCESSING,
                false
            );
            $newState = in_array($newStatus, $processingStatuses) ? \Magento\Sales\Model\Order::STATE_PROCESSING :
                \Magento\Sales\Model\Order::STATE_NEW;
        }

        $stateObject = $this->dataObjectFactory->create();

        if (! $ignoreFraud && $response->isSuspectedFraud()) {
            $stateObject->setBeforeState($newState);
            $stateObject->setBeforeStatus($newStatus);

            $newState = \Magento\Sales\Model\Order::STATE_PAYMENT_REVIEW;
            $newStatus = 'fraud';
        }

        $stateObject->setState($newState);
        $stateObject->setStatus($newStatus);
        return $stateObject;
    }
[...]

I'll open a PR for the suitable change, feel free to merge it if my understanding of the module is correct.
Kind Regards,
Baptiste

[hchabane21]

Hello @bhennesAdv,

Thank for reaching out to us.

We'll investigate this issue and be back to you with an answer.

Best regards,

[hchabane21]

Hello @bhennesAdv,

We tested on our side and we receive the status "WAITING_AUTHORISATION" in the payment response, not "WAITING_AUTHORIZATION" as you are saying.

Can you please contact the support team using the contact support form on the plugin configuration page in Magento Admin or on the website. Once you created a support ticket, we'll able to check your logs and the transaction information to analyse the problem.

Best regards,

[bhennesAdv]

Hello @hchabane21,

Did you correctly test on an Oney payment ?

The "WAITING_AUTHORIZATION" is the value described in your documentation : https://payzen.io/fr-FR/payment-method/3x_4x_Oney/redirection-form/traiter-les-donnees-de-la-reponse.html

I opened a ticket on github about this because I already got the response from your support team. (I would never have find the error source otherwise).
Case on your side is ID#346300

Best Regards,
Baptiste

[hchabane21]

Hello @bhennesAdv,

I actually tested and confirmed with our internal teams. The status on our documentation is wrong.

We will reach out to you via the support ticket in order to have more details about your problem.

Best regards,

[bhennesAdv]

Hello @hchabane21,

In my case, the documentation was perfectly relevant as adding the status with a Z (Like I did in the PR) was correctly changing the order status to Payment_Review instead of processing.

So the status given by the return call was probably with a Z.

I can't give you the log right now because the Payzen platform for Oney is broken at the moment... I'll try to give you the log of the response content received from the return call as soon as I can.

Kind Regards,

[bhennesAdv]

Hello @hchabane21,

You are indeed right, by logging the response, the given transStatus is as you said WAITING_AUTHORISATION and not with a Z like in the documentation.
So it's only a documentation Issue and my tests around the change were probably wrong at some point.

I'll keep digging to understand why I got the wrong status and wrong treatment after that.

Sorry for the inconvenience,
I'm closing the issue and the PR which is pointless then.

Kind Regards,
Baptiste