Worldpay online payments integration by SNS Software LTD

Start accepting online payments effortlessly with Worldpay

As a Worldpay partner, we offer:

Premium rates for new customers

Attractive commission opportunities for Odoo partners

Contact us for more information on our email: support@neatapps.io

Installation

1. Upon clicking the 'Download' button on the app, you will receive the link to download the zip file of the module.
2. Extract the file on your system after the download finishes. You will be able to see a folder named- 'payment_neatworldpayvt'.
3. Copy and paste this folder inside your Odoo Add-Ons path.
4. Now, open the Odoo App and click on the Settings menu.Scroll to the very bottom of settings. Here, click on Activate the "Developer Mode".
5. Then, open the Apps menu and click on the top bar 'Update Apps List'.
6. In the search bar, remove all the filters and search 'Worldpay'.
7. You will be able to see the module 'Payment Provider: Worldpay' in the search result. Click on 'Install' to install it.

Migration Guide to v3.0

1. In case you are using an older version you may run into some issues when trying to install the new version. if this is the case on Odoo.sh you will have to open the Shell
2. Then type "psql" and press Enter.
3. Execute this script:

   ALTER TABLE payment_provider ADD COLUMN IF NOT EXISTS neatworldpayvt_checkout_id VARCHAR;

   ALTER TABLE payment_provider ADD COLUMN IF NOT EXISTS neatworldpayvt_entity VARCHAR;

   ALTER TABLE payment_provider ADD COLUMN IF NOT EXISTS neatworldpayvt_fallback_user_id VARCHAR;

4. Close the page and then install the app.
5. Once the app is installed you have to set the new required fields for the payment provider which are the CheckoutID, Entity and Responsible User. To do that please refer to the Setup instructions below.

Setup

1. In Odoo goto Settings -> Sale -> Payment Providers and select Worldpay Virtual Terminal
2. There are 3 states available (Disabled, Enabled, Test Mode) select Enabled if you are looking to go live and Test Mode if you first want to do a test run payment and change it later to Enabled for live.
3. You will need an Activation Code for this module and to get it you can click the "Get Free Activation Code" link and fill out the form or contact us at: support@sns-software.com and we will provide the code shortly.
4. Next we will need to enter the Username and Password so you will need a Worldpay account. If you dont have one get in touch with us and we can help you with setting one up. If you are an Odoo partner we can offer partnership terms and free B2B support.
5. Once registered go to https://dashboard.worldpay.com login and go to the Developer Tools section.
6. Click on API Credentials to generate a Username and Password. in Try Mode you can do test payments if you have selected Test Mode in Odoo otherwise select Live Mode and click Generate Credentials.
7. Copy the Username and Password back in to Odoo payment method (worldpay virtual terminal).
8. Next you need to also retrieve the Checkout ID which is retrieved on the same page as the Username and Password in the Worldpay Dashboard but at the section above called "Access Checkout".
9. There again you have to pick between the try mode if you are testing and live if you are looking to take live payments.
10. After that we just have to also retrieve the Entity from the Worldpay Dashboard which is the section "Entity" above "Access Checkout"
11. Paste both the Entity and Checkout ID in Odoo.
12. Then you have to pick a Responsible User. The responsible user is someone that will get a failure activity attached to in case of a payment failure if a Sale Order or an Invoice has no associated employee that is responsible for it.
13. Save your changes
14. You are now ready to take your first payments! If you have selected Testing mode with Try Mode credentials you can use the test cards form here: https://developer.worldpay.com/products/access/hosted-payment-pages/testing
15. You can now use the payment method in through all available channels. We suggest to keep this payment method unpublished in order not to confused clients (unpublished payment methods are still visible to internal users)
16. Usage example: Create a quote and put it in "Quotation Sent" state. On the top left of your screen next to the "Confirm" button on the quote there is a "Preview" button. Clicking it will navigate you to the portal view of the quotation. On this view you can click the "Accept & Pay" or "Sign & Pay" button depending on your configuration. This will lead you to the payment methods menu. Here you need to select "Worldpay Virtul Terminal" and copy the reference code on your display.
17. Go to your Worldpay Online Payment Dashboard and click on "Virtual Terminal" on the side menu. You can toggle between test and live mode on the top. Paste your Reference number under "Transaction Reference". Type in the amount you want to charge and all customer details, then click "charge customer" at the bottom. Once the payment is processed your Odoo quotation will be automatically confirmed and paid following the standard flow for online payments.

Support

Email: support@sns-software.com