Skip to main content

VTEX

logo

Accept payments in your VTEX store in seconds!

Requirements

All you need to configure the integration is:

  1. In order to use Wompi as a payment method, you must be registered in one of the plans we offer. If you are not yet registered, create an account with Wompi and a commercial advisor will contact you to assist you in the process and provide you with the necessary credentials for the integration of Wompi in your VTEX store.

Installation

  1. To install Wompi in your store, log in to the VTEX platform and go to the Settings -> Payments -> Configuration section.

Install

Next, click on the tab Afiliaciones de Gateway and press the icon + to add Wompi as connector and receive your payments.

Note: with Wompi you must configure three (3) affiliations in your VTEX store: Wompi - Cash, Wompi - PSE and Wompi - Nequi, i.e. you must repeat the process described below for each one. The three (3) affiliations will have the testing and production modes to be configured in your VTEX store.

Install

Look for Wompi in the list and click on it to continue the process.

Note: use the computer's native command to search for it (MacBook, command + F) and for (Windows, Ctrl + Shift + F).

Install

Then you will see the following screen where you will be asked for the credentials required for the integration. Remember that, in order to perform the integration, you must have the Wompi credentials.

Here's how to find them: first, you will need to log in to the Wompi merchant dashboard, then go to the Developers section in the left menu and **take the public and private keys in both productive and test environments. Here is an extra step-by-step support on how to make use of the integration keys.

How to integrate Wompi? Integration keys

Install

Next, you will need to configure the payment conditions for Wompi. Go to the Payment Conditions tab and click on the + icon. Locate the Wompi option, activate the condition and click the Save button to finalize the configuration.

Note: in the payment conditions section, for the case of PSE, look for the payment condition called PSE and then select from the drop-down list the specific Wompi - PSE connector that was created and configured earlier.

Install

Install

Install

Note: changes in payment terms may take up to 10 minutes to be applied at checkout in your VTEX store.

Installation of the Banks for PSE application

The following is a step-by-step guide to install the Banks for PSE application and activate the bank list:

  1. You must download and install VTEX IO CLI. See more details in the following documentation.
  2. Locate the Terminal (Windows or other operating system) on your PC and run with administrator permissions by right-clicking on the Terminal icon and selecting Run as administrator.
  3. With the VTEX IO CLI installed, use the command `vtex login followed by the VTEX account name to log into your VTEX account. This will open a browser window requesting your credentials.

$ vtex login {Account name VTEX}

Banks for PSE

Banks for PSE

  1. Once you are logged in, you can close the browser window and return to the Terminal, you can use the vtexwhoami command to verify which account and workspace are being used by the Terminal.
  2. Type vtex and press Enter to test the installation of VTEX IO CLI.

Banks for PSE

  1. Proceed to install Banks for PSE by typing the command `vtex install vtex.banks-for-pse@0.3.1 through the Terminal using the VTEX IO CLI. Commit the changes, type y or Y to confirm the installation. An installation success message will be displayed.

Banks for PSE

Banks for PSE

  1. Go to your VTEX store, see Applications / Application Management, you will see the Banks for PSE application installed. Then click on the Settings option.

Banks for PSE

  1. In the Connector used to process the PSE section select Wompi and finally press the SAVE button.

Banks for PSE

Banks for PSE

Configure the following URL

To configure the Events URL and receive the status notifications correctly, we detail the following steps:

  1. Log in to Wompi with your credentials. Next, go to the Developers section and view the Transaction Tracking section.

Setting

  1. Add the URL https://wompi-vtex-events.conexa.ai/ipn/event in the Event URL field and press the Save button.

Setting

Note: if you activate the test mode, the URL you must configure is the following: https://wompi-vtex-events-stage.conexa.ai/ipn/event.

You are done! The configuration process has been successfully completed.

Tutorials

Wompi credentials and your VTEX store

In the following image we explain how to get your Wompi credentials and your VTEX store.

Setting

Integration installation

In the following image we explain in detail the installation and configuration process, so you can easily integrate Wompi to your VTEX store.

Setting

Make a purchase and display in your store VTEX and Wompi.

In the following image we describe how to make a purchase from your store and its visualization in your VTEX store and in the Wompi panel.

Setting


Setting

Test Mode

To activate Wompi test mode in VTEX**, please follow the steps below:

  1. Log in to Wompi with your credentials.

Modo de pruebas

  1. Go to the Developers section and press the Enable Test Mode button.

Modo de pruebas

  1. Use the credentials displayed in the Integration API Keys technical section in your integration.

Modo de pruebas

If you no longer wish to use the test mode press the Disable test mode button and use the productive credentials in your integration.

Modo de pruebas

Modo de pruebas

Note: each environment has a pair of related keys, each of these keys has a prod or test prefix, representing the production or sandbox environment respectively, with which you can easily identify which environment it corresponds to.

Customers flow

To make a payment, once the product is selected and added to the cart, your customers will see the option of Wompi as a payment method available.

Test mode

Wompi - Correspondents

Bank Correspondents is an offline payment method, that is to say, it is made in person.

The buyer selects the payment method in the checkout of your VTEX store and presses the Buy Now button.

Customers flow

You must then approve the terms and conditions and press the Continue with payment button.

Customers flow

A unique code will be displayed. The buyer should go to a Correspondent Bank and using the reference code will allow him to finalize the transaction. The status of the transaction should be updated.

Customers flow

Wompi - PSE

PSE is the banking network in Colombia that will allow the buyer to make a money transfer choosing any bank of preference.

The buyer selects the PSE payment method and the bank of his choice at the checkout of your VTEX store.

Customers flow

Next, press the Continue and make payment button and you will be redirected to the PSE page.

Customers flow

Once the operation is completed, you will be returned to the checkout of your VTEX store with the order confirmation.

Customers flow

Wompi - Nequi

Nequi is a bank wallet. The buyer must identify himself with the phone number of his Nequi account and select the payment method at checkout.

Customers flow

Customers flow

Luego debe presionar el botón Comprar ahora.El comprador recibirá una notificación para confirmar la transacción y una vez confirmada finalizará la compra.

Customers flow

Customers flow

Administrator flow

As the administrator of your store, you will be able to view a list of your transactions with the payment method used.

Customers flow

Administrator flow

In the same way, from the order list you can check the details of your orders: you will see if the payment was made through Wompi and the corresponding transaction id.

Administrator flow

Administrator flow

Also, as a merchant from the Wompi dashboard, you will be able to visualize the payment made.

Administrator flow

Preguntas frecuentes

1.
Why is the payment method not displayed in my store?

The credentials used in the configuration process are not correct. We recommend that you make sure that the credentials configured are correct and that all the steps mentioned in this documentation have been performed. If the problem persists, contact support.

2.
How can I view more information about my transactions?

From your VTEX store and/or Wompi panel, you can obtain more details about your transactions.

3.
Is the status of the payment made updated in my store?

Once the buyer pays for the order, you should see the approved payment in your store.

4.
Where can I get more information about gateway membership registration?

Visit Register gateway affiliations from Tutorials and Solutions of the VTEX platform.

5.
Where can I get more information to set up payment terms?

Visit Configure payment terms from Tutorials and Solutions of the VTEX platform.

6.
Can I stop offering the payment method?

Yes, whenever you want you can deactivate the means of payment, simply go to the TRANSACTIONS -> Payments -> Settings section, click on the Payment conditions tab and deactivate the payment condition for Wompi. Then, from the same screen you can reactivate the condition if you want to use it again in your VTEX store.