Debugging on the local environment - developer manual

Due to the fact that communication with InPost Pay is bilateral, i.e. Magento and InPost Pay API send requests to each other, debugging on the local environment is not that straightforward. For that reason, it is necessary to simulate requests sent from InPost Pay servers to the local environment, e.g. via the Postman or Insomnia software, etc.

1. Requests received from InPost Pay have a signature that is authorized bilaterally. It is not possible to send a test request without signature authorization. However, if it is a local or test environment that is adequately secured against external clients, the file specified below can be modified for that purpose by adding a method that always returns a correct request signature verification value in the first line.

After modification, the code (between lines 64 and 65, "return true;" fragment) should look as follows:

Note! It is critical not to save that change in the file versioning system by mistake and for that change not to be implemented on the production environment, as in such case requests will not be subject to verification!

2. Enable full logs in the InPost Pay configuration: Store->Config->Sales->Payment->InPost Pay->Debugging Settings->Log Level: DEBUG

3. You will also need access to the database, more precisely to data in the array:

   inpost_pay_quote

   in column:

   basket_id

   These values will be necessary for communication with Magento through the Postman app as the basket ID. More information on Postman->Magento communication can be found below.

1. In the browser, at the local address of the store, go to the product catalog, then to the product page (depending on the InPost Pay Widget display configuration – if it is enabled on the product card, add the product with InPost Pay, if the Widget is displayed only in the shopping basket add the product to the shopping basket, and then from the shopping basket or minicart subpage start pairing the basket with InPost Pay)

2. Once the form is opened, enter a phone number, it does not have to be a real phone number:

   Open

   

3. Then check inpost_pay_quote.basket_id in the database, in the array mentioned above It will be the InPost Pay basket ID required for the next steps in the Postman app. Example of basket_id: 5b09XLhdhVnrYG5HwPitSKcIhPLWkAHy

4. In the production scenario, the InPost Pay app on the mobile phone would display a push notification with a request to confirm basket pairing, which upon confirmation would result in the following request being sent to Magento:

   POST:
   https://lokalna.domena/rest/v1/izi/basket/5b09XLhdhVnrYG5HwPitSKcIhPLWkAHy/confirmation

   { "phone_number": { "country_prefix": "+48", "phone": "123123123" }, "masked_phone_number": "12*****23", "name": "Jan", "surname": "Kowalski", "browser": { "browser_trusted": true, "browser_id": "cd50a5b7-dcbf-4f2e-b6fd-5d10260e6235" }, "inpost_basket_id": "9cf1ff98-0f54-4931-9a86-27477f3e43b2", "status": "SUCCESS" }

Where the URL address contains the basket ID from the Magento database between "basket" and "confirmation". Therefore, in order to call basket confirmation in Postman, it is necessary to send the following request:

Open

The response will return all information about that Magento basket and the configuration of deliveries, consents, etc. received by InPost Pay. Example of a response from Magento:

5. In the case of the production environment, clicking "Submit order" in the InPost Pay mobile app sends a request to Magento. In order to confirm orders on the local environment, it is necessary to simulate a corresponding request:

   POST:
   https://lokalna.domena/rest/v1/izi/order

   { "order_details": { "basket_id": "5b09XLhdhVnrYG5HwPitSKcIhPLWkAHy", "currency": "PLN", "basket_price": { "net": 34.15, "gross": 42.00, "vat": 7.85 }, "payment_type": "CARD" }, "account_info": { "name": "Jan", "surname": "Kowalski", "phone_number": { "country_prefix": "+48", "phone": "123123123" }, "mail": "jan.kowalski.inpostpaytest@example.com", "client_address": { "country_code": "PL", "city": "Warszawa", "address": "Testowa 123", "postal_code": "12-345", "address_details": { "building": null } } }, "delivery": { "delivery_type": "APM", "mail": "jan.kowalski.inpostpaytest@example.com", "phone_number": { "country_prefix": "+48", "phone": "123123123" }, "delivery_point": "KRA28M" }, "consents": [ { "consent_id": "1", "consent_version": "1", "is_accepted": true } ] }

In the above-mentioned example, it is necessary to modify:
basket_id ← inpost_pay_quote.basket_id value from the database mentioned above basket_price section ← it is necessary to provide the exact values returned by the previous query as the sum of: summary.basket_final_price and the price of the selected delivery method, i.e.: delivery.delivery_price for delivery_type: APM (i.e. parcel locker).

In the above-mentioned example, this would be the result:

added to:

resulting in the following:

Note! These amounts are calculated by the InPost Pay app on the production environment, but for the purposes of the simulation you should calculate them on your own. If these amounts are miscalculated, the data provided is not correct or due to errors attributable to Magento the order is not placed, the cause of the foregoing should in the first place be sought in logs:

If the order was placed correctly, Magento should respond as follows: